diff --git a/.github/renovate.json b/.github/renovate.json index 61ef521f317..f64a07ceaf7 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -120,6 +120,23 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchManagers": [ + "composer" + ], + "rangeStrategy": "in-range-only", + "matchFileNames": [ + "composer.json" + ], + "branchPrefix": "renovate/root/php/", + "commitMessagePrefix": "[\ud83e\udeb5]", + "labels": [ + "\ud83e\udeb5" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchManagers": [ "composer" @@ -273,6 +290,23 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchManagers": [ + "composer" + ], + "rangeStrategy": "in-range-only", + "matchFileNames": [ + "skelleton/composer.json" + ], + "branchPrefix": "renovate/skelleton/php/", + "commitMessagePrefix": "[\u2620\ufe0f]", + "labels": [ + "\u2620\ufe0f" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchManagers": [ "composer" @@ -426,6 +460,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.0/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.0/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.0]", + "labels": [ + "GitHubEnterprise-3.0" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.0/composer.json" @@ -557,6 +604,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.1/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.1/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.1]", + "labels": [ + "GitHubEnterprise-3.1" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.1/composer.json" @@ -664,12 +724,444 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.10/composer.json" + "clients/GitHubEnterprise-3.10/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "labels": [ + "GitHubEnterprise-3.10" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/psr" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.10/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "labels": [ + "GitHubEnterprise-3.10" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/react" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.10/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "labels": [ + "GitHubEnterprise-3.10" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.10/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "labels": [ + "GitHubEnterprise-3.10" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/widen" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.10/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "labels": [ + "GitHubEnterprise-3.10" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/wyrihaximus-react" + ] + }, + { + "matchManagers": [ + "github-actions" + ], + "matchFileNames": [ + ".github/workflows/**GitHubEnterprise-3.10.yaml" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.10/github-actions/", + "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "labels": [ + "GitHubEnterprise-3.10" + ], + "enabled": false + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/do-not-update-php" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/in-range" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/infection" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/php" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/phpunit" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/psr" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/react" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/widen" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.11/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/wyrihaximus-react" + ] + }, + { + "matchManagers": [ + "github-actions" + ], + "matchFileNames": [ + ".github/workflows/**GitHubEnterprise-3.11.yaml" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.11/github-actions/", + "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "labels": [ + "GitHubEnterprise-3.11" + ], + "enabled": false + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/do-not-update-php" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/in-range" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/infection" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/php" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/phpunit" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/psr" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/react" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/widen" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.12/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/wyrihaximus-react" + ] + }, + { + "matchManagers": [ + "github-actions" + ], + "matchFileNames": [ + ".github/workflows/**GitHubEnterprise-3.12.yaml" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.12/github-actions/", + "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "labels": [ + "GitHubEnterprise-3.12" + ], + "enabled": false + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", + "labels": [ + "GitHubEnterprise-3.13" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/do-not-update-php" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", + "labels": [ + "GitHubEnterprise-3.13" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/in-range" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", + "labels": [ + "GitHubEnterprise-3.13" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/infection" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", + "labels": [ + "GitHubEnterprise-3.13" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/php" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", + "labels": [ + "GitHubEnterprise-3.13" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/phpunit" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", "labels": [ - "GitHubEnterprise-3.10" + "GitHubEnterprise-3.13" ], "extends": [ "github>wyrihaximus/renovate-config//composer/psr" @@ -677,12 +1169,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.10/composer.json" + "clients/GitHubEnterprise-3.13/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", "labels": [ - "GitHubEnterprise-3.10" + "GitHubEnterprise-3.13" ], "extends": [ "github>wyrihaximus/renovate-config//composer/react" @@ -690,12 +1182,25 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.10/composer.json" + "clients/GitHubEnterprise-3.13/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", "labels": [ - "GitHubEnterprise-3.10" + "GitHubEnterprise-3.13" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.13/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", + "labels": [ + "GitHubEnterprise-3.13" ], "extends": [ "github>wyrihaximus/renovate-config//composer/widen" @@ -703,12 +1208,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.10/composer.json" + "clients/GitHubEnterprise-3.13/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.10/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "branchPrefix": "renovate/GitHubEnterprise-3.13/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", "labels": [ - "GitHubEnterprise-3.10" + "GitHubEnterprise-3.13" ], "extends": [ "github>wyrihaximus/renovate-config//composer/wyrihaximus-react" @@ -719,23 +1224,23 @@ "github-actions" ], "matchFileNames": [ - ".github/workflows/**GitHubEnterprise-3.10.yaml" + ".github/workflows/**GitHubEnterprise-3.13.yaml" ], - "branchPrefix": "renovate/GitHubEnterprise-3.10/github-actions/", - "commitMessagePrefix": "[GitHubEnterprise-3.10]", + "branchPrefix": "renovate/GitHubEnterprise-3.13/github-actions/", + "commitMessagePrefix": "[GitHubEnterprise-3.13]", "labels": [ - "GitHubEnterprise-3.10" + "GitHubEnterprise-3.13" ], "enabled": false }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/do-not-update-php" @@ -743,12 +1248,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/in-range" @@ -756,12 +1261,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/infection" @@ -769,12 +1274,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/php" @@ -782,12 +1287,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/phpunit" @@ -795,12 +1300,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/psr" @@ -808,12 +1313,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/react" @@ -821,12 +1326,25 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.14/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", + "labels": [ + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/widen" @@ -834,12 +1352,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.11/composer.json" + "clients/GitHubEnterprise-3.14/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "extends": [ "github>wyrihaximus/renovate-config//composer/wyrihaximus-react" @@ -850,23 +1368,23 @@ "github-actions" ], "matchFileNames": [ - ".github/workflows/**GitHubEnterprise-3.11.yaml" + ".github/workflows/**GitHubEnterprise-3.14.yaml" ], - "branchPrefix": "renovate/GitHubEnterprise-3.11/github-actions/", - "commitMessagePrefix": "[GitHubEnterprise-3.11]", + "branchPrefix": "renovate/GitHubEnterprise-3.14/github-actions/", + "commitMessagePrefix": "[GitHubEnterprise-3.14]", "labels": [ - "GitHubEnterprise-3.11" + "GitHubEnterprise-3.14" ], "enabled": false }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/do-not-update-php" @@ -874,12 +1392,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/in-range" @@ -887,12 +1405,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/infection" @@ -900,12 +1418,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/php" @@ -913,12 +1431,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/phpunit" @@ -926,12 +1444,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/psr" @@ -939,12 +1457,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/react" @@ -952,12 +1470,25 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.15/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", + "labels": [ + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/widen" @@ -965,12 +1496,12 @@ }, { "matchFileNames": [ - "clients/GitHubEnterprise-3.12/composer.json" + "clients/GitHubEnterprise-3.15/composer.json" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/php/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "extends": [ "github>wyrihaximus/renovate-config//composer/wyrihaximus-react" @@ -981,12 +1512,12 @@ "github-actions" ], "matchFileNames": [ - ".github/workflows/**GitHubEnterprise-3.12.yaml" + ".github/workflows/**GitHubEnterprise-3.15.yaml" ], - "branchPrefix": "renovate/GitHubEnterprise-3.12/github-actions/", - "commitMessagePrefix": "[GitHubEnterprise-3.12]", + "branchPrefix": "renovate/GitHubEnterprise-3.15/github-actions/", + "commitMessagePrefix": "[GitHubEnterprise-3.15]", "labels": [ - "GitHubEnterprise-3.12" + "GitHubEnterprise-3.15" ], "enabled": false }, @@ -1081,6 +1612,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.2/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.2/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.2]", + "labels": [ + "GitHubEnterprise-3.2" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.2/composer.json" @@ -1212,6 +1756,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.3/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.3/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.3]", + "labels": [ + "GitHubEnterprise-3.3" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.3/composer.json" @@ -1343,6 +1900,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.4/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.4/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.4]", + "labels": [ + "GitHubEnterprise-3.4" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.4/composer.json" @@ -1474,6 +2044,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.5/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.5/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.5]", + "labels": [ + "GitHubEnterprise-3.5" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.5/composer.json" @@ -1605,6 +2188,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.6/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.6/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.6]", + "labels": [ + "GitHubEnterprise-3.6" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.6/composer.json" @@ -1736,6 +2332,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.7/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.7/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.7]", + "labels": [ + "GitHubEnterprise-3.7" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.7/composer.json" @@ -1867,6 +2476,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.8/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.8/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.8]", + "labels": [ + "GitHubEnterprise-3.8" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.8/composer.json" @@ -1998,6 +2620,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterprise-3.9/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterprise-3.9/php/", + "commitMessagePrefix": "[GitHubEnterprise-3.9]", + "labels": [ + "GitHubEnterprise-3.9" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterprise-3.9/composer.json" @@ -2129,6 +2764,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHub/composer.json" + ], + "branchPrefix": "renovate/GitHub/php/", + "commitMessagePrefix": "[GitHub]", + "labels": [ + "GitHub" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHub/composer.json" @@ -2260,6 +2908,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubEnterpriseCloud/composer.json" + ], + "branchPrefix": "renovate/GitHubEnterpriseCloud/php/", + "commitMessagePrefix": "[GitHubEnterpriseCloud]", + "labels": [ + "GitHubEnterpriseCloud" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubEnterpriseCloud/composer.json" @@ -2391,6 +3052,19 @@ "github>wyrihaximus/renovate-config//composer/react" ] }, + { + "matchFileNames": [ + "clients/GitHubAE/composer.json" + ], + "branchPrefix": "renovate/GitHubAE/php/", + "commitMessagePrefix": "[GitHubAE]", + "labels": [ + "GitHubAE" + ], + "extends": [ + "github>wyrihaximus/renovate-config//composer/voku" + ] + }, { "matchFileNames": [ "clients/GitHubAE/composer.json" diff --git a/.github/workflows/ci-GitHubEnterprise-3.13.yaml b/.github/workflows/ci-GitHubEnterprise-3.13.yaml new file mode 100644 index 00000000000..f7e3042a98a --- /dev/null +++ b/.github/workflows/ci-GitHubEnterprise-3.13.yaml @@ -0,0 +1,21 @@ +name: "CI: GitHubEnterprise-3.13" +on: + pull_request: + paths: + - ".github/workflows/ci-GitHubEnterprise-3.13.yaml" + - ".github/workflows/generate-GitHubEnterprise-3.13.yaml" + - ".github/workflows/release-management-GitHubEnterprise-3.13.yaml" + - "clients/GitHubEnterprise-3.13/**" +## This workflow needs the `pull-request` permissions to work for the package diffing +## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions +permissions: + pull-requests: write + contents: read +jobs: + ci: + name: Continuous Integration + uses: WyriHaximus/github-workflows/.github/workflows/package.yaml@main + with: + disableMarkdownLinkCheck: true + disableSetMilestone: true + workingDirectory: "clients/GitHubEnterprise-3.13" diff --git a/.github/workflows/ci-GitHubEnterprise-3.14.yaml b/.github/workflows/ci-GitHubEnterprise-3.14.yaml new file mode 100644 index 00000000000..b193c695116 --- /dev/null +++ b/.github/workflows/ci-GitHubEnterprise-3.14.yaml @@ -0,0 +1,21 @@ +name: "CI: GitHubEnterprise-3.14" +on: + pull_request: + paths: + - ".github/workflows/ci-GitHubEnterprise-3.14.yaml" + - ".github/workflows/generate-GitHubEnterprise-3.14.yaml" + - ".github/workflows/release-management-GitHubEnterprise-3.14.yaml" + - "clients/GitHubEnterprise-3.14/**" +## This workflow needs the `pull-request` permissions to work for the package diffing +## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions +permissions: + pull-requests: write + contents: read +jobs: + ci: + name: Continuous Integration + uses: WyriHaximus/github-workflows/.github/workflows/package.yaml@main + with: + disableMarkdownLinkCheck: true + disableSetMilestone: true + workingDirectory: "clients/GitHubEnterprise-3.14" diff --git a/.github/workflows/ci-GitHubEnterprise-3.15.yaml b/.github/workflows/ci-GitHubEnterprise-3.15.yaml new file mode 100644 index 00000000000..6f912cd1837 --- /dev/null +++ b/.github/workflows/ci-GitHubEnterprise-3.15.yaml @@ -0,0 +1,21 @@ +name: "CI: GitHubEnterprise-3.15" +on: + pull_request: + paths: + - ".github/workflows/ci-GitHubEnterprise-3.15.yaml" + - ".github/workflows/generate-GitHubEnterprise-3.15.yaml" + - ".github/workflows/release-management-GitHubEnterprise-3.15.yaml" + - "clients/GitHubEnterprise-3.15/**" +## This workflow needs the `pull-request` permissions to work for the package diffing +## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions +permissions: + pull-requests: write + contents: read +jobs: + ci: + name: Continuous Integration + uses: WyriHaximus/github-workflows/.github/workflows/package.yaml@main + with: + disableMarkdownLinkCheck: true + disableSetMilestone: true + workingDirectory: "clients/GitHubEnterprise-3.15" diff --git a/.github/workflows/generate-GitHub.yaml b/.github/workflows/generate-GitHub.yaml index 2dd82808527..308fba1f112 100644 --- a/.github/workflows/generate-GitHub.yaml +++ b/.github/workflows/generate-GitHub.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHub" on: workflow_dispatch: schedule: - - cron: '13 16 * * *' + - cron: '13 19 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHub @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHub/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHub/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHub/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHub - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHub/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubAE.yaml b/.github/workflows/generate-GitHubAE.yaml index ee89ff48cab..7c3722eee28 100644 --- a/.github/workflows/generate-GitHubAE.yaml +++ b/.github/workflows/generate-GitHubAE.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubAE" on: workflow_dispatch: schedule: - - cron: '13 18 * * *' + - cron: '13 21 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubAE @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubAE/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubAE/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubAE/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubAE - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubAE/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.1.yaml b/.github/workflows/generate-GitHubEnterprise-3.1.yaml index f43c5c13a20..f747fac60e4 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.1.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.1.yaml @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.1/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.1/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.1/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.1 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.1/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.10.yaml b/.github/workflows/generate-GitHubEnterprise-3.10.yaml index f94430bc14f..0239c2e3668 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.10.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.10.yaml @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.10/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.10/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.10/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.10 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.10/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.11.yaml b/.github/workflows/generate-GitHubEnterprise-3.11.yaml index a16b9fd6418..6f969c958c6 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.11.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.11.yaml @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.11/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.11/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.11/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.11 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.11/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.12.yaml b/.github/workflows/generate-GitHubEnterprise-3.12.yaml index 0e0a7b52851..957ae3745d2 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.12.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.12.yaml @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.12/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.12/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.12/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.12 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.12/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.13.yaml b/.github/workflows/generate-GitHubEnterprise-3.13.yaml new file mode 100644 index 00000000000..5bf28fc6f06 --- /dev/null +++ b/.github/workflows/generate-GitHubEnterprise-3.13.yaml @@ -0,0 +1,81 @@ +name: "Generate: GitHubEnterprise-3.13" +on: + workflow_dispatch: + schedule: + - cron: '13 8 * * *' +jobs: + supported-versions-matrix: + name: Supported Versions Matrix GitHubEnterprise-3.13 + runs-on: ubuntu-latest + outputs: + version: ${{ steps.supported-versions-matrix.outputs.lowest }} + steps: + - uses: actions/checkout@v4 + - id: supported-versions-matrix + uses: WyriHaximus/github-action-composer-php-versions-in-range@v1 + with: + workingDirectory: clients/GitHubEnterprise-3.13 + generate-githubenterprise-3_13: + name: Generate GitHubEnterprise-3.13 + runs-on: ubuntu-latest + needs: + - supported-versions-matrix + container: + image: wyrihaximusnet/php:${{ needs.supported-versions-matrix.outputs.version }}-nts-alpine-slim-dev-root + steps: + - uses: actions/checkout@v4 + - uses: ramsey/composer-install@v2 + - uses: ramsey/composer-install@v2 + with: + working-directory: "clients/GitHubEnterprise-3.13" + - name: Download current spec file + run: | + rm etc/specs/GitHubEnterprise-3.13/previous.spec.yaml || true + mv etc/specs/GitHubEnterprise-3.13/current.spec.yaml etc/specs/GitHubEnterprise-3.13/previous.spec.yaml + curl -o etc/specs/GitHubEnterprise-3.13/current.spec.yaml https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/ghes-3.13/ghes-3.13.yaml + php utils/patch-broken-spec-files.php etc/specs/GitHubEnterprise-3.13/current.spec.yaml + - name: Hash specs + id: spec-hash + run: | + php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "current=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.13/current.spec.yaml")) . "\n", FILE_APPEND);' + php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.13/previous.spec.yaml")) . "\n", FILE_APPEND);' + - name: Look current up spec version + id: look-current-up-spec-version + uses: mikefarah/yq@v4.44.3 + with: + cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.13/current.spec.yaml' + - name: Look previous up spec version + id: look-previous-up-spec-version + uses: mikefarah/yq@v4.44.3 + with: + cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.13/previous.spec.yaml' + - name: Generate spec diff + id: spec-diff + run: | + curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh + echo "Detected Schema changes:" >> "var/detected-schema-changes" + echo "$(openapi-changes summary --markdown --no-color --no-logo etc/specs/GitHubEnterprise-3.13/current.spec.yaml etc/specs/GitHubEnterprise-3.13/previous.spec.yaml)" >> "var/detected-schema-changes" + cat var/detected-schema-changes + delimiter="$(openssl rand -hex 8)" + echo "diff<<${delimiter}" >> "${GITHUB_OUTPUT}" + echo "$(cat var/detected-schema-changes)" >> "${GITHUB_OUTPUT}" + echo "${delimiter}" >> "${GITHUB_OUTPUT}" + - name: Update Client to ${{ steps.look-current-up-spec-version.outputs.result }} + run: | + make generate-client GitHubEnterprise-3.13 + - name: Create Pull Request + uses: peter-evans/create-pull-request@v7 + with: + branch: "GitHubEnterprise-3.13/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" + token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} + labels: | + Automated PR + New Version + automerge + Enhancement ✨ + GitHubEnterprise-3.13 + title: "[GitHubEnterprise-3.13] Update to ${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }} from ${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.previous }}" + body-path: "var/detected-schema-changes" + commit-message: | + [GitHubEnterprise-3.13] Update to ${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }} from ${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.previous }} + ${{ steps.spec-diff.outputs.diff }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.14.yaml b/.github/workflows/generate-GitHubEnterprise-3.14.yaml new file mode 100644 index 00000000000..ff4c96a349f --- /dev/null +++ b/.github/workflows/generate-GitHubEnterprise-3.14.yaml @@ -0,0 +1,81 @@ +name: "Generate: GitHubEnterprise-3.14" +on: + workflow_dispatch: + schedule: + - cron: '13 9 * * *' +jobs: + supported-versions-matrix: + name: Supported Versions Matrix GitHubEnterprise-3.14 + runs-on: ubuntu-latest + outputs: + version: ${{ steps.supported-versions-matrix.outputs.lowest }} + steps: + - uses: actions/checkout@v4 + - id: supported-versions-matrix + uses: WyriHaximus/github-action-composer-php-versions-in-range@v1 + with: + workingDirectory: clients/GitHubEnterprise-3.14 + generate-githubenterprise-3_14: + name: Generate GitHubEnterprise-3.14 + runs-on: ubuntu-latest + needs: + - supported-versions-matrix + container: + image: wyrihaximusnet/php:${{ needs.supported-versions-matrix.outputs.version }}-nts-alpine-slim-dev-root + steps: + - uses: actions/checkout@v4 + - uses: ramsey/composer-install@v2 + - uses: ramsey/composer-install@v2 + with: + working-directory: "clients/GitHubEnterprise-3.14" + - name: Download current spec file + run: | + rm etc/specs/GitHubEnterprise-3.14/previous.spec.yaml || true + mv etc/specs/GitHubEnterprise-3.14/current.spec.yaml etc/specs/GitHubEnterprise-3.14/previous.spec.yaml + curl -o etc/specs/GitHubEnterprise-3.14/current.spec.yaml https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/ghes-3.14/ghes-3.14.yaml + php utils/patch-broken-spec-files.php etc/specs/GitHubEnterprise-3.14/current.spec.yaml + - name: Hash specs + id: spec-hash + run: | + php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "current=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.14/current.spec.yaml")) . "\n", FILE_APPEND);' + php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.14/previous.spec.yaml")) . "\n", FILE_APPEND);' + - name: Look current up spec version + id: look-current-up-spec-version + uses: mikefarah/yq@v4.44.3 + with: + cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.14/current.spec.yaml' + - name: Look previous up spec version + id: look-previous-up-spec-version + uses: mikefarah/yq@v4.44.3 + with: + cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.14/previous.spec.yaml' + - name: Generate spec diff + id: spec-diff + run: | + curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh + echo "Detected Schema changes:" >> "var/detected-schema-changes" + echo "$(openapi-changes summary --markdown --no-color --no-logo etc/specs/GitHubEnterprise-3.14/current.spec.yaml etc/specs/GitHubEnterprise-3.14/previous.spec.yaml)" >> "var/detected-schema-changes" + cat var/detected-schema-changes + delimiter="$(openssl rand -hex 8)" + echo "diff<<${delimiter}" >> "${GITHUB_OUTPUT}" + echo "$(cat var/detected-schema-changes)" >> "${GITHUB_OUTPUT}" + echo "${delimiter}" >> "${GITHUB_OUTPUT}" + - name: Update Client to ${{ steps.look-current-up-spec-version.outputs.result }} + run: | + make generate-client GitHubEnterprise-3.14 + - name: Create Pull Request + uses: peter-evans/create-pull-request@v7 + with: + branch: "GitHubEnterprise-3.14/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" + token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} + labels: | + Automated PR + New Version + automerge + Enhancement ✨ + GitHubEnterprise-3.14 + title: "[GitHubEnterprise-3.14] Update to ${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }} from ${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.previous }}" + body-path: "var/detected-schema-changes" + commit-message: | + [GitHubEnterprise-3.14] Update to ${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }} from ${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.previous }} + ${{ steps.spec-diff.outputs.diff }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.15.yaml b/.github/workflows/generate-GitHubEnterprise-3.15.yaml new file mode 100644 index 00000000000..61a963e52c6 --- /dev/null +++ b/.github/workflows/generate-GitHubEnterprise-3.15.yaml @@ -0,0 +1,81 @@ +name: "Generate: GitHubEnterprise-3.15" +on: + workflow_dispatch: + schedule: + - cron: '13 10 * * *' +jobs: + supported-versions-matrix: + name: Supported Versions Matrix GitHubEnterprise-3.15 + runs-on: ubuntu-latest + outputs: + version: ${{ steps.supported-versions-matrix.outputs.lowest }} + steps: + - uses: actions/checkout@v4 + - id: supported-versions-matrix + uses: WyriHaximus/github-action-composer-php-versions-in-range@v1 + with: + workingDirectory: clients/GitHubEnterprise-3.15 + generate-githubenterprise-3_15: + name: Generate GitHubEnterprise-3.15 + runs-on: ubuntu-latest + needs: + - supported-versions-matrix + container: + image: wyrihaximusnet/php:${{ needs.supported-versions-matrix.outputs.version }}-nts-alpine-slim-dev-root + steps: + - uses: actions/checkout@v4 + - uses: ramsey/composer-install@v2 + - uses: ramsey/composer-install@v2 + with: + working-directory: "clients/GitHubEnterprise-3.15" + - name: Download current spec file + run: | + rm etc/specs/GitHubEnterprise-3.15/previous.spec.yaml || true + mv etc/specs/GitHubEnterprise-3.15/current.spec.yaml etc/specs/GitHubEnterprise-3.15/previous.spec.yaml + curl -o etc/specs/GitHubEnterprise-3.15/current.spec.yaml https://raw.githubusercontent.com/github/rest-api-description/main/descriptions-next/ghes-3.15/ghes-3.15.yaml + php utils/patch-broken-spec-files.php etc/specs/GitHubEnterprise-3.15/current.spec.yaml + - name: Hash specs + id: spec-hash + run: | + php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "current=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.15/current.spec.yaml")) . "\n", FILE_APPEND);' + php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.15/previous.spec.yaml")) . "\n", FILE_APPEND);' + - name: Look current up spec version + id: look-current-up-spec-version + uses: mikefarah/yq@v4.44.3 + with: + cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.15/current.spec.yaml' + - name: Look previous up spec version + id: look-previous-up-spec-version + uses: mikefarah/yq@v4.44.3 + with: + cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.15/previous.spec.yaml' + - name: Generate spec diff + id: spec-diff + run: | + curl -fsSL https://pb33f.io/openapi-changes/install.sh | sh + echo "Detected Schema changes:" >> "var/detected-schema-changes" + echo "$(openapi-changes summary --markdown --no-color --no-logo etc/specs/GitHubEnterprise-3.15/current.spec.yaml etc/specs/GitHubEnterprise-3.15/previous.spec.yaml)" >> "var/detected-schema-changes" + cat var/detected-schema-changes + delimiter="$(openssl rand -hex 8)" + echo "diff<<${delimiter}" >> "${GITHUB_OUTPUT}" + echo "$(cat var/detected-schema-changes)" >> "${GITHUB_OUTPUT}" + echo "${delimiter}" >> "${GITHUB_OUTPUT}" + - name: Update Client to ${{ steps.look-current-up-spec-version.outputs.result }} + run: | + make generate-client GitHubEnterprise-3.15 + - name: Create Pull Request + uses: peter-evans/create-pull-request@v7 + with: + branch: "GitHubEnterprise-3.15/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" + token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} + labels: | + Automated PR + New Version + automerge + Enhancement ✨ + GitHubEnterprise-3.15 + title: "[GitHubEnterprise-3.15] Update to ${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }} from ${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.previous }}" + body-path: "var/detected-schema-changes" + commit-message: | + [GitHubEnterprise-3.15] Update to ${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }} from ${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.previous }} + ${{ steps.spec-diff.outputs.diff }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.2.yaml b/.github/workflows/generate-GitHubEnterprise-3.2.yaml index 3f1e80b5706..6781edb8ae6 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.2.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.2.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.2" on: workflow_dispatch: schedule: - - cron: '13 8 * * *' + - cron: '13 11 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.2 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.2/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.2/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.2/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.2 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.2/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.3.yaml b/.github/workflows/generate-GitHubEnterprise-3.3.yaml index 19dbc7aa2a0..10c24d115ce 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.3.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.3.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.3" on: workflow_dispatch: schedule: - - cron: '13 9 * * *' + - cron: '13 12 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.3 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.3/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.3/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.3/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.3 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.3/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.4.yaml b/.github/workflows/generate-GitHubEnterprise-3.4.yaml index 8272e5f9bb8..58025aedeff 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.4.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.4.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.4" on: workflow_dispatch: schedule: - - cron: '13 10 * * *' + - cron: '13 13 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.4 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.4/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.4/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.4/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.4 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.4/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.5.yaml b/.github/workflows/generate-GitHubEnterprise-3.5.yaml index 63dd480a63a..b3e6f7daa01 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.5.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.5.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.5" on: workflow_dispatch: schedule: - - cron: '13 11 * * *' + - cron: '13 14 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.5 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.5/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.5/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.5/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.5 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.5/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.6.yaml b/.github/workflows/generate-GitHubEnterprise-3.6.yaml index 5368804c088..4d19d29a5c0 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.6.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.6.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.6" on: workflow_dispatch: schedule: - - cron: '13 12 * * *' + - cron: '13 15 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.6 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.6/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.6/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.6/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.6 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.6/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.7.yaml b/.github/workflows/generate-GitHubEnterprise-3.7.yaml index 5b4fdda999a..d522d73ccaa 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.7.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.7.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.7" on: workflow_dispatch: schedule: - - cron: '13 13 * * *' + - cron: '13 16 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.7 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.7/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.7/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.7/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.7 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.7/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.8.yaml b/.github/workflows/generate-GitHubEnterprise-3.8.yaml index 71519efe369..2eae163529b 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.8.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.8.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.8" on: workflow_dispatch: schedule: - - cron: '13 14 * * *' + - cron: '13 17 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.8 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.8/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.8/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.8/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.8 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.8/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterprise-3.9.yaml b/.github/workflows/generate-GitHubEnterprise-3.9.yaml index 109a0dfc058..ae7a5097f54 100644 --- a/.github/workflows/generate-GitHubEnterprise-3.9.yaml +++ b/.github/workflows/generate-GitHubEnterprise-3.9.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterprise-3.9" on: workflow_dispatch: schedule: - - cron: '13 15 * * *' + - cron: '13 18 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterprise-3.9 @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterprise-3.9/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.9/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterprise-3.9/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterprise-3.9 - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterprise-3.9/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/generate-GitHubEnterpriseCloud.yaml b/.github/workflows/generate-GitHubEnterpriseCloud.yaml index 11abf2094b8..13e0624ff08 100644 --- a/.github/workflows/generate-GitHubEnterpriseCloud.yaml +++ b/.github/workflows/generate-GitHubEnterpriseCloud.yaml @@ -2,7 +2,7 @@ name: "Generate: GitHubEnterpriseCloud" on: workflow_dispatch: schedule: - - cron: '13 17 * * *' + - cron: '13 20 * * *' jobs: supported-versions-matrix: name: Supported Versions Matrix GitHubEnterpriseCloud @@ -41,12 +41,12 @@ jobs: php -r 'file_put_contents(getenv("GITHUB_OUTPUT"), "previous=" . md5(file_get_contents("etc/specs/GitHubEnterpriseCloud/previous.spec.yaml")) . "\n", FILE_APPEND);' - name: Look current up spec version id: look-current-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterpriseCloud/current.spec.yaml' - name: Look previous up spec version id: look-previous-up-spec-version - uses: mikefarah/yq@v4.43.1 + uses: mikefarah/yq@v4.44.3 with: cmd: yq '.info.version' 'etc/specs/GitHubEnterpriseCloud/previous.spec.yaml' - name: Generate spec diff @@ -64,7 +64,7 @@ jobs: run: | make generate-client GitHubEnterpriseCloud - name: Create Pull Request - uses: peter-evans/create-pull-request@v6 + uses: peter-evans/create-pull-request@v7 with: branch: "GitHubEnterpriseCloud/from-${{ steps.look-current-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}-from-${{ steps.look-previous-up-spec-version.outputs.result }}-${{ steps.spec-hash.outputs.current }}" token: ${{ secrets.SUBSPLIT_GITHUB_TOKEN }} diff --git a/.github/workflows/release-managment-GitHubEnterprise-3.13.yaml b/.github/workflows/release-managment-GitHubEnterprise-3.13.yaml new file mode 100644 index 00000000000..db4a8d74649 --- /dev/null +++ b/.github/workflows/release-managment-GitHubEnterprise-3.13.yaml @@ -0,0 +1,22 @@ +name: "Release Management: GitHubEnterprise-3.13" +on: + pull_request: + paths: + - ".github/workflows/ci-GitHubEnterprise-3.13.yaml" + - ".github/workflows/generate-GitHubEnterprise-3.13.yaml" + - ".github/workflows/release-management-GitHubEnterprise-3.13.yaml" + - "clients/GitHubEnterprise-3.13/**" + types: + - opened + - labeled + - unlabeled + - synchronize + - reopened +permissions: + contents: write + issues: write + pull-requests: write +jobs: + release-managment: + name: Release Management + uses: WyriHaximus/github-workflows/.github/workflows/package-release-managment.yaml@main diff --git a/.github/workflows/release-managment-GitHubEnterprise-3.14.yaml b/.github/workflows/release-managment-GitHubEnterprise-3.14.yaml new file mode 100644 index 00000000000..52352339f48 --- /dev/null +++ b/.github/workflows/release-managment-GitHubEnterprise-3.14.yaml @@ -0,0 +1,22 @@ +name: "Release Management: GitHubEnterprise-3.14" +on: + pull_request: + paths: + - ".github/workflows/ci-GitHubEnterprise-3.14.yaml" + - ".github/workflows/generate-GitHubEnterprise-3.14.yaml" + - ".github/workflows/release-management-GitHubEnterprise-3.14.yaml" + - "clients/GitHubEnterprise-3.14/**" + types: + - opened + - labeled + - unlabeled + - synchronize + - reopened +permissions: + contents: write + issues: write + pull-requests: write +jobs: + release-managment: + name: Release Management + uses: WyriHaximus/github-workflows/.github/workflows/package-release-managment.yaml@main diff --git a/.github/workflows/release-managment-GitHubEnterprise-3.15.yaml b/.github/workflows/release-managment-GitHubEnterprise-3.15.yaml new file mode 100644 index 00000000000..9d7a21f0d3b --- /dev/null +++ b/.github/workflows/release-managment-GitHubEnterprise-3.15.yaml @@ -0,0 +1,22 @@ +name: "Release Management: GitHubEnterprise-3.15" +on: + pull_request: + paths: + - ".github/workflows/ci-GitHubEnterprise-3.15.yaml" + - ".github/workflows/generate-GitHubEnterprise-3.15.yaml" + - ".github/workflows/release-management-GitHubEnterprise-3.15.yaml" + - "clients/GitHubEnterprise-3.15/**" + types: + - opened + - labeled + - unlabeled + - synchronize + - reopened +permissions: + contents: write + issues: write + pull-requests: write +jobs: + release-managment: + name: Release Management + uses: WyriHaximus/github-workflows/.github/workflows/package-release-managment.yaml@main diff --git a/clients/GitHubEnterprise-3.13/.editorconfig b/clients/GitHubEnterprise-3.13/.editorconfig new file mode 100644 index 00000000000..ddb9a84a8fc --- /dev/null +++ b/clients/GitHubEnterprise-3.13/.editorconfig @@ -0,0 +1,20 @@ +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.json] +indent_size = 2 + +[*.yml] +indent_size = 2 + +[*.yaml] +indent_size = 2 + +[Makefile] +indent_style = tab diff --git a/clients/GitHubEnterprise-3.13/.gitattributes b/clients/GitHubEnterprise-3.13/.gitattributes new file mode 100644 index 00000000000..16226a1ea55 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/.gitattributes @@ -0,0 +1,14 @@ +# Ignoring files for distribution archieves +.github/ export-ignore +etc/ export-ignore +tests/ export-ignore +var/ export-ignore +.editorconfig export-ignore +.gitattributes export-ignore +.gitignore export-ignore +CONTRIBUTING.md export-ignore +composer.lock export-ignore +infection.json.dist export-ignore +Makefile export-ignore +phpunit.xml.dist export-ignore +README.md export-ignore diff --git a/clients/GitHubEnterprise-3.13/.gitignore b/clients/GitHubEnterprise-3.13/.gitignore new file mode 100644 index 00000000000..36d04d65c40 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/.gitignore @@ -0,0 +1,3 @@ +var/ +vendor/ +etc/qa/.phpunit.result.cache diff --git a/clients/GitHubEnterprise-3.13/Makefile b/clients/GitHubEnterprise-3.13/Makefile new file mode 100644 index 00000000000..78bcf6d638e --- /dev/null +++ b/clients/GitHubEnterprise-3.13/Makefile @@ -0,0 +1,52 @@ +# set all to phony +SHELL=bash + +.PHONY: * + +DOCKER_CGROUP:=$(shell cat /proc/1/cgroup | grep docker | wc -l) +COMPOSER_CACHE_DIR:=$(shell composer config --global cache-dir -q || echo ${HOME}/.composer/cache) + +ifneq ("$(wildcard /.dockerenv)","") + IN_DOCKER:=TRUE +else ifneq ("$(DOCKER_CGROUP)","0") + IN_DOCKER:=TRUE +else + IN_DOCKER:=FALSE +endif + +ifeq ("$(IN_DOCKER)","TRUE") + DOCKER_RUN:= +else + PHP_VERSION:=$(shell docker run --rm -v "`pwd`:`pwd`" jess/jq jq -r -c '.config.platform.php' "`pwd`/composer.json" | php -r "echo str_replace('|', '.', explode('.', implode('|', explode('.', stream_get_contents(STDIN), 2)), 2)[0]);") + DOCKER_RUN:=docker run --rm -it \ + -v "`pwd`:`pwd`" \ + -v "${COMPOSER_CACHE_DIR}:/home/app/.composer/cache" \ + -w "`pwd`" \ + "ghcr.io/wyrihaximusnet/php:${PHP_VERSION}-nts-alpine-slim-dev" +endif + +all: ## Runs everything ### + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | xargs --open-tty $(MAKE) + +syntax-php: ## Lint PHP syntax + $(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor . + +cs-fix: ## Fix any automatically fixable code style issues + $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml + +cs: ## Check the code for code style issues + $(DOCKER_RUN) vendor/bin/phpcs --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml + +unit-testing: ## Run tests + $(DOCKER_RUN) vendor/bin/phpunit --colors=always -c ./etc/qa/phpunit.xml + $(DOCKER_RUN) test -n "$(COVERALLS_REPO_TOKEN)" && test -n "$(COVERALLS_RUN_LOCALLY)" && test -f ./var/tests-unit-clover-coverage.xml && vendor/bin/php-coveralls -v --coverage_clover ./build/logs/clover.xml --json_path ./var/tests-unit-clover-coverage-upload.json || true + +shell: ## Provides Shell access in the expected environment ### + $(DOCKER_RUN) ash + +task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ### + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]' + +help: ## Show this help ### + @printf "\033[33mUsage:\033[0m\n make [target]\n\n\033[33mTargets:\033[0m\n" + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[32m%-32s\033[0m %s\n", $$1, $$2}' | tr -d '#' diff --git a/clients/GitHubEnterprise-3.13/composer.json b/clients/GitHubEnterprise-3.13/composer.json new file mode 100644 index 00000000000..23f59dbc167 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/composer.json @@ -0,0 +1,50 @@ +{ + "name": "api-clients/github-enterprise", + "description": "Non-Blocking first GitHub Enterprise (v3.13) client", + "license": "MIT", + "authors": [ + { + "name": "Cees-Jan Kiewiet", + "email": "ceesjank@gmail.com" + } + ], + "require": { + "php": "^8.2", + "api-clients/contracts": "^0.1", + "api-clients/openapi-client-utils": "dev-main", + "devizzent/cebe-php-openapi": "^1.0.1", + "eventsauce/object-hydrator": "^1.4.0", + "league/openapi-psr7-validator": "^0.22 || ^0.21", + "react/event-loop": "^1.4.0", + "react/http": "^1.9.0", + "react/async": "^4.1.0", + "wyrihaximus/react-awaitable-observable": "^1.0" + }, + "require-dev": { + "wyrihaximus/async-test-utilities": "^7.0.3" + }, + "autoload": { + "psr-4": { + "ApiClients\\Client\\GitHubEnterprise\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "ApiClients\\Tests\\Client\\GitHubEnterprise\\": "tests/" + } + }, + "config": { + "sort-packages": true, + "platform": { + "php": "8.2.13" + }, + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true, + "composer/package-versions-deprecated": true, + "ergebnis/composer-normalize": true, + "icanhazstring/composer-unused": true, + "wyrihaximus/composer-update-bin-autoload-path": true, + "infection/extension-installer": true + } + } +} diff --git a/clients/GitHubEnterprise-3.13/etc/openapi-generator-config.yaml b/clients/GitHubEnterprise-3.13/etc/openapi-generator-config.yaml new file mode 100644 index 00000000000..3e0a4a04f4d --- /dev/null +++ b/clients/GitHubEnterprise-3.13/etc/openapi-generator-config.yaml @@ -0,0 +1,38 @@ +state: + file: etc/openapi-client-generator.state + additionalFiles: + - composer.json + - composer.lock + - ../../composer.json + - ../../composer.lock +spec: ../../../etc/specs/GitHubEnterprise-3.13/current.spec.yaml +namespace: + source: ApiClients\Client\GitHubEnterprise + test: ApiClients\Tests\Client\GitHubEnterprise +entryPoints: + call: true + operations: true + webHooks: true +destination: + root: ../ + source: src + test: tests +templates: + dir: ../templates +schemas: + allowDuplication: true + useAliasesForDuplication: true +contentType: + - ApiClients\Tools\OpenApiClientGenerator\ContentType\Json + - ApiClients\Tools\OpenApiClientGenerator\ContentType\Raw +voter: + listOperation: + - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery + streamOperation: + - ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId +qa: + phpcs: + enabled: true + phpstan: + enabled: true + configFilePath: etc/phpstan-extension.neon diff --git a/clients/GitHubEnterprise-3.13/etc/qa/composer-require-checker.json b/clients/GitHubEnterprise-3.13/etc/qa/composer-require-checker.json new file mode 100644 index 00000000000..85b390416dc --- /dev/null +++ b/clients/GitHubEnterprise-3.13/etc/qa/composer-require-checker.json @@ -0,0 +1,19 @@ +{ + "symbol-whitelist" : [ + "null", "true", "false", + "static", "self", "parent", + "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object", + "Safe\\date", "WyriHaximus\\Constants\\Boolean\\FALSE_", "WyriHaximus\\Constants\\Boolean\\TRUE_", + "WyriHaximus\\Constants\\Numeric\\ONE", "WyriHaximus\\Constants\\Numeric\\ZERO" + ], + "php-core-extensions" : [ + "Core", + "date", + "pcre", + "Phar", + "Reflection", + "SPL", + "standard" + ], + "scan-files" : [] +} diff --git a/clients/GitHubEnterprise-3.13/etc/qa/phpcs.xml b/clients/GitHubEnterprise-3.13/etc/qa/phpcs.xml new file mode 100644 index 00000000000..b405254b22a --- /dev/null +++ b/clients/GitHubEnterprise-3.13/etc/qa/phpcs.xml @@ -0,0 +1,15 @@ + + + + + + + + + ../../src + ../../tests + + src/Hydrator/* + + + diff --git a/clients/GitHubEnterprise-3.13/etc/qa/phpstan.neon b/clients/GitHubEnterprise-3.13/etc/qa/phpstan.neon new file mode 100644 index 00000000000..9939fb4d715 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/etc/qa/phpstan.neon @@ -0,0 +1,2 @@ +includes: + - ../../vendor/wyrihaximus/async-test-utilities/rules.neon diff --git a/clients/GitHubEnterprise-3.13/etc/qa/phpunit.xml b/clients/GitHubEnterprise-3.13/etc/qa/phpunit.xml new file mode 100644 index 00000000000..426c660bde3 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/etc/qa/phpunit.xml @@ -0,0 +1,13 @@ + + + + + ../../tests/ + + + + + ../../src/ + + + diff --git a/clients/GitHubEnterprise-3.13/etc/qa/psalm.xml b/clients/GitHubEnterprise-3.13/etc/qa/psalm.xml new file mode 100644 index 00000000000..ab7c76595a0 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/etc/qa/psalm.xml @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/clients/GitHubEnterprise-3.13/src/BearerToken.php b/clients/GitHubEnterprise-3.13/src/BearerToken.php new file mode 100644 index 00000000000..a14e49c97a4 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/src/BearerToken.php @@ -0,0 +1,19 @@ +token; + } +} diff --git a/clients/GitHubEnterprise-3.13/templates/README.md b/clients/GitHubEnterprise-3.13/templates/README.md new file mode 100644 index 00000000000..ebca14dafe9 --- /dev/null +++ b/clients/GitHubEnterprise-3.13/templates/README.md @@ -0,0 +1,73 @@ +# [READONLY-SUBSPLIT] github-enterprise + + +![Continuous Integration](https://github.com/php-api-clients/github-enterprise/workflows/Continuous%20Integration/badge.svg) +[![Latest Stable Version](https://poser.pugx.org/api-clients/github-enterprise/v/stable.png)](https://packagist.org/packages/api-clients/github-enterprise) +[![Total Downloads](https://poser.pugx.org/api-clients/github-enterprise/downloads.png)](https://packagist.org/packages/api-clients/github-enterprise) +[![Code Coverage](https://scrutinizer-ci.com/g/php-api-clients/github-enterprise/badges/coverage.png?b==v0.1.3.13.x)](https://scrutinizer-ci.com/g/php-api-clients/github-enterprise/?branch=v0.1.3.13.x) +[![License](https://poser.pugx.org/api-clients/github-enterprise/license.png)](https://packagist.org/packages/api-clients/github-enterprise) + +Non-Blocking first GitHub Enterprise (v3.13) client, this is a read only sub split, see [`github-root`](https://github.com/php-api-clients/github-root) for the root package. + +## Usage + +```php +use React\Http\Browser; +use ApiClients\Client\GitHubEnterprise\BearerToken; +use ApiClients\Client\GitHubEnterprise\Client; + +use function React\Async\async; + +$client = new Client(new BearerToken('YOUR_TOKEN_HERE'), new Browser()); + +// The client is using react/async internally to provide a non-promise API. +// As such you're expected to use it inside a fiber, the async call here is +// added to demonstrate and documented that requirement. The rest of the +// examples assume you have already wrapped in a fiber 0 or more levels up +// in your code such as a command bus executer or your HTTP server. +async(static function () { +{% if client.configuration.entryPoints.call == true %} + // Make API calls using the call method + $client->call('METHOD /path/to/{the}/operation', ['array' => 'with', 'paramters' => 'for', 'the' => 'operation']); +{% endif %} +{% if client.configuration.entryPoints.operations == true %} + // Make API calls using the operations objects + $client->operations()->group()->operation(array: 'with', paramters: 'for', the: 'operation'); +{% endif %} +})(); +``` + +{% if client.configuration.entryPoints.call == true or client.configuration.entryPoints.operations == true %} +## Supported operations + +{% for operation in client.operations %} + +### {{ operation.operationId }} + +{{ operation.summary }} + +{% if client.configuration.entryPoints.call == true %} +Using the `call` method: +```php +$client->call('{{ operation.matchMethod }} {{ operation.path }}'{% if operation.parameters|length > 0 %}, [ +{% for parameter in operation.parameters %} '{{ parameter.targetName }}' => {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %}, +{% endfor %}]{% endif %}); +``` +{% endif %} + +{% if client.configuration.entryPoints.operations == true %} +Operations method: +```php +$client->operations()->{{ operation.groupCamel }}()->{{ operation.nameCamel }}({% if operation.parameters|length > 0 %} +{% for parameter in operation.parameters %} {{ parameter.targetName }}: {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %}, +{% endfor %}{% endif %}); +``` +{% endif %} + +{% if operation.externalDocs != null %} +You can find more about this operation over at the [{{ operation.externalDocs.description }}]({{ operation.externalDocs.url }}). +{% endif %} + +{% endfor %} +{% endif %} + diff --git a/clients/GitHubEnterprise-3.14/.editorconfig b/clients/GitHubEnterprise-3.14/.editorconfig new file mode 100644 index 00000000000..ddb9a84a8fc --- /dev/null +++ b/clients/GitHubEnterprise-3.14/.editorconfig @@ -0,0 +1,20 @@ +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.json] +indent_size = 2 + +[*.yml] +indent_size = 2 + +[*.yaml] +indent_size = 2 + +[Makefile] +indent_style = tab diff --git a/clients/GitHubEnterprise-3.14/.gitattributes b/clients/GitHubEnterprise-3.14/.gitattributes new file mode 100644 index 00000000000..16226a1ea55 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/.gitattributes @@ -0,0 +1,14 @@ +# Ignoring files for distribution archieves +.github/ export-ignore +etc/ export-ignore +tests/ export-ignore +var/ export-ignore +.editorconfig export-ignore +.gitattributes export-ignore +.gitignore export-ignore +CONTRIBUTING.md export-ignore +composer.lock export-ignore +infection.json.dist export-ignore +Makefile export-ignore +phpunit.xml.dist export-ignore +README.md export-ignore diff --git a/clients/GitHubEnterprise-3.14/.gitignore b/clients/GitHubEnterprise-3.14/.gitignore new file mode 100644 index 00000000000..36d04d65c40 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/.gitignore @@ -0,0 +1,3 @@ +var/ +vendor/ +etc/qa/.phpunit.result.cache diff --git a/clients/GitHubEnterprise-3.14/Makefile b/clients/GitHubEnterprise-3.14/Makefile new file mode 100644 index 00000000000..78bcf6d638e --- /dev/null +++ b/clients/GitHubEnterprise-3.14/Makefile @@ -0,0 +1,52 @@ +# set all to phony +SHELL=bash + +.PHONY: * + +DOCKER_CGROUP:=$(shell cat /proc/1/cgroup | grep docker | wc -l) +COMPOSER_CACHE_DIR:=$(shell composer config --global cache-dir -q || echo ${HOME}/.composer/cache) + +ifneq ("$(wildcard /.dockerenv)","") + IN_DOCKER:=TRUE +else ifneq ("$(DOCKER_CGROUP)","0") + IN_DOCKER:=TRUE +else + IN_DOCKER:=FALSE +endif + +ifeq ("$(IN_DOCKER)","TRUE") + DOCKER_RUN:= +else + PHP_VERSION:=$(shell docker run --rm -v "`pwd`:`pwd`" jess/jq jq -r -c '.config.platform.php' "`pwd`/composer.json" | php -r "echo str_replace('|', '.', explode('.', implode('|', explode('.', stream_get_contents(STDIN), 2)), 2)[0]);") + DOCKER_RUN:=docker run --rm -it \ + -v "`pwd`:`pwd`" \ + -v "${COMPOSER_CACHE_DIR}:/home/app/.composer/cache" \ + -w "`pwd`" \ + "ghcr.io/wyrihaximusnet/php:${PHP_VERSION}-nts-alpine-slim-dev" +endif + +all: ## Runs everything ### + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | xargs --open-tty $(MAKE) + +syntax-php: ## Lint PHP syntax + $(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor . + +cs-fix: ## Fix any automatically fixable code style issues + $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml + +cs: ## Check the code for code style issues + $(DOCKER_RUN) vendor/bin/phpcs --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml + +unit-testing: ## Run tests + $(DOCKER_RUN) vendor/bin/phpunit --colors=always -c ./etc/qa/phpunit.xml + $(DOCKER_RUN) test -n "$(COVERALLS_REPO_TOKEN)" && test -n "$(COVERALLS_RUN_LOCALLY)" && test -f ./var/tests-unit-clover-coverage.xml && vendor/bin/php-coveralls -v --coverage_clover ./build/logs/clover.xml --json_path ./var/tests-unit-clover-coverage-upload.json || true + +shell: ## Provides Shell access in the expected environment ### + $(DOCKER_RUN) ash + +task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ### + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]' + +help: ## Show this help ### + @printf "\033[33mUsage:\033[0m\n make [target]\n\n\033[33mTargets:\033[0m\n" + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[32m%-32s\033[0m %s\n", $$1, $$2}' | tr -d '#' diff --git a/clients/GitHubEnterprise-3.14/composer.json b/clients/GitHubEnterprise-3.14/composer.json new file mode 100644 index 00000000000..61a73e47388 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/composer.json @@ -0,0 +1,50 @@ +{ + "name": "api-clients/github-enterprise", + "description": "Non-Blocking first GitHub Enterprise (v3.14) client", + "license": "MIT", + "authors": [ + { + "name": "Cees-Jan Kiewiet", + "email": "ceesjank@gmail.com" + } + ], + "require": { + "php": "^8.2", + "api-clients/contracts": "^0.1", + "api-clients/openapi-client-utils": "dev-main", + "devizzent/cebe-php-openapi": "^1.0.1", + "eventsauce/object-hydrator": "^1.4.0", + "league/openapi-psr7-validator": "^0.22 || ^0.21", + "react/event-loop": "^1.4.0", + "react/http": "^1.9.0", + "react/async": "^4.1.0", + "wyrihaximus/react-awaitable-observable": "^1.0" + }, + "require-dev": { + "wyrihaximus/async-test-utilities": "^7.0.3" + }, + "autoload": { + "psr-4": { + "ApiClients\\Client\\GitHubEnterprise\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "ApiClients\\Tests\\Client\\GitHubEnterprise\\": "tests/" + } + }, + "config": { + "sort-packages": true, + "platform": { + "php": "8.2.13" + }, + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true, + "composer/package-versions-deprecated": true, + "ergebnis/composer-normalize": true, + "icanhazstring/composer-unused": true, + "wyrihaximus/composer-update-bin-autoload-path": true, + "infection/extension-installer": true + } + } +} diff --git a/clients/GitHubEnterprise-3.14/etc/openapi-generator-config.yaml b/clients/GitHubEnterprise-3.14/etc/openapi-generator-config.yaml new file mode 100644 index 00000000000..99537bdf2f1 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/etc/openapi-generator-config.yaml @@ -0,0 +1,38 @@ +state: + file: etc/openapi-client-generator.state + additionalFiles: + - composer.json + - composer.lock + - ../../composer.json + - ../../composer.lock +spec: ../../../etc/specs/GitHubEnterprise-3.14/current.spec.yaml +namespace: + source: ApiClients\Client\GitHubEnterprise + test: ApiClients\Tests\Client\GitHubEnterprise +entryPoints: + call: true + operations: true + webHooks: true +destination: + root: ../ + source: src + test: tests +templates: + dir: ../templates +schemas: + allowDuplication: true + useAliasesForDuplication: true +contentType: + - ApiClients\Tools\OpenApiClientGenerator\ContentType\Json + - ApiClients\Tools\OpenApiClientGenerator\ContentType\Raw +voter: + listOperation: + - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery + streamOperation: + - ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId +qa: + phpcs: + enabled: true + phpstan: + enabled: true + configFilePath: etc/phpstan-extension.neon diff --git a/clients/GitHubEnterprise-3.14/etc/qa/composer-require-checker.json b/clients/GitHubEnterprise-3.14/etc/qa/composer-require-checker.json new file mode 100644 index 00000000000..85b390416dc --- /dev/null +++ b/clients/GitHubEnterprise-3.14/etc/qa/composer-require-checker.json @@ -0,0 +1,19 @@ +{ + "symbol-whitelist" : [ + "null", "true", "false", + "static", "self", "parent", + "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object", + "Safe\\date", "WyriHaximus\\Constants\\Boolean\\FALSE_", "WyriHaximus\\Constants\\Boolean\\TRUE_", + "WyriHaximus\\Constants\\Numeric\\ONE", "WyriHaximus\\Constants\\Numeric\\ZERO" + ], + "php-core-extensions" : [ + "Core", + "date", + "pcre", + "Phar", + "Reflection", + "SPL", + "standard" + ], + "scan-files" : [] +} diff --git a/clients/GitHubEnterprise-3.14/etc/qa/phpcs.xml b/clients/GitHubEnterprise-3.14/etc/qa/phpcs.xml new file mode 100644 index 00000000000..b405254b22a --- /dev/null +++ b/clients/GitHubEnterprise-3.14/etc/qa/phpcs.xml @@ -0,0 +1,15 @@ + + + + + + + + + ../../src + ../../tests + + src/Hydrator/* + + + diff --git a/clients/GitHubEnterprise-3.14/etc/qa/phpstan.neon b/clients/GitHubEnterprise-3.14/etc/qa/phpstan.neon new file mode 100644 index 00000000000..9939fb4d715 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/etc/qa/phpstan.neon @@ -0,0 +1,2 @@ +includes: + - ../../vendor/wyrihaximus/async-test-utilities/rules.neon diff --git a/clients/GitHubEnterprise-3.14/etc/qa/phpunit.xml b/clients/GitHubEnterprise-3.14/etc/qa/phpunit.xml new file mode 100644 index 00000000000..426c660bde3 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/etc/qa/phpunit.xml @@ -0,0 +1,13 @@ + + + + + ../../tests/ + + + + + ../../src/ + + + diff --git a/clients/GitHubEnterprise-3.14/etc/qa/psalm.xml b/clients/GitHubEnterprise-3.14/etc/qa/psalm.xml new file mode 100644 index 00000000000..ab7c76595a0 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/etc/qa/psalm.xml @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/clients/GitHubEnterprise-3.14/src/BearerToken.php b/clients/GitHubEnterprise-3.14/src/BearerToken.php new file mode 100644 index 00000000000..a14e49c97a4 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/src/BearerToken.php @@ -0,0 +1,19 @@ +token; + } +} diff --git a/clients/GitHubEnterprise-3.14/templates/README.md b/clients/GitHubEnterprise-3.14/templates/README.md new file mode 100644 index 00000000000..ef02ece0cc0 --- /dev/null +++ b/clients/GitHubEnterprise-3.14/templates/README.md @@ -0,0 +1,73 @@ +# [READONLY-SUBSPLIT] github-enterprise + + +![Continuous Integration](https://github.com/php-api-clients/github-enterprise/workflows/Continuous%20Integration/badge.svg) +[![Latest Stable Version](https://poser.pugx.org/api-clients/github-enterprise/v/stable.png)](https://packagist.org/packages/api-clients/github-enterprise) +[![Total Downloads](https://poser.pugx.org/api-clients/github-enterprise/downloads.png)](https://packagist.org/packages/api-clients/github-enterprise) +[![Code Coverage](https://scrutinizer-ci.com/g/php-api-clients/github-enterprise/badges/coverage.png?b==v0.1.3.14.x)](https://scrutinizer-ci.com/g/php-api-clients/github-enterprise/?branch=v0.1.3.14.x) +[![License](https://poser.pugx.org/api-clients/github-enterprise/license.png)](https://packagist.org/packages/api-clients/github-enterprise) + +Non-Blocking first GitHub Enterprise (v3.14) client, this is a read only sub split, see [`github-root`](https://github.com/php-api-clients/github-root) for the root package. + +## Usage + +```php +use React\Http\Browser; +use ApiClients\Client\GitHubEnterprise\BearerToken; +use ApiClients\Client\GitHubEnterprise\Client; + +use function React\Async\async; + +$client = new Client(new BearerToken('YOUR_TOKEN_HERE'), new Browser()); + +// The client is using react/async internally to provide a non-promise API. +// As such you're expected to use it inside a fiber, the async call here is +// added to demonstrate and documented that requirement. The rest of the +// examples assume you have already wrapped in a fiber 0 or more levels up +// in your code such as a command bus executer or your HTTP server. +async(static function () { +{% if client.configuration.entryPoints.call == true %} + // Make API calls using the call method + $client->call('METHOD /path/to/{the}/operation', ['array' => 'with', 'paramters' => 'for', 'the' => 'operation']); +{% endif %} +{% if client.configuration.entryPoints.operations == true %} + // Make API calls using the operations objects + $client->operations()->group()->operation(array: 'with', paramters: 'for', the: 'operation'); +{% endif %} +})(); +``` + +{% if client.configuration.entryPoints.call == true or client.configuration.entryPoints.operations == true %} +## Supported operations + +{% for operation in client.operations %} + +### {{ operation.operationId }} + +{{ operation.summary }} + +{% if client.configuration.entryPoints.call == true %} +Using the `call` method: +```php +$client->call('{{ operation.matchMethod }} {{ operation.path }}'{% if operation.parameters|length > 0 %}, [ +{% for parameter in operation.parameters %} '{{ parameter.targetName }}' => {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %}, +{% endfor %}]{% endif %}); +``` +{% endif %} + +{% if client.configuration.entryPoints.operations == true %} +Operations method: +```php +$client->operations()->{{ operation.groupCamel }}()->{{ operation.nameCamel }}({% if operation.parameters|length > 0 %} +{% for parameter in operation.parameters %} {{ parameter.targetName }}: {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %}, +{% endfor %}{% endif %}); +``` +{% endif %} + +{% if operation.externalDocs != null %} +You can find more about this operation over at the [{{ operation.externalDocs.description }}]({{ operation.externalDocs.url }}). +{% endif %} + +{% endfor %} +{% endif %} + diff --git a/clients/GitHubEnterprise-3.15/.editorconfig b/clients/GitHubEnterprise-3.15/.editorconfig new file mode 100644 index 00000000000..ddb9a84a8fc --- /dev/null +++ b/clients/GitHubEnterprise-3.15/.editorconfig @@ -0,0 +1,20 @@ +root = true + +[*] +charset = utf-8 +indent_style = space +indent_size = 4 +insert_final_newline = true +trim_trailing_whitespace = true + +[*.json] +indent_size = 2 + +[*.yml] +indent_size = 2 + +[*.yaml] +indent_size = 2 + +[Makefile] +indent_style = tab diff --git a/clients/GitHubEnterprise-3.15/.gitattributes b/clients/GitHubEnterprise-3.15/.gitattributes new file mode 100644 index 00000000000..16226a1ea55 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/.gitattributes @@ -0,0 +1,14 @@ +# Ignoring files for distribution archieves +.github/ export-ignore +etc/ export-ignore +tests/ export-ignore +var/ export-ignore +.editorconfig export-ignore +.gitattributes export-ignore +.gitignore export-ignore +CONTRIBUTING.md export-ignore +composer.lock export-ignore +infection.json.dist export-ignore +Makefile export-ignore +phpunit.xml.dist export-ignore +README.md export-ignore diff --git a/clients/GitHubEnterprise-3.15/.gitignore b/clients/GitHubEnterprise-3.15/.gitignore new file mode 100644 index 00000000000..36d04d65c40 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/.gitignore @@ -0,0 +1,3 @@ +var/ +vendor/ +etc/qa/.phpunit.result.cache diff --git a/clients/GitHubEnterprise-3.15/Makefile b/clients/GitHubEnterprise-3.15/Makefile new file mode 100644 index 00000000000..78bcf6d638e --- /dev/null +++ b/clients/GitHubEnterprise-3.15/Makefile @@ -0,0 +1,52 @@ +# set all to phony +SHELL=bash + +.PHONY: * + +DOCKER_CGROUP:=$(shell cat /proc/1/cgroup | grep docker | wc -l) +COMPOSER_CACHE_DIR:=$(shell composer config --global cache-dir -q || echo ${HOME}/.composer/cache) + +ifneq ("$(wildcard /.dockerenv)","") + IN_DOCKER:=TRUE +else ifneq ("$(DOCKER_CGROUP)","0") + IN_DOCKER:=TRUE +else + IN_DOCKER:=FALSE +endif + +ifeq ("$(IN_DOCKER)","TRUE") + DOCKER_RUN:= +else + PHP_VERSION:=$(shell docker run --rm -v "`pwd`:`pwd`" jess/jq jq -r -c '.config.platform.php' "`pwd`/composer.json" | php -r "echo str_replace('|', '.', explode('.', implode('|', explode('.', stream_get_contents(STDIN), 2)), 2)[0]);") + DOCKER_RUN:=docker run --rm -it \ + -v "`pwd`:`pwd`" \ + -v "${COMPOSER_CACHE_DIR}:/home/app/.composer/cache" \ + -w "`pwd`" \ + "ghcr.io/wyrihaximusnet/php:${PHP_VERSION}-nts-alpine-slim-dev" +endif + +all: ## Runs everything ### + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | xargs --open-tty $(MAKE) + +syntax-php: ## Lint PHP syntax + $(DOCKER_RUN) vendor/bin/parallel-lint --exclude vendor . + +cs-fix: ## Fix any automatically fixable code style issues + $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml || $(DOCKER_RUN) vendor/bin/phpcbf --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml + +cs: ## Check the code for code style issues + $(DOCKER_RUN) vendor/bin/phpcs --parallel=$(shell nproc) --standard=./etc/qa/phpcs.xml + +unit-testing: ## Run tests + $(DOCKER_RUN) vendor/bin/phpunit --colors=always -c ./etc/qa/phpunit.xml + $(DOCKER_RUN) test -n "$(COVERALLS_REPO_TOKEN)" && test -n "$(COVERALLS_RUN_LOCALLY)" && test -f ./var/tests-unit-clover-coverage.xml && vendor/bin/php-coveralls -v --coverage_clover ./build/logs/clover.xml --json_path ./var/tests-unit-clover-coverage-upload.json || true + +shell: ## Provides Shell access in the expected environment ### + $(DOCKER_RUN) ash + +task-list-ci: ## CI: Generate a JSON array of jobs to run, matches the commands run when running `make (|all)` ### + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | grep -v "###" | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%s\n", $$1}' | jq --raw-input --slurp -c 'split("\n")| .[0:-1]' + +help: ## Show this help ### + @printf "\033[33mUsage:\033[0m\n make [target]\n\n\033[33mTargets:\033[0m\n" + @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " \033[32m%-32s\033[0m %s\n", $$1, $$2}' | tr -d '#' diff --git a/clients/GitHubEnterprise-3.15/composer.json b/clients/GitHubEnterprise-3.15/composer.json new file mode 100644 index 00000000000..123eb788e03 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/composer.json @@ -0,0 +1,50 @@ +{ + "name": "api-clients/github-enterprise", + "description": "Non-Blocking first GitHub Enterprise (v3.15) client", + "license": "MIT", + "authors": [ + { + "name": "Cees-Jan Kiewiet", + "email": "ceesjank@gmail.com" + } + ], + "require": { + "php": "^8.2", + "api-clients/contracts": "^0.1", + "api-clients/openapi-client-utils": "dev-main", + "devizzent/cebe-php-openapi": "^1.0.1", + "eventsauce/object-hydrator": "^1.4.0", + "league/openapi-psr7-validator": "^0.22 || ^0.21", + "react/event-loop": "^1.4.0", + "react/http": "^1.9.0", + "react/async": "^4.1.0", + "wyrihaximus/react-awaitable-observable": "^1.0" + }, + "require-dev": { + "wyrihaximus/async-test-utilities": "^7.0.3" + }, + "autoload": { + "psr-4": { + "ApiClients\\Client\\GitHubEnterprise\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { + "ApiClients\\Tests\\Client\\GitHubEnterprise\\": "tests/" + } + }, + "config": { + "sort-packages": true, + "platform": { + "php": "8.2.13" + }, + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": true, + "composer/package-versions-deprecated": true, + "ergebnis/composer-normalize": true, + "icanhazstring/composer-unused": true, + "wyrihaximus/composer-update-bin-autoload-path": true, + "infection/extension-installer": true + } + } +} diff --git a/clients/GitHubEnterprise-3.15/etc/openapi-generator-config.yaml b/clients/GitHubEnterprise-3.15/etc/openapi-generator-config.yaml new file mode 100644 index 00000000000..5ee0cda2892 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/etc/openapi-generator-config.yaml @@ -0,0 +1,38 @@ +state: + file: etc/openapi-client-generator.state + additionalFiles: + - composer.json + - composer.lock + - ../../composer.json + - ../../composer.lock +spec: ../../../etc/specs/GitHubEnterprise-3.15/current.spec.yaml +namespace: + source: ApiClients\Client\GitHubEnterprise + test: ApiClients\Tests\Client\GitHubEnterprise +entryPoints: + call: true + operations: true + webHooks: true +destination: + root: ../ + source: src + test: tests +templates: + dir: ../templates +schemas: + allowDuplication: true + useAliasesForDuplication: true +contentType: + - ApiClients\Tools\OpenApiClientGenerator\ContentType\Json + - ApiClients\Tools\OpenApiClientGenerator\ContentType\Raw +voter: + listOperation: + - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery + streamOperation: + - ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId +qa: + phpcs: + enabled: true + phpstan: + enabled: true + configFilePath: etc/phpstan-extension.neon diff --git a/clients/GitHubEnterprise-3.15/etc/qa/composer-require-checker.json b/clients/GitHubEnterprise-3.15/etc/qa/composer-require-checker.json new file mode 100644 index 00000000000..85b390416dc --- /dev/null +++ b/clients/GitHubEnterprise-3.15/etc/qa/composer-require-checker.json @@ -0,0 +1,19 @@ +{ + "symbol-whitelist" : [ + "null", "true", "false", + "static", "self", "parent", + "array", "string", "int", "float", "bool", "iterable", "callable", "void", "object", + "Safe\\date", "WyriHaximus\\Constants\\Boolean\\FALSE_", "WyriHaximus\\Constants\\Boolean\\TRUE_", + "WyriHaximus\\Constants\\Numeric\\ONE", "WyriHaximus\\Constants\\Numeric\\ZERO" + ], + "php-core-extensions" : [ + "Core", + "date", + "pcre", + "Phar", + "Reflection", + "SPL", + "standard" + ], + "scan-files" : [] +} diff --git a/clients/GitHubEnterprise-3.15/etc/qa/phpcs.xml b/clients/GitHubEnterprise-3.15/etc/qa/phpcs.xml new file mode 100644 index 00000000000..b405254b22a --- /dev/null +++ b/clients/GitHubEnterprise-3.15/etc/qa/phpcs.xml @@ -0,0 +1,15 @@ + + + + + + + + + ../../src + ../../tests + + src/Hydrator/* + + + diff --git a/clients/GitHubEnterprise-3.15/etc/qa/phpstan.neon b/clients/GitHubEnterprise-3.15/etc/qa/phpstan.neon new file mode 100644 index 00000000000..9939fb4d715 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/etc/qa/phpstan.neon @@ -0,0 +1,2 @@ +includes: + - ../../vendor/wyrihaximus/async-test-utilities/rules.neon diff --git a/clients/GitHubEnterprise-3.15/etc/qa/phpunit.xml b/clients/GitHubEnterprise-3.15/etc/qa/phpunit.xml new file mode 100644 index 00000000000..426c660bde3 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/etc/qa/phpunit.xml @@ -0,0 +1,13 @@ + + + + + ../../tests/ + + + + + ../../src/ + + + diff --git a/clients/GitHubEnterprise-3.15/etc/qa/psalm.xml b/clients/GitHubEnterprise-3.15/etc/qa/psalm.xml new file mode 100644 index 00000000000..ab7c76595a0 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/etc/qa/psalm.xml @@ -0,0 +1,52 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/clients/GitHubEnterprise-3.15/src/BearerToken.php b/clients/GitHubEnterprise-3.15/src/BearerToken.php new file mode 100644 index 00000000000..a14e49c97a4 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/src/BearerToken.php @@ -0,0 +1,19 @@ +token; + } +} diff --git a/clients/GitHubEnterprise-3.15/templates/README.md b/clients/GitHubEnterprise-3.15/templates/README.md new file mode 100644 index 00000000000..90f7e360b37 --- /dev/null +++ b/clients/GitHubEnterprise-3.15/templates/README.md @@ -0,0 +1,73 @@ +# [READONLY-SUBSPLIT] github-enterprise + + +![Continuous Integration](https://github.com/php-api-clients/github-enterprise/workflows/Continuous%20Integration/badge.svg) +[![Latest Stable Version](https://poser.pugx.org/api-clients/github-enterprise/v/stable.png)](https://packagist.org/packages/api-clients/github-enterprise) +[![Total Downloads](https://poser.pugx.org/api-clients/github-enterprise/downloads.png)](https://packagist.org/packages/api-clients/github-enterprise) +[![Code Coverage](https://scrutinizer-ci.com/g/php-api-clients/github-enterprise/badges/coverage.png?b==v0.1.3.15.x)](https://scrutinizer-ci.com/g/php-api-clients/github-enterprise/?branch=v0.1.3.15.x) +[![License](https://poser.pugx.org/api-clients/github-enterprise/license.png)](https://packagist.org/packages/api-clients/github-enterprise) + +Non-Blocking first GitHub Enterprise (v3.15) client, this is a read only sub split, see [`github-root`](https://github.com/php-api-clients/github-root) for the root package. + +## Usage + +```php +use React\Http\Browser; +use ApiClients\Client\GitHubEnterprise\BearerToken; +use ApiClients\Client\GitHubEnterprise\Client; + +use function React\Async\async; + +$client = new Client(new BearerToken('YOUR_TOKEN_HERE'), new Browser()); + +// The client is using react/async internally to provide a non-promise API. +// As such you're expected to use it inside a fiber, the async call here is +// added to demonstrate and documented that requirement. The rest of the +// examples assume you have already wrapped in a fiber 0 or more levels up +// in your code such as a command bus executer or your HTTP server. +async(static function () { +{% if client.configuration.entryPoints.call == true %} + // Make API calls using the call method + $client->call('METHOD /path/to/{the}/operation', ['array' => 'with', 'paramters' => 'for', 'the' => 'operation']); +{% endif %} +{% if client.configuration.entryPoints.operations == true %} + // Make API calls using the operations objects + $client->operations()->group()->operation(array: 'with', paramters: 'for', the: 'operation'); +{% endif %} +})(); +``` + +{% if client.configuration.entryPoints.call == true or client.configuration.entryPoints.operations == true %} +## Supported operations + +{% for operation in client.operations %} + +### {{ operation.operationId }} + +{{ operation.summary }} + +{% if client.configuration.entryPoints.call == true %} +Using the `call` method: +```php +$client->call('{{ operation.matchMethod }} {{ operation.path }}'{% if operation.parameters|length > 0 %}, [ +{% for parameter in operation.parameters %} '{{ parameter.targetName }}' => {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %}, +{% endfor %}]{% endif %}); +``` +{% endif %} + +{% if client.configuration.entryPoints.operations == true %} +Operations method: +```php +$client->operations()->{{ operation.groupCamel }}()->{{ operation.nameCamel }}({% if operation.parameters|length > 0 %} +{% for parameter in operation.parameters %} {{ parameter.targetName }}: {% if parameter.type == 'string' %}'{% endif %}{{ parameter.example.raw }}{% if parameter.type == 'string' %}'{% endif %}, +{% endfor %}{% endif %}); +``` +{% endif %} + +{% if operation.externalDocs != null %} +You can find more about this operation over at the [{{ operation.externalDocs.description }}]({{ operation.externalDocs.url }}). +{% endif %} + +{% endfor %} +{% endif %} + diff --git a/etc/config.subsplit-publish.json b/etc/config.subsplit-publish.json index 4e7784f7583..02c36a84ec0 100644 --- a/etc/config.subsplit-publish.json +++ b/etc/config.subsplit-publish.json @@ -30,6 +30,24 @@ "target": "git@github.com:php-api-clients/github-enterprise.git", "target-branch": "v0.1.3.12.x" }, + { + "name": "github-enterprise", + "directory": "clients/GitHubEnterprise-3.13", + "target": "git@github.com:php-api-clients/github-enterprise.git", + "target-branch": "v0.1.3.13.x" + }, + { + "name": "github-enterprise", + "directory": "clients/GitHubEnterprise-3.14", + "target": "git@github.com:php-api-clients/github-enterprise.git", + "target-branch": "v0.1.3.14.x" + }, + { + "name": "github-enterprise", + "directory": "clients/GitHubEnterprise-3.15", + "target": "git@github.com:php-api-clients/github-enterprise.git", + "target-branch": "v0.1.3.15.x" + }, { "name": "github-enterprise", "directory": "clients/GitHubEnterprise-3.2", diff --git a/etc/specs/GitHubEnterprise-3.13/current.spec.yaml b/etc/specs/GitHubEnterprise-3.13/current.spec.yaml new file mode 100644 index 00000000000..d9e14a00003 --- /dev/null +++ b/etc/specs/GitHubEnterprise-3.13/current.spec.yaml @@ -0,0 +1,216200 @@ +--- +openapi: 3.1.0 +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: ghes + x-github-release: 3.13 +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 GitHub Orgs. +- name: packages + description: Manage packages for authenticated users and organizations. +- name: projects + description: Interact with GitHub Projects. +- 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: Look for stuff 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: scim + description: Provisioning of GitHub organization membership for SCIM-enabled providers. +- name: enterprise-admin + description: Enterprise Administration +- name: oauth-authorizations + description: OAuth Authorizations API +- name: security-advisories + description: Manage security advisories. +servers: +- url: "{protocol}://{hostname}/api/v3" + variables: + hostname: + description: Self-hosted Enterprise Server hostname + default: HOSTNAME + protocol: + description: Self-hosted Enterprise Server protocol + default: http +externalDocs: + description: GitHub Enterprise Developer Docs + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/rest/meta/meta#github-api-root + "/admin/hooks": + get: + summary: List global webhooks + description: '' + operationId: enterprise-admin/list-global-webhooks + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#list-global-webhooks + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + post: + summary: Create a global webhook + description: '' + operationId: enterprise-admin/create-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#create-a-global-webhook + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook" + 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: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: 'The [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) + that trigger this webhook. A global webhook can be triggered by + `user` and `organization` events. Default: `user` and `organization`.' + 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 + events: + - organization + - user + config: + url: https://example.com/webhook + content_type: json + secret: secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/hooks/{hook_id}": + get: + summary: Get a global webhook + description: '' + operationId: enterprise-admin/get-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#get-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + patch: + summary: Update a global webhook + description: Parameters that are not provided will be overwritten with the default + value or removed if no default exists. + operationId: enterprise-admin/update-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#update-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook-2" + examples: + default: + "$ref": "#/components/examples/global-hook-2" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: 'The [events](https://docs.github.com/enterprise-server@3.13/webhooks/event-payloads) + that trigger this webhook. A global webhook can be triggered by + `user` and `organization` events. Default: `user` and `organization`.' + 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: + events: + - organization + config: + url: https://example.com/webhook + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + delete: + summary: Delete a global webhook + description: '' + operationId: enterprise-admin/delete-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#delete-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/hooks/{hook_id}/pings": + post: + summary: Ping a global webhook + description: This will trigger a [ping event](https://docs.github.com/enterprise-server@3.13/webhooks/#ping-event) + to be sent to the webhook. + operationId: enterprise-admin/ping-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/global-webhooks#ping-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/keys": + get: + summary: List public keys + description: '' + operationId: enterprise-admin/list-public-keys + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#list-public-keys + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/public-key-full" + examples: + default: + "$ref": "#/components/examples/enterprise-public-key-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/keys/{key_ids}": + delete: + summary: Delete a public key + description: '' + operationId: enterprise-admin/delete-public-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-a-public-key + parameters: + - "$ref": "#/components/parameters/key-ids" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/ldap/teams/{team_id}/mapping": + patch: + summary: Update LDAP mapping for a team + description: Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) + (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) + must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.13/rest/teams/teams/#create-a-team) + endpoint to create a team with LDAP mapping. + operationId: enterprise-admin/update-ldap-mapping-for-team + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team + parameters: + - "$ref": "#/components/parameters/team-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ldap-mapping-team" + examples: + default: + "$ref": "#/components/examples/ldap-mapping-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + 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. + required: + - ldap_dn + examples: + default: + value: + ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/teams/{team_id}/sync": + post: + summary: Sync LDAP mapping for a team + description: Note that this API call does not automatically initiate an LDAP + sync. Rather, if a `201` is returned, the sync job is queued successfully, + and is performed when the instance is ready. + operationId: enterprise-admin/sync-ldap-mapping-for-team + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team + parameters: + - "$ref": "#/components/parameters/team-id" + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: + status: + type: string + examples: + default: + value: + status: queued + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/users/{username}/mapping": + patch: + summary: Update LDAP mapping for a user + description: '' + operationId: enterprise-admin/update-ldap-mapping-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ldap-mapping-user" + examples: + default: + "$ref": "#/components/examples/ldap-mapping-user" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + 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. + required: + - ldap_dn + examples: + default: + value: + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/users/{username}/sync": + post: + summary: Sync LDAP mapping for a user + description: Note that this API call does not automatically initiate an LDAP + sync. Rather, if a `201` is returned, the sync job is queued successfully, + and is performed when the instance is ready. + operationId: enterprise-admin/sync-ldap-mapping-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: + status: + type: string + examples: + default: + value: + status: queued + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/organizations": + post: + summary: Create an organization + description: '' + operationId: enterprise-admin/create-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/orgs#create-an-organization + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The organization's username. + admin: + type: string + description: The login of the user who will manage this organization. + profile_name: + type: string + description: The organization's display name. + required: + - login + - admin + examples: + default: + value: + login: github + profile_name: GitHub, Inc. + admin: monalisaoctocat + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: orgs + "/admin/organizations/{org}": + patch: + summary: Update an organization name + description: '' + operationId: enterprise-admin/update-org-name + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/orgs#update-an-organization-name + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Job queued to rename organization. It may take a few + minutes to complete. + url: https:///api/v3/organizations/1 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The organization's new name. + required: + - login + examples: + default: + value: + login: the-new-octocats + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: orgs + "/admin/pre-receive-environments": + get: + summary: List pre-receive environments + description: '' + operationId: enterprise-admin/list-pre-receive-environments + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + post: + summary: Create a pre-receive environment + description: '' + operationId: enterprise-admin/create-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The new pre-receive environment's name. + image_url: + type: string + description: URL from which to download a tarball of this environment. + required: + - name + - image_url + examples: + default: + value: + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}": + get: + summary: Get a pre-receive environment + description: '' + operationId: enterprise-admin/get-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + patch: + summary: Update a pre-receive environment + description: You cannot modify the default environment. If you attempt to modify + the default environment, you will receive a `422 Unprocessable Entity` response. + operationId: enterprise-admin/update-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default-response: + "$ref": "#/components/examples/pre-receive-environment-default-response" + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Cannot modify or delete the default environment + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: This pre-receive environment's new name. + image_url: + type: string + description: URL from which to download a tarball of this environment. + examples: + default: + value: + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + delete: + summary: Delete a pre-receive environment + description: |- + If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. + + The possible error messages are: + + * _Cannot modify or delete the default environment_ + * _Cannot delete environment that has hooks_ + * _Cannot delete environment when download is in progress_ + operationId: enterprise-admin/delete-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '204': + description: Response + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Cannot modify or delete the default environment + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": + post: + summary: Start a pre-receive environment download + description: |- + Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. + + If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + + The possible error messages are: + + * _Cannot modify or delete the default environment_ + * _Can not start a new download when a download is in progress_ + operationId: enterprise-admin/start-pre-receive-environment-download + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment-download-status" + examples: + default-response: + "$ref": "#/components/examples/pre-receive-environment-download-status-default-response" + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Can not start a new download when a download is in + progress + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": + get: + summary: Get the download status for a pre-receive environment + description: In addition to seeing the download status at the "[Get a pre-receive + environment](#get-a-pre-receive-environment)" endpoint, there is also this + separate endpoint for just the download status. + operationId: enterprise-admin/get-download-status-for-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment-download-status" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment-download-status" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-hooks": + get: + summary: List pre-receive hooks + description: '' + operationId: enterprise-admin/list-pre-receive-hooks + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + post: + summary: Create a pre-receive hook + description: '' + operationId: enterprise-admin/create-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the hook. + script: + type: string + description: The script that the hook runs. + script_repository: + type: object + description: The GitHub repository where the script is kept. + properties: {} + additionalProperties: true + environment: + type: object + description: The pre-receive environment where the script is executed. + properties: {} + additionalProperties: true + enforcement: + type: string + description: 'The state of enforcement for this hook. default: `disabled`' + allow_downstream_configuration: + type: boolean + description: 'Whether enforcement can be overridden at the org or + repo level. default: `false`' + required: + - name + - script + - script_repository + - environment + examples: + default: + value: + name: Check Commits + script: scripts/commit_check.sh + enforcement: disabled + allow_downstream_configuration: false + script_repository: + full_name: DevIT/hooks + environment: + id: 2 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + "/admin/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook + description: '' + operationId: enterprise-admin/get-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + patch: + summary: Update a pre-receive hook + description: '' + operationId: enterprise-admin/update-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the hook. + script: + type: string + description: The script that the hook runs. + script_repository: + type: object + description: The GitHub repository where the script is kept. + properties: {} + additionalProperties: true + environment: + type: object + description: The pre-receive environment where the script is executed. + properties: {} + additionalProperties: true + enforcement: + type: string + description: The state of enforcement for this hook. + allow_downstream_configuration: + type: boolean + description: Whether enforcement can be overridden at the org or + repo level. + examples: + default: + value: + name: Check Commits + environment: + id: 1 + allow_downstream_configuration: true + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + delete: + summary: Delete a pre-receive hook + description: '' + operationId: enterprise-admin/delete-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + "/admin/tokens": + get: + summary: List personal access tokens + description: Lists personal access tokens for all users, including admin users. + operationId: enterprise-admin/list-personal-access-tokens + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#list-personal-access-tokens + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/classic-personal-access-tokens" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/tokens/{token_id}": + delete: + summary: Delete a personal access token + description: Deletes a personal access token. Returns a `403 - Forbidden` status + when a personal access token is in use. For example, if you access this endpoint + with the same personal access token that you are trying to delete, you will + receive this error. + operationId: enterprise-admin/delete-personal-access-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-a-personal-access-token + parameters: + - "$ref": "#/components/parameters/token-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users": + post: + summary: Create a user + description: |- + If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + + The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. + + If the login name or email address is already associated with an account, the server will return a `422` response. + operationId: enterprise-admin/create-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#create-a-user + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The user's username. + email: + type: string + description: |- + **Required for built-in authentication.** The user's email + address. This parameter can be omitted when using CAS, LDAP, or SAML. + For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." + suspended: + type: boolean + description: Whether to set the user as suspended when the user + is created. + default: false + required: + - login + examples: + default: + value: + login: monalisa + email: octocat@github.com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users/{username}": + patch: + summary: Update the username for a user + description: '' + operationId: enterprise-admin/update-username-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#update-the-username-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Job queued to rename user. It may take a few minutes + to complete. + url: https://api.github.com/user/1 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The user's new username. + required: + - login + examples: + default: + value: + login: thenewmonalisa + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Delete a user + description: |- + Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#suspend-a-user) is often a better option. + + You can delete any user account except your own. + operationId: enterprise-admin/delete-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users/{username}/authorizations": + post: + summary: Create an impersonation OAuth token + description: '' + operationId: enterprise-admin/create-impersonation-o-auth-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#create-an-impersonation-oauth-token + parameters: + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Response when creating a new impersonation OAuth token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + '200': + description: Response when getting an existing impersonation OAuth token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scopes: + type: array + description: A list of [scopes](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + items: + type: string + required: + - scopes + examples: + default: + value: + scopes: + - public_repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Delete an impersonation OAuth token + description: '' + operationId: enterprise-admin/delete-impersonation-o-auth-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#delete-an-impersonation-oauth-token + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + 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)." + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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)." + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/rest/apps/webhooks#list-deliveries-for-an-app-webhook + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/cursor" + 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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 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/enterprise-server@3.13/rest/apps/apps#suspend-an-app-installation)" endpoint. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - rails + repository_ids: + description: List of repository IDs that the token should have access + to + type: array + items: + type: integer + examples: + - 1 + 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 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 Enterprise Server API or webhook events is blocked for that account. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/grants": + get: + summary: List your grants + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-grants + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/application-grant" + examples: + default: + "$ref": "#/components/examples/application-grant-items" + 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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/applications/grants/{grant_id}": + get: + summary: Get a single grant + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-grant + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant + parameters: + - "$ref": "#/components/parameters/grant-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/application-grant" + examples: + default: + "$ref": "#/components/examples/application-grant" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + delete: + summary: Delete a grant + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-grant + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#delete-a-grant + parameters: + - "$ref": "#/components/parameters/grant-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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + examples: + - 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 + examples: + - octocat + target_id: + description: The ID of the user or organization to scope the user + access token to. **Required** unless `target` is specified. + type: integer + examples: + - 1 + 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 + examples: + - 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. + type: array + items: + type: integer + examples: + - 1 + 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] + > 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/enterprise-server@3.13/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 + "/authorizations": + get: + summary: List your authorizations + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-items" + 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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + post: + summary: Create a new authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.13/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + + To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + + You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.13/articles/creating-an-access-token-for-command-line-use). + + Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.13/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. + tags: + - oauth-authorizations + operationId: oauth-authorizations/create-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + client_id: + description: The OAuth app client key for which to create the token. + maxLength: 20 + type: string + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + examples: + default: + summary: Create an authorization + value: + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + client_id: abcde12345fghij67890 + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + '410': + "$ref": "#/components/responses/gone" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/clients/{client_id}": + put: + summary: Get-or-create an authorization for a specific app + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app + parameters: + - "$ref": "#/components/parameters/oauth-client-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + required: + - client_secret + type: object + examples: + default: + summary: Create an authorization for an app + value: + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + responses: + '200': + description: if returning an existing token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + response-if-returning-an-existing-token: + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token-2" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '201': + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/clients/{client_id}/{fingerprint}": + put: + summary: Get-or-create an authorization for a specific app and fingerprint + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + parameters: + - "$ref": "#/components/parameters/oauth-client-id" + - name: fingerprint + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + properties: + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + required: + - client_secret + type: object + examples: + default: + summary: Create an authorization for an app and fingerprint + value: + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + responses: + '200': + description: if returning an existing token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + response-if-returning-an-existing-token: + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '201': + description: Response if returning a new token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-3" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/{authorization_id}": + get: + summary: Get a single authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization + parameters: + - "$ref": "#/components/parameters/authorization-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-2" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + patch: + summary: Update an existing authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.13/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + + You can only send one of these scope keys at a time. + tags: + - oauth-authorizations + operationId: oauth-authorizations/update-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization + parameters: + - "$ref": "#/components/parameters/authorization-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + add_scopes: + description: A list of scopes to add to this authorization. + type: array + items: + type: string + remove_scopes: + description: A list of scopes to remove from this authorization. + type: array + items: + type: string + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + examples: + default: + summary: Example of updating scopes and note + value: + add_scopes: + - public_repo + remove_scopes: + - user + note: optional note + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-2" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + delete: + summary: Delete an authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.13/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization + parameters: + - "$ref": "#/components/parameters/authorization-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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + "/emojis": + get: + summary: Get emojis + description: Lists all the emojis available to use on GitHub Enterprise Server. + operationId: emojis/get + tags: + - emojis + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + "/enterprise/announcement": + get: + summary: Get the global announcement banner + description: Gets the current message and expiration date of the global announcement + banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/get-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/announcement#get-the-global-announcement-banner + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + patch: + summary: Set the global announcement banner + description: Sets the message and expiration time for the global announcement + banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/set-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/announcement#set-the-global-announcement-banner + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + value: + announcement: Very **important** announcement about _something_. + expires_at: '2021-01-01T00:00:00.000+00:00' + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + delete: + summary: Remove the global announcement banner + description: Removes the global announcement banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/announcement#remove-the-global-announcement-banner + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + "/enterprise/settings/license": + get: + summary: Get license information + description: '' + operationId: enterprise-admin/get-license-information + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/license#get-license-information + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/license-info" + examples: + default: + "$ref": "#/components/examples/license-info" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: license + "/enterprise/stats/all": + get: + summary: Get all statistics + description: '' + operationId: enterprise-admin/get-all-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-all-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-overview" + examples: + default: + "$ref": "#/components/examples/enterprise-overview" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/comments": + get: + summary: Get comment statistics + description: '' + operationId: enterprise-admin/get-comment-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-comment-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-comment-overview" + examples: + default: + value: + total_commit_comments: 5000 + total_gist_comments: 400 + total_issue_comments: 10900 + total_pull_request_comments: 9900 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/gists": + get: + summary: Get gist statistics + description: '' + operationId: enterprise-admin/get-gist-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-gist-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-gist-overview" + examples: + default: + value: + total_gists: 500 + private_gists: 30 + public_gists: 470 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/hooks": + get: + summary: Get hooks statistics + operationId: enterprise-admin/get-hooks-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-hooks-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-hook-overview" + examples: + default: + value: + total_hooks: 50 + active_hooks: 47 + inactive_hooks: 3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/issues": + get: + summary: Get issue statistics + description: '' + operationId: enterprise-admin/get-issue-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-issue-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-issue-overview" + examples: + default: + value: + total_issues: 5000 + open_issues: 300 + closed_issues: 4700 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/milestones": + get: + summary: Get milestone statistics + description: '' + operationId: enterprise-admin/get-milestone-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-milestone-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-milestone-overview" + examples: + default: + value: + total_milestones: 90 + open_milestones: 10 + closed_milestones: 80 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/orgs": + get: + summary: Get organization statistics + description: '' + operationId: enterprise-admin/get-org-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-organization-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-organization-overview" + examples: + default: + value: + total_orgs: 50 + disabled_orgs: 1 + total_teams: 70 + total_team_members: 700 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/pages": + get: + summary: Get pages statistics + description: '' + operationId: enterprise-admin/get-pages-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-pages-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-page-overview" + examples: + default: + value: + total_pages: 20 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/pulls": + get: + summary: Get pull request statistics + description: '' + operationId: enterprise-admin/get-pull-request-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-pull-request-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-pull-request-overview" + examples: + default: + value: + total_pulls: 1200 + merged_pulls: 1100 + mergeable_pulls: 90 + unmergeable_pulls: 10 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/repos": + get: + summary: Get repository statistics + operationId: enterprise-admin/get-repo-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-repository-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-repository-overview" + examples: + default: + value: + total_repos: 200 + root_repos: 1 + fork_repos: 10 + org_repos: 150 + total_pushes: 39000 + total_wikis: 5 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/security-products": + get: + summary: Get security products statistics + description: |- + Gets the statistics about security products for a GitHub Enterprise Server instance. + + To use this endpoint, you must be a site admin. + operationId: enterprise-admin/get-security-products + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-security-products-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-security-products-overview" + examples: + default: + "$ref": "#/components/examples/enterprise-security-products-overview" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/users": + get: + summary: Get users statistics + description: '' + operationId: enterprise-admin/get-user-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/admin-stats#get-users-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-user-overview" + examples: + default: + value: + total_users: 100 + admin_users: 3 + suspended_users: 1 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprises/{enterprise}/actions/cache/usage": + get: + summary: Get GitHub Actions cache usage for an enterprise + description: |- + Gets the total GitHub Actions cache usage for an enterprise. + 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 `admin:enterprise` scope to use this endpoint. + operationId: actions/get-actions-cache-usage-for-enterprise + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/usage-policy": + get: + summary: Get GitHub Actions cache usage policy for an enterprise + description: |- + Gets the GitHub Actions cache usage policy for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-policy-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-usage-policy-enterprise" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + category: actions + subcategory: cache + patch: + summary: Set GitHub Actions cache usage policy for an enterprise + description: |- + Sets the GitHub Actions cache usage policy for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-usage-policy-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-usage-policy-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/permissions": + get: + summary: Get GitHub Actions permissions for an enterprise + description: |- + Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-enterprise-permissions" + examples: + default: + "$ref": "#/components/examples/actions-enterprise-permissions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set GitHub Actions permissions for an enterprise + description: |- + Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + required: + - enabled_organizations + examples: + default: + value: + enabled_organizations: all + allowed_actions: selected + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/organizations": + get: + summary: List selected organizations enabled for GitHub Actions in an enterprise + description: |- + Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + organizations: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + required: + - total_count + - organizations + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set selected organizations enabled for GitHub Actions in an enterprise + description: |- + Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + examples: + default: + value: + selected_organization_ids: + - 32 + - 91 + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": + put: + summary: Enable a selected organization for GitHub Actions in an enterprise + description: |- + Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + delete: + summary: Disable a selected organization for GitHub Actions in an enterprise + description: |- + Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for an enterprise + description: |- + Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set allowed actions for an enterprise + description: |- + Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/workflow": + get: + summary: Get default workflow permissions for an enterprise + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, + as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success 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: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set default workflow permissions for an enterprise + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets + whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + responses: + '204': + description: Success response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an enterprise + description: |- + Lists all self-hosted runner groups for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runner-groups-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/visible-to-organization" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runner_groups: + type: array + items: + "$ref": "#/components/schemas/runner-groups-enterprise" + required: + - total_count + - runner_groups + examples: + default: + "$ref": "#/components/examples/runner-groups-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + post: + summary: Create a self-hosted runner group for an enterprise + description: |- + Creates a new self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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 organizations + or select individual organization. + type: string + enum: + - selected + - all + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_organization_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an enterprise + description: |- + Gets a specific self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + patch: + summary: Update a self-hosted runner group for an enterprise + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/update-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: false + 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 organizations + or select individual organizations. + type: string + enum: + - selected + - all + default: all + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-update-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Delete a self-hosted runner group from an enterprise + description: |- + Deletes a self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": + get: + summary: List organization access to a self-hosted runner group in an enterprise + description: |- + Lists the organizations with access to a self-hosted runner group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + properties: + total_count: + type: number + organizations: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + required: + - total_count + - organizations + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set organization access for a self-hosted runner group in an enterprise + description: |- + Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + examples: + default: + value: + selected_organization_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": + put: + summary: Add organization access to a self-hosted runner group in an enterprise + description: |- + Adds an organization to the list of selected organizations 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 enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove organization access to a self-hosted runner group in an enterprise + description: |- + Removes an organization from the list of selected organizations 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 enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an enterprise + description: |- + Lists the self-hosted runners that are in a specific enterprise group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + required: + - total_count + - runners + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set self-hosted runners in a group for an enterprise + description: |- + Replaces the list of self-hosted runners that are part of an enterprise runner group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an enterprise + description: |- + Adds a self-hosted runner to a runner group configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-self-hosted-runner-to-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove a self-hosted runner from a group for an enterprise + description: |- + Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runners": + get: + summary: List self-hosted runners for an enterprise + description: |- + Lists all self-hosted runners configured for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + 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: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/downloads": + get: + summary: List runner applications for an enterprise + description: |- + Lists binaries for the runner application that you can download and run. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-runner-applications-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/runner-application" + examples: + default: + "$ref": "#/components/examples/runner-application-items-airgap" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/generate-jitconfig": + post: + summary: Create configuration for a just-in-time runner for an Enterprise + description: |- + Generates a configuration that can be passed to the runner application at startup. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/registration-token": + post: + summary: Create a registration token for an enterprise + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + 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/enterprises/octo-enterprise --token TOKEN + ``` + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-registration-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authentication-token" + examples: + default: + "$ref": "#/components/examples/authentication-token" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/remove-token": + post: + summary: Create a remove token for an enterprise + description: |- + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + + Example using remove token: + + To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + endpoint. + + ``` + ./config.sh remove --token TOKEN + ``` + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-remove-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authentication-token" + examples: + default: + "$ref": "#/components/examples/authentication-token-2" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}": + get: + summary: Get a self-hosted runner for an enterprise + description: |- + Gets a specific self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + delete: + summary: Delete a self-hosted runner from an enterprise + description: |- + Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": + get: + summary: List labels for a self-hosted runner for an enterprise + description: |- + Lists all labels for a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '200': + "$ref": "#/components/responses/actions_runner_labels" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + post: + summary: Add custom labels to a self-hosted runner for an enterprise + description: |- + Add custom labels to a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + put: + summary: Set custom labels for a self-hosted runner for an enterprise + description: |- + Remove all previous custom labels and set the new custom labels for a specific + self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + delete: + summary: Remove all custom labels from a self-hosted runner for an enterprise + description: |- + Remove all custom labels from a self-hosted runner configured in an + enterprise. Returns the remaining read-only labels from the runner. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '200': + "$ref": "#/components/responses/actions_runner_labels_readonly" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": + delete: + summary: Remove a custom label from a self-hosted runner for an enterprise + description: |- + Remove a custom label from a self-hosted runner configured + in an enterprise. 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. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/audit-log": + get: + summary: Get the audit log for an enterprise + operationId: enterprise-admin/get-audit-log + description: |- + Gets the audit log for an enterprise. + + The authenticated user must be an enterprise admin to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/audit-log-enterprise-phrase" + - "$ref": "#/components/parameters/audit-log-include" + - "$ref": "#/components/parameters/audit-log-after" + - "$ref": "#/components/parameters/audit-log-before" + - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/audit-log-event" + examples: + default: + "$ref": "#/components/examples/audit-log" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: audit-log + "/enterprises/{enterprise}/code-scanning/alerts": + get: + summary: List code scanning alerts for an enterprise + description: |- + Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + The authenticated user must be a member of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + 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: true + enabledForGitHubApps: false + previews: [] + category: code-scanning + subcategory: code-scanning + "/enterprises/{enterprise}/code_security_and_analysis": + get: + summary: Get code security and analysis features for an enterprise + description: |- + Gets code security and analysis settings for the specified 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: + - enterprise-admin + operationId: secret-scanning/get-security-analysis-settings-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-security-analysis-settings" + examples: + default: + "$ref": "#/components/examples/enterprise-security-analysis-settings" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + patch: + summary: Update code security and analysis features for an enterprise + description: |- + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. + + The authenticated user must be an administrator of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: secret-scanning/patch-security-analysis-settings-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + advanced_security_enabled_for_new_repositories: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled + for new repositories. For more information, see "[About GitHub + Advanced Security](https://docs.github.com/enterprise-server@3.13/get-started/learning-about-github/about-github-advanced-security)." + advanced_security_enabled_new_user_namespace_repos: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled + for new user namespace repositories. For more information, see + "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.13/get-started/learning-about-github/about-github-advanced-security)." + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: Whether Dependabot alerts are automatically enabled + for new repositories. For more information, see "[About Dependabot + alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + secret_scanning_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning is automatically enabled for + new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning push protection is automatically + enabled for new repositories. For more information, see "[Protecting + pushes with secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: |- + The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + To disable this functionality, set this field to `null`. + examples: + default: + value: + advanced_security_enabled_for_new_repositories: true + advanced_security_enabled_new_user_namespace_repos: true + dependabot_alerts_enabled_for_new_repositories: true + secret_scanning_enabled_for_new_repositories: true + secret_scanning_push_protection_enabled_for_new_repositories: true + secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md + 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 + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + "/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + - "$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}/secret-scanning/alerts": + get: + summary: List secret scanning alerts for an enterprise + description: |- + 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/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/secret-scanning-alert-state" + - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" + 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: false + category: secret-scanning + subcategory: secret-scanning + "/enterprises/{enterprise}/settings/billing/advanced-security": + get: + summary: Get GitHub Advanced Security active committers for an enterprise + description: |- + Gets the GitHub Advanced Security active committers for an enterprise per repository. + + Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository. + + The total number of repositories with committer information is tracked by the `total_count` field. + tags: + - billing + operationId: billing/get-github-advanced-security-billing-ghe + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/advanced-security-active-committers" + examples: + default: + "$ref": "#/components/examples/advanced-security-active-committers" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: billing + "/enterprises/{enterprise}/{security_product}/{enablement}": + post: + summary: Enable or disable a security feature + description: |- + Enables or disables the specified security feature for all repositories in an enterprise. + + The authenticated user must be an administrator of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: secret-scanning/post-security-product-enablement-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-security-product" + - "$ref": "#/components/parameters/enterprise-security-product-enablement" + 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 + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + "/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/enterprise-server@3.13/rest/activity/events#list-public-events + parameters: + - "$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-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. + + * **Timeline**: The GitHub Enterprise Server global public timeline + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.13/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 Enterprise Server. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/rest/gists/gists#create-a-gist + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: Description of the gist + type: string + examples: + - Example Ruby script + files: + description: Names and content for the files that make up the gist + type: object + additionalProperties: + type: object + properties: + content: + description: Content of the file + readOnly: false + type: string + required: + - content + examples: + - hello.rb: + content: puts "Hello, World!" + public: + oneOf: + - description: Flag indicating whether the gist is public + type: boolean + default: false + examples: + - true + - type: string + default: 'false' + enum: + - 'true' + - 'false' + examples: + - 'true' + 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. + + Note: With [pagination](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/update + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + type: string + examples: + - Example Ruby script + 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`. + type: object + additionalProperties: + type: + - object + - 'null' + properties: + content: + description: The new content of the file. + type: string + filename: + description: The new filename for the file. + type: + - string + - 'null' + examples: + - hello.rb: + content: blah + filename: goodbye.rb + type: + - object + - 'null' + 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: + "$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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + examples: + - 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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + examples: + - 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get-revision + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: + "$ref": "#/components/schemas/repository" + repository_selection: + type: string + examples: + - 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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + "/manage/v1/access/ssh": + get: + summary: Get the configured SSH keys + description: Gets the configured SSH keys on all available nodes. For more information, + see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/get-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-ssh" + examples: + default: + "$ref": "#/components/examples/ghes-get-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Set a new SSH key + description: Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise + Server instance. This will grant access via SSH to your instance. For more + information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/set-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-ssh-request" + examples: + default: + value: + key: ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw== + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-ssh-response" + examples: + default: + "$ref": "#/components/examples/ghes-set-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + delete: + summary: Delete a SSH key + description: Deletes a SSH key from the `authorized_keys` file for your GitHub + Enterprise Server instance. This will remove access via SSH to your instance. + For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.13/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/delete-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#delete-a-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-delete-ssh-request" + examples: + default: + value: + key: ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw== + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-delete-ssh-response" + examples: + default: + "$ref": "#/components/examples/ghes-delete-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/checks/system-requirements": + get: + summary: Get the system requirement check results for configured cluster nodes + description: |- + Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-checks-system-requirements + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-checks-system-requirements" + examples: + default: + "$ref": "#/components/examples/ghes-checks-system-requirements" + '400': + description: Bad request + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/cluster/status": + get: + summary: Get the status of services running on all cluster nodes + description: |- + Gets the status of all services running on each cluster node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-cluster-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-cluster-status" + examples: + default: + "$ref": "#/components/examples/ghes-cluster-status" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/apply": + get: + summary: Get the status of a ghe-config-apply run + description: Displays the current status of `ghe-config-apply` in the environment + or the status of a historical run by ID. + operationId: enterprise-admin/get-manage-config-apply-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run + parameters: + - name: run_id + description: The unique run ID of the `ghe-config-apply` run. + in: query + required: false + schema: + type: string + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + running: + type: boolean + description: Whether the ghe-config-apply run is still running + in the environment + successful: + type: boolean + description: Whether the ghe-config-apply run was successful in + the environment + nodes: + type: array + items: + type: object + properties: + run_id: + type: string + description: The unique Run ID of the ghe-config-apply run + on the host + hostname: + type: string + description: The hostname of the node + running: + type: boolean + description: Whether the ghe-config-apply run is still running + on the host + successful: + type: boolean + description: Whether the ghe-config-apply run was successful + on the host + examples: + default: + value: + running: true + successful: false + nodes: + - run_id: d34db33f + hostname: ghes-01.lan + running: true + successful: false + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Trigger a ghe-config-apply run + description: |- + Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + You can provide a run ID or allow one to be generated randomly. + operationId: enterprise-admin/post-manage-run-config-apply + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + description: The run ID to execute `ghe-config-apply` with. If not + provided, a run ID will be generated randomly. + examples: + default: + value: + run_id: d34db33f + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + description: Run ID the job was launched with + examples: + default: + value: + run_id: d34db33f + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/apply/events": + get: + summary: List events from ghe-config-apply + description: Lists events from an in-process `ghe-config-apply` run on your + Github Enterprise Server instance. + operationId: enterprise-admin/get-manage-config-apply-events + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply + parameters: + - name: last_request_id + description: The unique ID of the last response from a host, used for pagination. + in: query + required: false + schema: + type: string + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + nodes: + type: array + items: + type: object + properties: + node: + type: string + description: Hostname of the node + last_request_id: + type: string + description: Unique ID of the last response from a host + used for pagination + events: + type: array + items: + type: object + properties: + timestamp: + type: string + severity_text: + type: string + body: + type: string + event_name: + type: string + topology: + type: string + hostname: + type: string + config_run_id: + type: string + trace_id: + type: string + span_id: + type: string + span_parent_id: + type: string + span_depth: + type: integer + examples: + default: + value: + nodes: + - node: ghes-01.lan + last_request_id: 387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000 + events: + - timestamp: '2023-01-01T13:00:00+00:00' + severity_text: INFO + body: Validating services + event_name: Enterprise::ConfigApply::PhaseValidation#config_phase_validation + topology: multinode + hostname: ghes-01.lan + config_run_id: d34db33f + trace_id: 387cd628c06d606700e79be368e5e574 + span_id: 0cde553750689c76 + span_parent_id: 0 + span_depth: 0 + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/init": + post: + summary: Initialize instance configuration with license and password + description: |- + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/initialize-instance-configuration + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + multipart/form-data: + schema: + "$ref": "#/components/schemas/ghes-config-init-request" + examples: + default: + value: + license: "@enterprise.ghl" + password: provide-password-here! + responses: + '202': + description: Response + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/license": + get: + summary: Get the enterprise license information + description: Gets information about the license that is currently set for the + enterprise. + operationId: enterprise-admin/license-info + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-license-info" + examples: + default: + "$ref": "#/components/examples/ghes-license-info" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + put: + summary: Upload an enterprise license + description: |- + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/license-upload + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/license-apply" + requestBody: + required: true + content: + multipart/form-data: + schema: + "$ref": "#/components/schemas/ghes-upload-license-request" + examples: + default: + value: + license: "@enterprise.ghl" + responses: + '201': + description: Created + '202': + description: Accepted + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/license/check": + get: + summary: Check a license + description: Check the status of the license that is currently set for the enterprise. + operationId: enterprise-admin/license-check + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#check-a-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-license-check" + examples: + default: + "$ref": "#/components/examples/ghes-license-check" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/nodes": + get: + summary: Get GHES node metadata for all nodes + description: Get node metadata for all configured nodes in the current cluster. + For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.13/admin/enterprise-management/configuring-clustering/about-clustering)." + operationId: enterprise-admin/get-config-nodes + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-config-nodes" + examples: + default: + "$ref": "#/components/examples/ghes-config-nodes" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/settings": + get: + summary: Get the GHES settings + description: Gets a list of settings for a GitHub Enterprise Server instance. + operationId: enterprise-admin/get-manage-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-ghes-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-settings" + examples: + default: + "$ref": "#/components/examples/ghes-get-settings" + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + put: + summary: Set settings + description: |- + Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-settings). + + **Notes:** + - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + operationId: enterprise-admin/set-manage-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#set-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + description: Only the settings parameters that should be modified need to + be specified. + content: + application/json: + schema: + type: object + examples: + default: + value: + public_pages: true + responses: + '204': + description: Response + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/maintenance": + get: + summary: Get the status of maintenance mode + description: Gets the status and details of maintenance mode on all available + nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + operationId: enterprise-admin/get-manage-maintenance + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-maintenance" + examples: + default: + "$ref": "#/components/examples/ghes-get-maintenance" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Set the status of maintenance mode + description: Sets or schedules the maintenance mode. For more information, see + "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + operationId: enterprise-admin/set-manage-maintenance + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-maintenance-request" + examples: + default: + value: + enabled: true + when: '2006-01-02T15:04:05+00:00' + ip_exception_list: + - 192.168.1.0/24 + - 1.1.1.1 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-maintenance-response" + examples: + default: + "$ref": "#/components/examples/ghes-set-maintenance" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/replication/status": + get: + summary: Get the status of services running on all replica nodes + description: |- + Gets the status of all services running on each replica node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-replication-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-replication-status" + examples: + default: + "$ref": "#/components/examples/ghes-replication-status" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/version": + get: + summary: Get all GHES release versions for all nodes + description: Gets the GitHub Enterprise Server release versions that are currently + installed on all available nodes. For more information, see "[GitHub Enterprise + Server releases](https://docs.github.com/enterprise-server@3.13/admin/all-releases)." + operationId: enterprise-admin/get-version + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-version" + examples: + default: + "$ref": "#/components/examples/ghes-version" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/markdown": + post: + summary: Render a Markdown document + description: '' + operationId: markdown/render + tags: + - markdown + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + type: string + examples: + - markdown + 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/enterprise-server@3.13/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 + "/meta": + get: + summary: Get GitHub Enterprise Server meta information + description: '' + tags: + - meta + operationId: meta/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise + Server: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-read + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 Enterprise + Server as done: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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**. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/{organization_id}/custom_roles": + get: + summary: Closing down - List custom repository roles in an organization + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be administrator of the organization or of a repository of the organization 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/list-custom-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization + parameters: + - name: organization_id + description: The unique identifier of the organization. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response - list of custom role names + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of custom roles in this organization + type: integer + examples: + - 3 + custom_roles: + type: array + items: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + removalDate: '2025-02-15' + deprecationDate: '2023-02-15' + category: orgs + subcategory: custom-roles + deprecated: true + "/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, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.13/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 Enterprise Server plan, GitHub Apps need the `Organization plan` permission. + tags: + - orgs + operationId: orgs/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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] + > **Closing down notice:** GitHub Enterprise Server 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). + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. \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_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 + examples: + - '"http://github.blog"' + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + 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/enterprise-server@3.13/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. + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + Whether Dependabot alerts 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/enterprise-server@3.13/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. + dependabot_security_updates_enabled_for_new_repositories: + type: boolean + description: |- + Whether Dependabot security updates 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/enterprise-server@3.13/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. + dependency_graph_enabled_for_new_repositories: + type: boolean + description: |- + 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/enterprise-server@3.13/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. + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + 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/enterprise-server@3.13/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. + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: |- + 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/enterprise-server@3.13/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. + 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. + 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 + 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/enterprise-server@3.13/site-policy/github-terms/github-terms-of-service + operationId: orgs/delete + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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. + 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/enterprise-server@3.13/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/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + "$ref": "#/components/schemas/oidc-custom-sub" + 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: + '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 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. + operationId: actions/get-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 in an organization. + + If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the 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/enterprise-server@3.13/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" + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: all + allowed_actions: selected + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + 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/enterprise-server@3.13/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)." + + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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 for an organization + description: |- + Gets the selected actions 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. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 for an organization + description: |- + Sets the actions 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)." + + If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the 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/enterprise-server@3.13/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/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + can submit approving pull request reviews. For more information, see + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/rest/actions/permissions#set-default-workflow-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Success response + '409': + description: Conflict response when changing a setting is prevented by the + owning enterprise + 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + 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. + + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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-airgap" + 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/enterprise-server@3.13/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" + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/rest/actions/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: + '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/enterprise-server@3.13/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` + 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/enterprise-server@3.13/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/actions/secrets#add-selected-repository-to-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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}/announcement": + get: + summary: Get announcement banner for organization + description: |- + Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the + organization level. Organization members may also see an enterprise-level announcement banner. To get an + announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + tags: + - orgs + operationId: announcement-banners/get-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/announcement-banners/organizations#get-announcement-banner-for-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement-banner" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + patch: + summary: Set announcement banner for organization + description: Sets the announcement banner to display for the organization. + tags: + - orgs + operationId: announcement-banners/set-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/announcement-banners/organizations#set-announcement-banner-for-organization + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement-banner" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + delete: + summary: Remove announcement banner from organization + description: Removes the announcement banner currently set for the organization. + tags: + - orgs + operationId: announcement-banners/remove-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/announcement-banners/organizations#remove-announcement-banner-from-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + "/orgs/{org}/audit-log": + get: + summary: Get the audit log for an organization + description: |- + Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + + By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.13/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + + Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api)." + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + operationId: orgs/get-audit-log + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/orgs#get-the-audit-log-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/audit-log-phrase" + - "$ref": "#/components/parameters/audit-log-include" + - "$ref": "#/components/parameters/audit-log-after" + - "$ref": "#/components/parameters/audit-log-before" + - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/audit-log-event" + examples: + default: + "$ref": "#/components/examples/audit-log" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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" + 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}/custom-repository-roles": + get: + summary: List custom repository roles in an organization + description: |- + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/list-custom-repo-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response - list of custom role names + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of custom roles in this organization + type: integer + examples: + - 3 + custom_roles: + type: array + items: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-list-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + post: + summary: Create a custom repository role + description: |- + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/create-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#create-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" + examples: + default: + value: + name: Labeler + description: A role for issue and pull request labelers + base_role: read + permissions: + - add_label + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/orgs/{org}/custom-repository-roles/{role_id}": + get: + summary: Get a custom repository role + description: |- + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/get-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#get-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + patch: + summary: Update a custom repository role + description: |- + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/update-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#update-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" + examples: + default: + value: + name: Labeler + description: A role for issue and PR labelers + base_role: read + permissions: + - add_label + - remove_label + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + delete: + summary: Delete a custom repository role + description: |- + Deletes a custom role from an organization. Once the custom role has been deleted, any + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/delete-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#delete-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/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/enterprise-server@3.13/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + - "$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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + 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: + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: 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/enterprise-server@3.13/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` + 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/enterprise-server@3.13/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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}/external-group/{group_id}": + get: + summary: Get an external group + description: |- + Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/external-idp-group-info-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#get-an-external-group + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/group-id" + - "$ref": "#/components/parameters/members-per-page" + - "$ref": "#/components/parameters/members-page" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-group" + examples: + default: + "$ref": "#/components/examples/external-group" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + "/orgs/{org}/external-groups": + get: + summary: List external groups in an organization + description: |- + Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/list-external-idp-groups-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#list-external-groups-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - name: page + description: Page token + in: query + schema: + type: integer + - name: display_name + description: Limits the list to groups containing the text in the group name + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-groups" + examples: + default: + "$ref": "#/components/examples/external-groups" + headers: + Link: + example: ; + rel="next" + schema: + type: string + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + "/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + examples: + - '"kdaigle"' + password: + type: string + examples: + - '"password"' + required: + - url + events: + type: array + description: Determines what [events](https://docs.github.com/enterprise-server@3.13/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 + `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/enterprise-server@3.13/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, + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - '"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. + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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" + 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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/enterprise-server@3.13/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. This options is only available for organization + owners. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 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/enterprise-server@3.13/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. + tags: + - orgs + operationId: orgs/remove-member + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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. + tags: + - orgs + operationId: orgs/remove-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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). + + 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/enterprise-server@3.13/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 + type: string + examples: + - repositories + 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. + + Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.13/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." + tags: + - migrations + operationId: migrations/start-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + description: Indicates whether repositories should be locked (to + prevent manipulation) while migrating data. + default: false + examples: + - true + 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 + description: Indicates whether attachments should be excluded from + the migration (to reduce migration archive file size). + default: false + examples: + - true + exclude_releases: + type: boolean + description: Indicates whether releases should be excluded from + the migration (to reduce migration archive file size). + default: false + examples: + - true + exclude_owner_projects: + type: boolean + description: Indicates whether projects owned by the organization + or users should be excluded. from the migration. + default: false + examples: + - true + org_metadata_only: + type: boolean + description: Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore other + flags). + default: false + examples: + - true + 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. + + 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/enterprise-server@3.13/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 + type: string + examples: + - repositories + 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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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" + 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. + + 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/enterprise-server@3.13/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 + - 'null' + description: Reason for approving or denying the requests. Max 1024 + characters. + maxLength: 1024 + 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. + + 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/enterprise-server@3.13/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 + - 'null' + description: Reason for approving or denying the request. Max 1024 + characters. + maxLength: 1024 + 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. + + 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/enterprise-server@3.13/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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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" + 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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-accesses + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-access + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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}/pre-receive-hooks": + get: + summary: List pre-receive hooks for an organization + description: List all pre-receive hooks that are enabled or testing for this + organization as well as any disabled hooks that can be configured at the organization + level. Globally disabled pre-receive hooks that do not allow downstream configuration + are not listed. + operationId: enterprise-admin/list-pre-receive-hooks-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook for an organization + description: '' + operationId: enterprise-admin/get-pre-receive-hook-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + patch: + summary: Update pre-receive hook enforcement for an organization + description: For pre-receive hooks which are allowed to be configured at the + org level, you can set `enforcement` and `allow_downstream_configuration` + operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + enforcement: + description: The state of enforcement for the hook on this repository. + type: string + allow_downstream_configuration: + description: Whether repositories can override enforcement. + type: boolean + examples: + default: + value: + enforcement: enabled + allow_downstream_configuration: false + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + delete: + summary: Remove pre-receive hook enforcement for an organization + description: Removes any overrides for this hook at the org level for this org. + operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + "/orgs/{org}/projects": + get: + summary: List organization projects + description: 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. + tags: + - projects + operationId: projects/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#list-organization-projects + parameters: + - "$ref": "#/components/parameters/org" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + post: + summary: Create an organization project + description: 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. + tags: + - projects + operationId: projects/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#create-an-organization-project + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the project. + body: + type: string + description: The description of the project. + required: + - name + examples: + default: + value: + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-2" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/get-all-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + 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/create-or-update-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/get-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + 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/create-or-update-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + 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/remove-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/list-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 Enterprise Server. The REST API + supports the same qualifiers as the web interface for GitHub Enterprise + Server. To learn more about the format of the query, see [Constructing a + search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-server@3.13/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. + 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/create-or-update-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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.) + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/rest/repos/repos#list-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + - name: type + description: Specifies the types of repositories you want returned. `internal` + is not yet supported when a GitHub App calls this endpoint with an installation + access token. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + - forks + - sources + - member + - internal + - 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. + + 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/enterprise-server@3.13/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. **Note**: For GitHub + Enterprise Server, this endpoint will only list repositories available + to all users on the enterprise. For more information, see \"[Creating + an internal repository](https://docs.github.com/enterprise-server@3.13/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" + in the GitHub Help documentation. \nThe `visibility` parameter + overrides the `private` parameter when you use both parameters + with the `nebula-preview` preview header." + enum: + - public + - private + - internal + 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 + examples: + - 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/enterprise-server@3.13/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 + "/orgs/{org}/repository-fine-grained-permissions": + get: + summary: List repository fine-grained permissions for an organization + description: |- + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/list-repo-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/repository-fine-grained-permission-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/repository-rule" + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + 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" + '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. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + **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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/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* + 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" + '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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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-resolution" + - "$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" + 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}/security-managers": + get: + summary: List security manager teams + description: |- + Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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: + - orgs + operationId: orgs/list-security-manager-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + "/orgs/{org}/security-managers/teams/{team_slug}": + put: + summary: Add a security manager team + description: |- + Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + + The authenticated user must be an administrator 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: + - orgs + operationId: orgs/add-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/orgs/security-managers#add-a-security-manager-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + '409': + description: The organization has reached the maximum number of security + manager teams. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + delete: + summary: Remove a security manager team + description: |- + 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/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + + 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/remove-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + "/orgs/{org}/settings/billing/advanced-security": + get: + summary: Get GitHub Advanced Security active committers for an organization + description: |- + Gets the GitHub Advanced Security active committers for an organization per repository. + + Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository. + + If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. + + The total number of repositories with committer information is tracked by the `total_count` field. + tags: + - billing + operationId: billing/get-github-advanced-security-billing-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/advanced-security-active-committers" + examples: + default: + "$ref": "#/components/examples/advanced-security-active-committers" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: billing + subcategory: billing + "/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/enterprise-server@3.13/rest/teams/teams#list-teams + 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/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 IDs 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. + 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. LDAP synchronization + must be enabled to map LDAP entries to a team. Use the "[Update + LDAP mapping for a team](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" + endpoint to change the LDAP DN. For more information, see "[Using + LDAP](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." + 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 + "/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 Enterprise Server 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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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 + - 'null' + description: The ID of a team to set as the parent team. + 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. + + 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/enterprise-server@3.13/rest/teams/teams#delete-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/orgs/{org}/teams/{team_slug}/discussions": + get: + summary: List discussions + description: |- + List all discussions on a team's page. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + post: + summary: Create a discussion + description: |- + Creates a new discussion post on a team's page. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + private: + type: boolean + description: Private posts are only visible to team members, organization + owners, and team maintainers. Public posts are visible to all + members of the organization. Set to `true` to create a private + post. + default: false + required: + - title + - body + examples: + default: + value: + title: Our first team post + body: Hi! This is an area for us to collaborate as a team. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": + get: + summary: Get a discussion + description: |- + Get a specific discussion on a team's page. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + patch: + summary: Update a discussion + description: |- + Edits the title and body text of a discussion post. Only the parameters you provide are updated. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + examples: + default: + value: + title: Welcome to our first team post + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + delete: + summary: Delete a discussion + description: |- + Delete a discussion from a team's page. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": + get: + summary: List discussion comments + description: |- + List all comments on a team discussion. + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussion-comments-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$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/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + post: + summary: Create a discussion comment + description: |- + Creates a new comment on a team discussion. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like apples? + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": + get: + summary: Get a discussion comment + description: |- + Get a specific comment on a team discussion. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + patch: + summary: Update a discussion comment + description: |- + Edits the body text of a discussion comment. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like pineapples? + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + delete: + summary: Delete a discussion comment + description: |- + Deletes a comment on a team discussion. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": + get: + summary: List reactions for a team discussion comment + description: |- + List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + post: + summary: Create reaction for a team discussion comment + description: |- + Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). + + 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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) + to add to the team discussion comment. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Response when the reaction type has already been added to this + team discussion comment + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": + delete: + summary: Delete team discussion comment reaction + description: |- + > [!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/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/delete-for-team-discussion-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-team-discussion-comment-reaction + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - "$ref": "#/components/parameters/reaction-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": + get: + summary: List reactions for a team discussion + description: |- + List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + post: + summary: Create reaction for a team discussion + description: |- + Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). + + 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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) + to add to the team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": + delete: + summary: Delete team discussion reaction + description: |- + > [!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/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/delete-for-team-discussion + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#delete-team-discussion-reaction + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/reaction-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/external-groups": + get: + summary: List a connection between an external group and a team + description: |- + Lists a connection between a team and an external group. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/list-linked-external-idp-groups-to-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-groups" + examples: + default: + "$ref": "#/components/examples/external-groups" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + patch: + summary: Update the connection between an external group and a team + description: |- + Creates a connection between a team and an external group. Only one external group can be linked to a team. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/link-external-idp-group-to-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + group_id: + type: integer + description: External Group Id + examples: + - 1 + required: + - group_id + examples: + default: + value: + group_id: 123 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-group" + examples: + default: + "$ref": "#/components/examples/external-group" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: teams + subcategory: external-groups + delete: + summary: Remove the connection between an external group and a team + description: |- + Deletes a connection between a team and an external group. + + You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - teams + operationId: teams/unlink-external-idp-group-from-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: teams + subcategory: external-groups + "/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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}/projects": + get: + summary: List team projects + description: |- + 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`. + tags: + - teams + operationId: teams/list-projects-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects + 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/team-project" + examples: + default: + "$ref": "#/components/examples/team-project-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": + get: + summary: Check team permissions for a project + description: |- + 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}`. + tags: + - teams + operationId: teams/check-permissions-for-project-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-project" + examples: + default: + "$ref": "#/components/examples/team-project" + '404': + description: Not Found if project is not managed by this team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + put: + summary: Add or update team project permissions + description: |- + 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}`. + tags: + - teams + operationId: teams/add-or-update-project-permissions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + permission: + type: string + description: 'The permission to grant to the team for this project. + Default: the team''s `permission` attribute will be used to determine + what permission to grant the team on this project. Note that, + if you choose not to pass any parameters, you''ll need to set + `Content-Length` to zero when calling this endpoint. For more + information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)."' + enum: + - read + - write + - admin + examples: + default: + summary: Updates the permissions for the team to write for the project + value: + permission: write + responses: + '204': + description: Response + '403': + description: Forbidden if the project is not owned by the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-the-project-is-not-owned-by-the-organization: + value: + message: Must have admin rights to Repository. + documentation_url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + delete: + summary: Remove a project from a team + description: |- + 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}`. + tags: + - teams + operationId: teams/remove-project-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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}`. + + > [!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/enterprise-server@3.13/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: |- + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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 + "/projects/columns/cards/{card_id}": + get: + summary: Get a project card + description: Gets information about a project card. + tags: + - projects + operationId: projects/get-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/cards#get-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '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: cards + patch: + summary: Update an existing project card + description: '' + tags: + - projects + operationId: projects/update-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/cards#update-an-existing-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + note: + description: The project card's note + type: + - string + - 'null' + examples: + - Update all gems + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + examples: + default: + summary: Change the note on the card + value: + note: Add payload for delete Project column + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + delete: + summary: Delete a project card + description: Deletes a project card + tags: + - projects + operationId: projects/delete-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/cards#delete-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + responses: + '204': + description: Response + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/cards/{card_id}/moves": + post: + summary: Move a project card + description: '' + tags: + - projects + operationId: projects/move-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/cards#move-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + position: + description: 'The position of the card in a column. Can be one of: + `top`, `bottom`, or `after:` to place after the specified + card.' + type: string + pattern: "^(?:top|bottom|after:\\d+)$" + examples: + - bottom + column_id: + description: The unique identifier of the column the card should + be moved to + type: integer + examples: + - 42 + required: + - position + type: object + examples: + default: + summary: Move the card to the bottom of the column + value: + column_id: 42 + position: bottom + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + default: + value: + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + resource: + type: string + field: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '503': + description: Response + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/{column_id}": + get: + summary: Get a project column + description: Gets information about a project column. + tags: + - projects + operationId: projects/get-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/columns#get-a-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + patch: + summary: Update an existing project column + description: '' + tags: + - projects + operationId: projects/update-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/columns#update-an-existing-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + required: + - name + type: object + examples: + default: + summary: Rename the project column + value: + name: To Do + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column" + '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: columns + delete: + summary: Delete a project column + description: Deletes a project column. + tags: + - projects + operationId: projects/delete-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/columns#delete-a-project-column + parameters: + - "$ref": "#/components/parameters/column-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: true + category: projects + subcategory: columns + "/projects/columns/{column_id}/cards": + get: + summary: List project cards + description: Lists the project cards in a project. + tags: + - projects + operationId: projects/list-cards + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/cards#list-project-cards + parameters: + - "$ref": "#/components/parameters/column-id" + - name: archived_state + description: Filters the project cards that are returned by the card's state. + in: query + required: false + schema: + type: string + enum: + - all + - archived + - not_archived + default: not_archived + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card-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: cards + post: + summary: Create a project card + description: '' + tags: + - projects + operationId: projects/create-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/cards#create-a-project-card + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + note: + description: The project card's note + type: + - string + - 'null' + examples: + - Update all gems + required: + - note + - type: object + properties: + content_id: + description: The unique identifier of the content associated with + the card + type: integer + examples: + - 42 + content_type: + description: The piece of content associated with the card + type: string + examples: + - PullRequest + required: + - content_id + - content_type + examples: + default: + summary: Create a new card + value: + note: Add payload for delete Project column + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + description: Validation failed + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/validation-error" + - "$ref": "#/components/schemas/validation-error-simple" + '503': + description: Response + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/{column_id}/moves": + post: + summary: Move a project column + description: '' + tags: + - projects + operationId: projects/move-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/columns#move-a-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + position: + description: 'The position of the column in a project. Can be one + of: `first`, `last`, or `after:` to place after the + specified column.' + type: string + pattern: "^(?:first|last|after:\\d+)$" + examples: + - last + required: + - position + type: object + examples: + default: + summary: Move the column to the end of the board + value: + position: last + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + default: + value: + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + "/projects/{project_id}": + get: + summary: Get a project + description: 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. + tags: + - projects + operationId: projects/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#get-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '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 + patch: + summary: Update a project + description: 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. + operationId: projects/update + tags: + - projects + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#update-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + properties: + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + state: + description: State of the project; either 'open' or 'closed' + type: string + examples: + - open + organization_permission: + description: The baseline permission that all organization members + have on this project + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. + type: boolean + type: object + examples: + default: + summary: Change the name, state, and permissions for a project + value: + name: Week One Sprint + state: open + organization_permission: write + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '404': + description: Not Found if the authenticated user does not have access to + the project + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + delete: + summary: Delete a project + description: Deletes a project board. Returns a `404 Not Found` status if projects + are disabled. + operationId: projects/delete + tags: + - projects + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#delete-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Delete Success + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/projects/{project_id}/collaborators": + get: + summary: List project collaborators + description: 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. + tags: + - projects + operationId: projects/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#list-project-collaborators + parameters: + - "$ref": "#/components/parameters/project-id" + - name: affiliation + description: Filters the collaborators by their affiliation. `outside` means + outside collaborators of a project that are not a member of the project's + organization. `direct` means collaborators with permissions to a project, + 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 + - "$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" + '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: projects + subcategory: collaborators + "/projects/{project_id}/collaborators/{username}": + put: + summary: Add project collaborator + description: 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. + tags: + - projects + operationId: projects/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#add-project-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + permission: + description: The permission to grant the collaborator. + enum: + - read + - write + - admin + default: write + type: string + examples: + - write + examples: + default: + summary: Applying write permissions for the new collaborator + value: + permission: write + 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: true + category: projects + subcategory: collaborators + delete: + summary: Remove user as a collaborator + description: Removes a collaborator from an organization project. You must be + an organization owner or a project `admin` to remove a collaborator. + tags: + - projects + operationId: projects/remove-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#remove-user-as-a-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$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" + '422': + "$ref": "#/components/responses/validation_failed" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: collaborators + "/projects/{project_id}/collaborators/{username}/permission": + get: + summary: Get project permission for a user + description: '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.' + tags: + - projects + operationId: projects/get-permission-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/collaborators#get-project-permission-for-a-user + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-collaborator-permission" + examples: + default: + "$ref": "#/components/examples/project-collaborator-permission" + '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: true + category: projects + subcategory: collaborators + "/projects/{project_id}/columns": + get: + summary: List project columns + description: Lists the project columns in a project. + tags: + - projects + operationId: projects/list-columns + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/columns#list-project-columns + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column-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: columns + post: + summary: Create a project column + description: Creates a new project column. + tags: + - projects + operationId: projects/create-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/columns#create-a-project-column + parameters: + - "$ref": "#/components/parameters/project-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + required: + - name + type: object + examples: + default: + value: + name: Remaining tasks + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + tags: + - repos + operationId: repos/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/rest/repos/repos#replace-all-repository-topics) + endpoint." + tags: + - repos + operationId: repos/update + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - internal + security_and_analysis: + type: + - object + - 'null' + 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/enterprise-server@3.13/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. + 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)." + 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`. + 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 + 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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + previews: + - required: false + name: nebula + note: |- + You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.13/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - required: false + name: baptiste + note: |- + The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.13/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + + ```shell + application/vnd.github.baptiste-preview+json + ``` + 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/repos/repos#delete-a-repository + '307': + "$ref": "#/components/responses/temporary_redirect" + '404': + "$ref": "#/components/responses/not_found" + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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/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/enterprise-server@3.13/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/cache/usage-policy": + get: + summary: Get GitHub Actions cache usage policy for a repository + description: |- + Gets GitHub Actions cache usage policy 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-usage-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/cache#get-github-actions-cache-usage-policy-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-policy-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-usage-policy" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + patch: + summary: Set GitHub Actions cache usage policy for a repository + description: |- + Sets GitHub Actions cache usage policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-usage-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-usage-policy" + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + '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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 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. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 in the repository. + + If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for 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/enterprise-server@3.13/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" + required: + - enabled + examples: + default: + value: + enabled: true + allowed_actions: selected + 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 internal and private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/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)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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/enterprise-server@3.13/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. + This endpoint only applies to internal and private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.13/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)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.13/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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/enterprise-server@3.13/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/selected-actions": + get: + summary: Get allowed actions for a repository + description: |- + Gets the settings for selected actions 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. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 for a repository + description: |- + Sets the actions 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)." + + If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + + 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/enterprise-server@3.13/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, + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 or enterprise + 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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-airgap" + 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/enterprise-server@3.13/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" + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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" + 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. + + 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/enterprise-server@3.13/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 + about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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`. + + 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/enterprise-server@3.13/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: + '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/enterprise-server@3.13/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/enterprise-server@3.13/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. + 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/enterprise-server@3.13/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: + '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 + about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + `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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + items: + type: integer + examples: + - 161171787 + examples: + - 161171787 + - 161171795 + state: + type: string + description: Whether to approve or reject deployment to the specified + environments. + enum: + - approved + - rejected + examples: + - approved + comment: + type: string + description: A comment to accompany the deployment review + examples: + - 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`. + + 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/enterprise-server@3.13/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + 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/enterprise-server@3.13/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + 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: + '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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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`. + + 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/enterprise-server@3.13/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`. + + 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/enterprise-server@3.13/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: 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 10. Any default properties + configured in the workflow file will be used when `inputs` are + omitted. + additionalProperties: true + maxProperties: 10 + 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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/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/enterprise-server@3.13/repositories/viewing-activity-and-data-for-your-repository)." + tags: + - repos + operationId: repos/list-activities + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + "/repos/{owner}/{repo}/assignees": + get: + summary: List assignees + description: Lists the [available assignees](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 automated security fixes are enabled for a repository + description: 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/enterprise-server@3.13/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/check-automated-security-fixes + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/repos#check-if-automated-security-fixes-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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + description: Require status checks to pass before merging. Set to + `null` to disable. + 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 + - 'null' + description: Enforce all configured restrictions for administrators. + Set to `true` to enforce required status checks for repository + administrators. Set to `null` to disable. + required_pull_request_reviews: + type: + - object + - 'null' + description: Require at least one approving review on a pull request, + before merging. Set to `null` to disable. + 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/enterprise-server@3.13/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 + - 'null' + 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. + 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/enterprise-server@3.13/github/administering-a-repository/requiring-a-linear-commit-history)" + in the GitHub Help documentation.' + allow_force_pushes: + type: + - boolean + - 'null' + 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/enterprise-server@3.13/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + in the GitHub Help documentation."' + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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`. + + > [!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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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`. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.13/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/rerequest-run + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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: + '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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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`. + + > [!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/enterprise-server@3.13/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`. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/rerequest-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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: + 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/enterprise-server@3.13/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/direction" + - 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" + 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. + + 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/enterprise-server@3.13/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. + 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/enterprise-server@3.13/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" + required: + - state + 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. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-alert" + examples: + default: + "$ref": "#/components/examples/code-scanning-alert-dismissed" + '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}/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/enterprise-server@3.13/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" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-scanning-alert-instance" + 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, + 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/enterprise-server@3.13/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" + - 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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/json+sarif: + 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" + '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. + + 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/enterprise-server@3.13/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 + - 'null' + 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/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + '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" + '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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + type: string + format: uri + examples: + - file:///github/workspace/ + 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 + 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)." + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/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. + 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. + + 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/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: |- + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." + + **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. + tags: + - repos + operationId: repos/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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.** + default: push + examples: + new-invitation-is-created: + summary: Add a collaborator with triage permissions + value: + permission: triage + responses: + '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': + "$ref": "#/components/responses/validation_failed" + '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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 of a collaborator. The possible repository + permissions are `admin`, `write`, `read`, and `none`. + + *Note*: 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`. To determine the role assigned to the + collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + tags: + - repos + operationId: repos/get-collaborator-permission-level + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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** + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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`. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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, will only return 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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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" + '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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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. + + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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" + '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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + responses: + '200': + description: Response + content: + application/vnd.github.object: + schema: + "$ref": "#/components/schemas/content-tree" + 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-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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - '"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 + examples: + - '"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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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-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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - name: page + description: "**Closing down notice**. Page number of the results to fetch. + Use cursor-based pagination with `before` or `after` instead." + deprecated: true + 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/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + deprecated: true + in: query + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + required: + - state + 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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: + '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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + default: none + - "$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. + + The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + description: Short description of the deployment. + default: '' + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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 Enterprise Server 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + type: integer + examples: + - 5 + 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] + > 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/enterprise-server@3.13/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)." + + > [!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/enterprise-server@3.13/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 + - 'null' + properties: + wait_timer: + "$ref": "#/components/schemas/wait-timer" + prevent_self_review: + "$ref": "#/components/schemas/prevent-self-review" + reviewers: + type: + - array + - 'null' + 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 + examples: + - 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + examples: + - 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - 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. + + 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/enterprise-server@3.13/rest/apps/apps#get-an-app). + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: + '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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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 Enterprise Server 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/enterprise-server@3.13/rest/repos/forks#create-a-fork + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + 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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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). + + **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/enterprise-server@3.13/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 + '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). + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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': + "$ref": "#/components/responses/validation_failed" + '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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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** + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + 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." + 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: + "$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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + - 'null' + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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)." + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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" + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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/enterprise-server@3.13/articles/disabling-issues/), the API returns a `410 Gone` status. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + 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.**_' + 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._' + type: + - 'null' + - string + - integer + 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 + - 'null' + color: + type: + - string + - 'null' + 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 + 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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/reactions": + get: + summary: List reactions for an issue comment + description: List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + [transferred](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: + "$ref": "#/components/examples/issue" + '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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + type: + - 'null' + - string + - integer + body: + type: + - string + - 'null' + description: The contents of the issue. + assignee: + type: + - string + - 'null' + 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 + - 'null' + enum: + - completed + - not_planned + - reopened + - + description: The reason for the state change. Ignored unless `state` + is changed. + examples: + - 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. + type: + - 'null' + - string + - integer + 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 + - 'null' + color: + type: + - string + - 'null' + 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 + 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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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. If you provide an empty array of labels, + all labels are removed from the issue. ' + tags: + - issues + operationId: issues/add-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 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 replace all of the labels for an issue. For + more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.13/rest/issues/labels#set-labels-for-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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + 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/enterprise-server@3.13/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}/reactions": + get: + summary: List reactions for an issue + description: List the reactions to an [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/list-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: false + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/delete-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/articles/repository-permission-levels-for-an-organization/)\" + and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/lfs": + put: + summary: Enable Git LFS for a repository + description: |- + Enables Git LFS for a repository. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: repos/enable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/lfs#enable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '202': + "$ref": "#/components/responses/accepted" + '403': + description: |- + We will return a 403 with one of the following messages: + + - Git LFS support not enabled because Git LFS is globally disabled. + - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + - Git LFS support not enabled because Git LFS is disabled for . + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: repos + subcategory: lfs + delete: + summary: Disable Git LFS for a repository + description: |- + Disables Git LFS for a repository. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: repos/disable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/lfs#disable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: repos + subcategory: lfs + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server Pages site + description: |- + Gets information about a GitHub Enterprise Server 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/enterprise-server@3.13/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 Enterprise Server Pages site + description: |- + Configures a GitHub Enterprise Server 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/enterprise-server@3.13/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 + - 'null' + description: The source branch and directory used to publish your Pages + site. + 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 Enterprise Server Pages site + description: |- + Updates information for a GitHub Enterprise Server 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/enterprise-server@3.13/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 + - 'null' + 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/enterprise-server@3.13/pages/configuring-a-custom-domain-for-your-github-pages-site)." + 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 Enterprise Server Pages site + description: |- + Deletes a GitHub Enterprise Server 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/enterprise-server@3.13/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 Enterprise Server Pages builds + description: |- + Lists builts of a GitHub Enterprise Server 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/enterprise-server@3.13/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 Enterprise Server 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/enterprise-server@3.13/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 Enterprise Server 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/enterprise-server@3.13/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 Enterprise Server Pages build + description: |- + Gets information about a GitHub Enterprise Server 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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_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. + 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: + - artifact_url + - 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 + preview: false + 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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}/pre-receive-hooks": + get: + summary: List pre-receive hooks for a repository + description: List all pre-receive hooks that are enabled or testing for this + repository as well as any disabled hooks that are allowed to be enabled at + the repository level. Pre-receive hooks that are disabled at a higher level + and are not configurable will not be listed. + operationId: enterprise-admin/list-pre-receive-hooks-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook for a repository + description: '' + operationId: enterprise-admin/get-pre-receive-hook-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + patch: + summary: Update pre-receive hook enforcement for a repository + description: For pre-receive hooks which are allowed to be configured at the + repo level, you can set `enforcement` + operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + enforcement: + description: The state of enforcement for the hook on this repository. + type: string + enum: + - enabled + - disabled + - testing + examples: + default: + value: + enforcement: enabled + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + delete: + summary: Remove pre-receive hook enforcement for a repository + description: |- + Deletes any overridden enforcement on this repository for the specified hook. + + Responds with effective values inherited from owner and/or global level. + operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Responds with effective values inherited from owner and/or + global level. + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + "/repos/{owner}/{repo}/projects": + get: + summary: List repository projects + description: 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. + tags: + - projects + operationId: projects/list-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#list-repository-projects + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items-2" + headers: + Link: + "$ref": "#/components/headers/link" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + post: + summary: Create a repository project + description: 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. + tags: + - projects + operationId: projects/create-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#create-a-repository-project + 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 project. + body: + type: string + description: The description of the project. + required: + - name + examples: + default: + value: + name: Projects Documentation + body: Developer documentation project for the developer site. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/get-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + 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/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - 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/enterprise-server@3.13/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/enterprise-server@3.13/articles/about-pull-requests#draft-pull-requests)" + in the GitHub Help documentation to learn more. + issue: + type: integer + format: int64 + 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. + examples: + - 1 + 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, + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.13/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.13/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 Enterprise Server 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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. + examples: + - 2 + 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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.13/rest/commits/commits#list-commits) + endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + - 'null' + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - 28 + side: + type: string + examples: + - RIGHT + start_line: + type: integer + examples: + - 26 + start_side: + type: string + examples: + - 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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + > [!NOTE] + > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + enum: + - DISMISS + examples: + - '"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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + 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/enterprise-server@3.13/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 + - 'null' + 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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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 + '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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - '"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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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" + 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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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" + 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/enterprise-server@3.13/rest/releases/releases#delete-a-release + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/release-id" + responses: + '204': + description: Response + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, + non-alphanumeric characters, and leading or trailing periods. The \"[List + release assets](https://docs.github.com/enterprise-server@3.13/rest/releases/assets#list-release-assets)\"\nendpoint + lists the renamed filenames. For more information and help, contact [GitHub + Enterprise Server 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/releases/assets#upload-a-release-asset + servers: + - url: https://HOSTNAME/api/uploads + 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/enterprise-server@3.13/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/list-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/delete-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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}/replicas/caches": + get: + summary: List repository cache replication status + description: Lists the status of each repository cache replica. + tags: + - repos + operationId: repos/list-cache-info + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/repos#list-repository-cache-replication-status + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Status information for cache replicas + content: + application/json: + schema: + type: array + items: + description: Status for a cache replica + type: object + properties: + host: + type: string + location: + type: string + git: + type: object + properties: + sync_status: + type: string + enum: + - offline + - inactive + - in_sync + - not_in_sync + last_sync: + type: string + format: date-time + required: + - sync_status + - last_sync + required: + - host + - location + - git + examples: + default: + value: + - host: host-1 + location: berlin + git: + - sync_status: in_sync + - last_sync: '2022-01-10T19:33:52Z' + - host: host-2 + location: chicago + git: + - sync_status: offline + - last_sync: '2022-01-10T19:34:12Z' + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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" + '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. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + **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/enterprise-server@3.13/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/enterprise-server@3.13/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" + '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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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-resolution" + - "$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" + 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. + + 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/enterprise-server@3.13/rest/secret-scanning/secret-scanning#get-a-secret-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/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. + + 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/enterprise-server@3.13/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" + required: + - state + examples: + default: + value: + state: resolved + resolution: false_positive + 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 + '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. + + 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/enterprise-server@3.13/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}/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + tags: + - repos + operationId: repos/get-code-frequency-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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" + 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/enterprise-server@3.13/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: |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 + tags: + - repos + operationId: repos/get-contributors-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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`. + + 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/enterprise-server@3.13/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: + + * `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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/activity/watching#set-a-repository-subscription). + tags: + - activity + operationId: activity/delete-repo-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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}/tags/protection": + get: + summary: Closing down - List tag protection states for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + + This returns the tag protection states of a repository. + + This information is only available to repository administrators. + tags: + - repos + operationId: repos/list-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/tags#closing-down---list-tag-protection-states-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/tag-protection" + examples: + default: + "$ref": "#/components/examples/tag-protection-items" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + post: + summary: Closing down - Create a tag protection state for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + + This creates a tag protection state for a repository. + This endpoint is only available to repository administrators. + tags: + - repos + operationId: repos/create-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern: + type: string + description: An optional glob pattern to match against when enforcing + tag protection. + required: + - pattern + examples: + default: + value: + pattern: v1.* + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/tag-protection" + examples: + default: + "$ref": "#/components/examples/tag-protection" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": + delete: + summary: Closing down - Delete a tag protection state for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.13/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + + This deletes a tag protection state for a repository. + This endpoint is only available to repository administrators. + tags: + - repos + operationId: repos/delete-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/tag-protection-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + "/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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` cannot contain uppercase letters. + 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}/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/enterprise-server@3.13/articles/about-repository-transfers/). + tags: + - repos + operationId: repos/transfer + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/check-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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: false + 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/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/enable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 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/enterprise-server@3.13/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/disable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + `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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + previews: + - required: true + name: baptiste + note: |- + Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + + ```shell + application/vnd.github.baptiste-preview+json + ``` + "/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/repos/repos#list-public-repositories + parameters: + - "$ref": "#/components/parameters/since-repo" + - name: visibility + description: Specifies the types of repositories to return. This endpoint + will only list repositories available to all users on the enterprise. + in: query + required: false + schema: + type: string + default: public + enum: + - all + - public + examples: + - all + 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 + "/scim/v2/enterprises/{enterprise}/Groups": + get: + summary: List provisioned SCIM groups for an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Lists provisioned SCIM groups in an enterprise. + + You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + operationId: enterprise-admin/list-provisioned-groups-enterprise + tags: + - enterprise-admin + - scim + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise + parameters: + - name: filter + description: If specified, only results that match the specified filter will + be returned. Multiple filters are not supported. Possible filters are `externalId`, + `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. + in: query + required: false + schema: + type: string + examples: + displayName: + value: Engineering + externalId: + value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + - "$ref": "#/components/parameters/excluded-attributes" + - "$ref": "#/components/parameters/start-index" + - "$ref": "#/components/parameters/count" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, either groups were found or not found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-list" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group-list" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Creates a SCIM group for an enterprise. + + If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. + operationId: enterprise-admin/provision-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#provision-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/group" + examples: + group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + responses: + '201': + description: Group has been created + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + group: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": + get: + summary: Get SCIM provisioning information for an enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Gets information about a SCIM group. + operationId: enterprise-admin/get-provisioning-information-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/excluded-attributes" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, a group was found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Replaces an existing provisioned group’s information. + + You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/group" + examples: + group: + summary: Group + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + groupWithMembers: + summary: Group with member + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + responses: + '200': + description: Group was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + group: + "$ref": "#/components/examples/scim-enterprise-group" + groupWithMembers: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Update a provisioned group’s individual attributes. + + To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. + + Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/patch-schema" + examples: + updateGroup: + summary: Update Group + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: displayName + value: Employees + addMembers: + summary: Add Members + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: members + value: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + responses: + '204': + description: Response + '200': + description: Success, group was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + updateGroup: + "$ref": "#/components/examples/scim-enterprise-group" + addMembers: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM group from an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Deletes a SCIM group from an enterprise. + operationId: enterprise-admin/delete-scim-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Group was deleted, no content + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users": + get: + summary: List SCIM provisioned identities for an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Lists provisioned SCIM enterprise members. + + When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. + operationId: enterprise-admin/list-provisioned-identities-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise + parameters: + - name: filter + description: If specified, only results that match the specified filter will + be returned. Multiple filters are not supported. Possible filters are `userName`, + `externalId`, `id`, and `displayName`. For example, `?filter="externalId + eq '9138790-10932-109120392-12321'"`. + in: query + required: false + schema: + type: string + examples: + userName: + value: userName eq 'E012345' + externalId: + value: externalId eq 'E012345' + - "$ref": "#/components/parameters/start-index" + - "$ref": "#/components/parameters/count" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, either users were found or not found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-list" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-user-list" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Creates an external identity for a new SCIM enterprise user. + + SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. + + When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. + operationId: enterprise-admin/provision-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#provision-a-scim-enterprise-user + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/user" + examples: + user: + "$ref": "#/components/examples/in-user" + enterpriseOwner: + "$ref": "#/components/examples/in-user-owner" + responses: + '201': + description: User has been created + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + user: + "$ref": "#/components/examples/scim-enterprise-user" + enterpriseOwner: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": + get: + summary: Get SCIM provisioning information for an enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Gets information about a SCIM user. + operationId: enterprise-admin/get-provisioning-information-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, a user was found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Replaces an existing provisioned user's information. + + You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. + + > [!WARNING] + > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/user" + examples: + user: + "$ref": "#/components/examples/in-user" + responses: + '200': + description: User was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + user: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Update a provisioned user's individual attributes. + + To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + + > [!NOTE] + > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + + > [!WARNING] + > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + > ``` + > { + > "Operations":[{ + > "op":"replace", + > "value":{ + > "active":false + > } + > }] + > } + > ``` + operationId: enterprise-admin/update-attribute-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/patch-schema" + examples: + userMultiValuedProperties: + summary: Multi Valued Property + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: emails[type eq 'work'].value + value: updatedEmail@microsoft.com + - op: replace + path: name.familyName + value: updatedFamilyName + userSingleValuedProperties: + summary: Single Valued Property + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: userName + value: 5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com + - op: replace + path: displayName + value: Monalisa Octocat + disableUser: + summary: Disable User + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: active + value: false + responses: + '200': + description: Success, user was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + userMultiValuedProperties: + "$ref": "#/components/examples/scim-enterprise-user" + userSingleValuedProperties: + "$ref": "#/components/examples/scim-enterprise-user" + disableUser: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM user from an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. + operationId: enterprise-admin/delete-user-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: User was deleted, no content + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + tags: + - search + operationId: search/code + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). + See "[Searching code](https://docs.github.com/enterprise-server@3.13/search-github/searching-on-github/searching-code)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query. Can only be `indexed`, which + indicates how recently a file has been indexed by the GitHub Enterprise + Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.13/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - indexed + - 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 + - "$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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). + See "[Searching commits](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). + See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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" + 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/issue-search-result-item" + examples: + default: + "$ref": "#/components/examples/issue-search-result-item-paginated" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/queries#search)." + tags: + - search + operationId: search/users + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.13/rest/search/search#constructing-a-search-query). + See "[Searching users](https://docs.github.com/enterprise-server@3.13/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 Enterprise Server. Default: + [best match](https://docs.github.com/enterprise-server@3.13/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 + "/setup/api/configcheck": + get: + summary: Get the configuration status + description: |- + This endpoint allows you to check the status of the most recent configuration process: + + Note that you may need to wait several seconds after you start a process before you can check its status. + + The different statuses are: + + | Status | Description | + | ------------- | --------------------------------- | + | `PENDING` | The job has not started yet | + | `CONFIGURING` | The job is running | + | `DONE` | The job has finished correctly | + | `FAILED` | The job has finished unexpectedly | + operationId: enterprise-admin/get-configuration-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-the-configuration-status + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/configuration-status" + examples: + default: + "$ref": "#/components/examples/configuration-status" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/configure": + post: + summary: Start a configuration process + description: 'This endpoint allows you to start a configuration process at any + time for your updated settings to take effect:' + operationId: enterprise-admin/start-configuration-process + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '202': + description: Response + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/maintenance": + get: + summary: Get the maintenance status + description: 'Check your installation''s maintenance status:' + operationId: enterprise-admin/get-maintenance-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-the-maintenance-status + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/maintenance-status" + examples: + default: + "$ref": "#/components/examples/maintenance-status" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + post: + summary: Enable or disable maintenance mode + description: |- + > [!NOTE] + > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + operationId: enterprise-admin/enable-or-disable-maintenance-mode + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/maintenance-status" + examples: + default: + "$ref": "#/components/examples/maintenance-status" + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + maintenance: + type: string + description: |- + A JSON string with the attributes `enabled` and `when`. + + The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. + + The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). + required: + - maintenance + examples: + default: + value: + maintenance: '{"enabled":true, "when":"now"}' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/settings": + get: + summary: Get settings + description: |- + Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings). + + > [!NOTE] + > You cannot retrieve the management console password with the Enterprise administration API. + operationId: enterprise-admin/get-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-settings" + examples: + default: + "$ref": "#/components/examples/enterprise-settings" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + put: + summary: Set settings + description: |- + Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). + + **Notes:** + + - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.13/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + operationId: enterprise-admin/set-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#set-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '204': + description: Response + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + settings: + type: string + description: A JSON string with the new settings. Note that you + only need to pass the specific settings you want to modify. For + a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). + required: + - settings + examples: + '204': + value: + settings: '{ "enterprise": { "public_pages": true }}' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/settings/authorized-keys": + get: + summary: Get all authorized SSH keys + description: '' + operationId: enterprise-admin/get-all-authorized-ssh-keys + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-key" + examples: + default: + "$ref": "#/components/examples/ssh-key-items" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + post: + summary: Add an authorized SSH key + description: "**Note:** The request body for this operation must be submitted + as `application/x-www-form-urlencoded` data. You can submit a parameter value + as a string, or you can use a tool such as `curl` to submit a parameter value + as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." + operationId: enterprise-admin/add-authorized-ssh-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#add-an-authorized-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '201': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-key" + examples: + default: + "$ref": "#/components/examples/ssh-key-items" + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + authorized_key: + type: string + description: The public SSH key. + required: + - authorized_key + examples: + default: + value: + authorized_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw== + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + delete: + summary: Remove an authorized SSH key + description: "**Note:** The request body for this operation must be submitted + as `application/x-www-form-urlencoded` data. You can submit a parameter value + as a string, or you can use a tool such as `curl` to submit a parameter value + as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." + operationId: enterprise-admin/remove-authorized-ssh-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-key" + examples: + default: + "$ref": "#/components/examples/ssh-key-items" + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + authorized_key: + type: string + description: The public SSH key. + required: + - authorized_key + examples: + default: + value: + authorized_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw== + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/start": + post: + summary: Create a GitHub license + description: |- + When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. + + Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + + When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: + + 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. + 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/create-enterprise-server-license + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#create-a-github-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '202': + description: Response + '401': + description: Unauthorized + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + password: + type: string + description: You **must** provide a password _only if_ you are uploading + your license for the first time. If you previously set a password + through the web interface, you don't need this parameter. + settings: + type: string + description: An optional JSON string containing the installation + settings. For a list of the available settings, see the [Get settings + endpoint](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#get-settings). + required: + - license + examples: + default: + value: + license: "@enterprise.ghl" + password: secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/upgrade": + post: + summary: Upgrade a license + description: |- + This API upgrades your license and also triggers the configuration process. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/upgrade-license + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/management-console#upgrade-a-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '202': + description: Response + '401': + description: Unauthorized + requestBody: + required: false + content: + multipart/form-data: + schema: + type: object + properties: + license: + type: string + description: The content of your new _.ghl_ license file. + examples: + default: + value: + license: "@enterprise.ghl" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - 'null' + description: The ID of a team to set as the parent team. + 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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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}/discussions": + get: + summary: List discussions (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 discussions`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions) endpoint. + + List all discussions on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#list-discussions-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$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/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + post: + summary: Create a discussion (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 [`Create a discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion) endpoint. + + Creates a new discussion post on a team's page. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#create-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + private: + type: boolean + description: Private posts are only visible to team members, organization + owners, and team maintainers. Public posts are visible to all + members of the organization. Set to `true` to create a private + post. + default: false + required: + - title + - body + examples: + default: + value: + title: Our first team post + body: Hi! This is an area for us to collaborate as a team. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}": + get: + summary: Get a discussion (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 a discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion) endpoint. + + Get a specific discussion on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + patch: + summary: Update a discussion (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 discussion](https://docs.github.com/enterprise-server@3.13/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 app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#update-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + examples: + default: + value: + title: Welcome to our first team post + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + delete: + summary: Delete a discussion (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 discussion`](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion) endpoint. + + Delete a discussion from a team's page. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#delete-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments": + get: + summary: List discussion comments (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 discussion comments](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments) endpoint. + + List all comments on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussion-comments-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#list-discussion-comments-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$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/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + post: + summary: Create a discussion comment (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 [Create a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + + Creates a new comment on a team discussion. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/guides/best-practices-for-using-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#create-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like apples? + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": + get: + summary: Get a discussion comment (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 a discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + + Get a specific comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + patch: + summary: Update a discussion comment (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 discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + + Edits the body text of a discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#update-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like pineapples? + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + delete: + summary: Delete a discussion comment (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 discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + + Deletes a comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#delete-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": + get: + summary: List reactions for a team discussion comment (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 reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + + List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + post: + summary: Create reaction for a team discussion comment (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 "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + + Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.13/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) + to add to the team discussion comment. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/reaction" + examples: + default: + "$ref": "#/components/examples/reaction" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/reactions": + get: + summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + + List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + post: + summary: Create reaction for a team discussion (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 [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + + Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.13/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.13/rest/reactions/reactions#about-reactions) + to add to the team discussion. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/reaction" + examples: + default: + "$ref": "#/components/examples/reaction" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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. + + We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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}/projects": + get: + summary: List team projects (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 projects`](https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects) endpoint. + + Lists the organization projects for a team. + tags: + - teams + operationId: teams/list-projects-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#list-team-projects-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/team-project" + examples: + default: + "$ref": "#/components/examples/team-project-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}/projects/{project_id}": + get: + summary: Check team permissions for a project (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 project](https://docs.github.com/enterprise-server@3.13/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. + tags: + - teams + operationId: teams/check-permissions-for-project-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#check-team-permissions-for-a-project-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-project" + examples: + default: + "$ref": "#/components/examples/team-project" + '404': + description: Not Found if project 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 project 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 project permissions](https://docs.github.com/enterprise-server@3.13/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. + tags: + - teams + operationId: teams/add-or-update-project-permissions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: 'The permission to grant to the team for this project. + Default: the team''s `permission` attribute will be used to determine + what permission to grant the team on this project. Note that, + if you choose not to pass any parameters, you''ll need to set + `Content-Length` to zero when calling this endpoint. For more + information, see "[HTTP method](https://docs.github.com/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)."' + enum: + - read + - write + - admin + examples: + default: + summary: Example of setting permission to read + value: + permission: read + responses: + '204': + description: Response + '403': + description: Forbidden if the project is not owned by the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-the-project-is-not-owned-by-the-organization: + value: + message: Must have admin rights to Repository. + documentation_url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#add-or-update-team-project-permissions + '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 + delete: + summary: Remove a project 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 project from a team](https://docs.github.com/enterprise-server@3.13/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. + tags: + - teams + operationId: teams/remove-project-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/teams/teams#remove-a-project-from-a-team-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-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}/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/enterprise-server@3.13/rest/teams/teams#list-team-repositories) endpoint. + tags: + - teams + operationId: teams/list-repos-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/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/enterprise-server@3.13/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] + > **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/enterprise-server@3.13/rest/teams/teams#list-child-teams) endpoint. + tags: + - teams + operationId: teams/list-child-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - Omar Jahandar + email: + description: The publicly visible email address of the user. + type: string + examples: + - omar@example.com + blog: + description: The new blog URL of the user. + type: string + examples: + - blog.example.com + twitter_username: + description: The new Twitter username of the user. + type: + - string + - 'null' + examples: + - therealomarj + company: + description: The new company of the user. + type: string + examples: + - Acme corporation + location: + description: The new location of the user. + type: string + examples: + - 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/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/enterprise-server@3.13/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/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + examples: + - username@example.com + minItems: 1 + examples: [] + required: + - emails + example: + emails: + - octocat@github.com + - mona@github.com + - type: array + items: + type: string + examples: + - 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/enterprise-server@3.13/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 + examples: + - username@example.com + minItems: 1 + example: + emails: + - octocat@github.com + - mona@github.com + required: + - emails + - type: array + items: + type: string + examples: + - 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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" + '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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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: + "$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/enterprise-server@3.13/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/enterprise-server@3.13/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/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_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/enterprise-server@3.13/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 + examples: + - 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + readOnly: false + type: boolean + examples: + - true + exclude_metadata: + description: Indicates whether metadata should be excluded and only + git source should be included for the migration. + readOnly: false + type: boolean + examples: + - true + exclude_git_data: + description: Indicates whether the repository git data should be + excluded from the migration. + readOnly: false + type: boolean + examples: + - true + exclude_attachments: + description: Do not include attachments in the migration + readOnly: false + type: boolean + examples: + - true + exclude_releases: + description: Do not include releases in the migration + readOnly: false + type: boolean + examples: + - true + exclude_owner_projects: + description: Indicates whether projects owned by the organization + or users should be excluded. + readOnly: false + type: boolean + examples: + - true + org_metadata_only: + type: boolean + description: Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore other + flags). + default: false + examples: + - true + exclude: + description: Exclude attributes from the API response to improve + performance + readOnly: false + type: array + items: + description: Allowed values that can be passed to the exclude + param. + enum: + - repositories + type: string + examples: + - repositories + examples: + - repositories + repositories: + type: array + items: + description: Repository path, owner and name + type: string + examples: + - acme/widgets + 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}/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/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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 + "/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/projects": + post: + summary: Create a user project + description: 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. + tags: + - projects + operationId: projects/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#create-a-user-project + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + required: + - name + type: object + examples: + default: + summary: Create a new project + value: + name: My Projects + body: A board to manage my personal projects. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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" + '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. + + 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/enterprise-server@3.13/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 + examples: + - 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 + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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. + type: string + examples: + - Haskell + license_template: + description: The license keyword of the open source license for + this repository. + type: string + examples: + - mit + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + examples: + - 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 + examples: + - true + is_template: + description: Whether this repository acts as a template that can + be used to generate new repositories. + default: false + type: boolean + examples: + - 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 + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + examples: + - https://twitter.com/github + examples: [] + 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. + + 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/enterprise-server@3.13/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 + examples: + - https://twitter.com/github + examples: [] + 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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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 + examples: + - 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/rest/users/emails)". + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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 + "/users": + get: + summary: List users + description: |- + Lists all users, in the order that they signed up on GitHub Enterprise Server. 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/enterprise-server@3.13/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/enterprise-server@3.13/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/{username}": + get: + summary: Get a user + description: |- + Provides publicly available information about someone with a GitHub account. + + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/rest/users/emails)". + tags: + - users + operationId: users/get-by-username + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/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}/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/enterprise-server@3.13/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). + + > [!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/enterprise-server@3.13/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. + + > [!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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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}/projects": + get: + summary: List user projects + description: Lists projects for a user. + tags: + - projects + operationId: projects/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/projects/projects#list-user-projects + parameters: + - "$ref": "#/components/parameters/username" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items-3" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: projects + "/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/enterprise-server@3.13/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] + > 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/enterprise-server@3.13/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/enterprise-server@3.13/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}/site_admin": + put: + summary: Promote a user to be a site administrator + 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/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." + operationId: enterprise-admin/promote-user-to-be-site-administrator + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Demote a site administrator + description: You can demote any user account except your own. + operationId: enterprise-admin/demote-site-administrator + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#demote-a-site-administrator + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.13/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/enterprise-server@3.13/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + "/users/{username}/suspended": + put: + summary: Suspend a user + description: |- + If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + + You can suspend any user account except your own. + + 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/enterprise-server@3.13/rest/guides/getting-started-with-the-rest-api#http-method)." + operationId: enterprise-admin/suspend-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#suspend-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + reason: + type: string + description: The reason the user is being suspended. This message + will be logged in the [audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). + If you don't provide a `reason`, it will default to "Suspended + via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ + is the person who performed the action. + examples: + reason: + value: + reason: Suspended during leave of absence. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Unsuspend a user + description: If your GitHub instance uses [LDAP Sync with Active Directory LDAP + servers](https://docs.github.com/enterprise-server@3.13/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), + this API is disabled and will return a `403` response. Active Directory LDAP-authenticated + users cannot be unsuspended using the API. + operationId: enterprise-admin/unsuspend-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/users#unsuspend-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + requestBody: + content: + application/json: + schema: + type: + - object + - 'null' + properties: + reason: + type: string + description: The reason the user is being unsuspended. This message + will be logged in the [audit log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). + If you don't provide a `reason`, it will default to "Unsuspended + via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ + is the person who performed the action. + examples: + reason: + value: + reason: Unsuspended after leave of absence. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.13/rest/meta/meta#get-the-zen-of-github + responses: + '200': + description: Response + content: + application/json: + schema: + type: string + examples: + default: + summary: Example response + value: Responsive is better than fast + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta +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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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-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. + For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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-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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + cache-sync: + post: + summary: This event occurs when a Git ref has been successfully synced to a + cache replica. For more information, see "[About repository caching](https://docs.github.com/enterprise-server@3.13/admin/enterprise-management/caching-repositories/about-repository-caching)." + operationId: cache-sync + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#cache_sync + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-cache-sync" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: cache_sync + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/developers/apps/guides/creating-ci-tests-with-the-checks-api)." + operationId: check-run/requested-action + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-server@3.13/rest/checks/runs#create-a-check-run)" + in the REST API documentation. + operationId: check-suite/requested + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-server@3.13/rest/checks/suites#create-a-check-suite)" + in the REST API documentation. + operationId: check-suite/rerequested + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.13/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.13/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.9.0 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.9.0 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + enterprise-anonymous-access-disabled: + post: + summary: This event occurs when there is activity relating to anonymous Git + read access in an enterprise. For more information, see "[Enforcing repository + management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." + description: Anonymous Git read access was disabled. + operationId: enterprise/anonymous-access-disabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#enterprise + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: enterprise + supported-webhook-types: + - business + enterprise-anonymous-access-enabled: + post: + summary: This event occurs when there is activity relating to anonymous Git + read access in an enterprise. For more information, see "[Enforcing repository + management policies in your enterprise](https://docs.github.com/enterprise-server@3.13/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." + description: Anonymous Git read access was enabled. + operationId: enterprise/anonymous-access-enabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#enterprise + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: enterprise + supported-webhook-types: + - business + fork: + post: + summary: |- + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-server@3.13/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + label-created: + post: + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.13/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. + description: A package was published to a registry. + operationId: package/published + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + - app + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.13/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. + description: A previously published package was updated. + operationId: package/updated + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + - app + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was approved. + operationId: personal-access-token-request/approved + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + 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/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was created. + operationId: personal-access-token-request/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was denied. + operationId: personal-access-token-request/denied + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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, + 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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-anonymous-access-disabled: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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: Someone disabled anonymous Git read access to the repository. For + more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." + operationId: repository/anonymous-access-disabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" + 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: + - app + - business + - organization + - repository + repository-anonymous-access-enabled: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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: Someone enabled anonymous Git read access to the repository. For + more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." + operationId: repository/anonymous-access-enabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" + 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: + - app + - business + - organization + - repository + repository-archived: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-privatized: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.13/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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-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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.13/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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-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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.13/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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-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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.13/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + user-created: + post: + summary: This event occurs when there is activity relating to user accounts + in an enterprise. + description: A user account was added to the enterprise. + operationId: user/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#user + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-user-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: user + supported-webhook-types: + - business + user-deleted: + post: + summary: This event occurs when there is activity relating to user accounts + in an enterprise. + description: A user account was removed from the enterprise. + operationId: user/deleted + externalDocs: + url: https://docs.github.com/enterprise-server@3.13/webhooks/webhook-events-and-payloads#user + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-user-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: user + supported-webhook-types: + - business + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.13/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.13/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + global-hook: + type: object + properties: + type: + type: string + id: + type: integer + name: + type: string + active: + type: boolean + events: + type: array + items: + type: string + config: + type: object + properties: + url: + type: string + content_type: + type: string + insecure_ssl: + type: string + secret: + type: string + updated_at: + type: string + created_at: + type: string + url: + type: string + ping_url: + type: string + global-hook-2: + type: object + properties: + type: + type: string + id: + type: integer + name: + type: string + active: + type: boolean + events: + type: array + items: + type: string + config: + type: object + properties: + url: + type: string + content_type: + type: string + insecure_ssl: + type: string + updated_at: + type: string + created_at: + type: string + url: + type: string + ping_url: + type: string + public-key-full: + type: object + properties: + id: + type: integer + format: int64 + key: + type: string + user_id: + type: + - integer + - 'null' + repository_id: + type: + - integer + - 'null' + format: int64 + url: + type: string + title: + type: string + read_only: + type: boolean + verified: + type: boolean + created_at: + type: string + format: date-time + added_by: + type: + - string + - 'null' + last_used: + type: + - string + - 'null' + format: date-time + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + - last_used + - user_id + - repository_id + ldap-mapping-team: + type: object + properties: + ldap_dn: + type: string + id: + type: integer + node_id: + type: string + url: + type: string + html_url: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + members_url: + type: string + repositories_url: + type: string + parent: + type: + - 'null' + ldap-mapping-user: + title: Ldap Private User + description: Ldap Private User + type: object + properties: + ldap_dn: + type: string + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + suspended_at: + type: string + format: date-time + business_plus: + type: boolean + user_view_type: + type: string + examples: + - 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 + - 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 + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + pre-receive-environment: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + image_url: + type: string + url: + type: string + html_url: + type: string + default_environment: + type: boolean + created_at: + type: string + hooks_count: + type: integer + download: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + pre-receive-environment-download-status: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + script: + type: string + script_repository: + type: object + properties: + id: + type: integer + full_name: + type: string + url: + type: string + html_url: + type: string + environment: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + image_url: + type: string + url: + type: string + html_url: + type: string + default_environment: + type: boolean + created_at: + type: string + hooks_count: + type: integer + download: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + allow_downstream_configuration: + type: boolean + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + type: + - string + - 'null' + email: + type: + - string + - 'null' + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + starred_at: + type: string + examples: + - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - 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 + 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 + 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 leve 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 + 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 + 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 + 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 custom + property management. + 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_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 + team_discussions: + type: string + description: The level of permission to grant the access token to manage + team discussions and related comments. + 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 + example: + contents: read + issues: read + deployments: write + single_file: read + 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 + - 'null' + examples: + - config.yaml + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + account: + "$ref": "#/components/schemas/simple-user" + required: + - permissions + - repository_selection + - single_file_name + - repositories_url + - account + 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 + - 'null' + items: + type: string + token: + type: string + token_last_eight: + type: + - string + - 'null' + hashed_token: + type: + - string + - 'null' + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + note: + type: + - string + - 'null' + note_url: + type: + - string + - 'null' + format: uri + updated_at: + type: string + format: date-time + created_at: + type: string + format: date-time + fingerprint: + type: + - string + - 'null' + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + installation: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/scoped-installation" + expires_at: + type: + - string + - 'null' + format: date-time + required: + - app + - id + - note + - note_url + - scopes + - token + - hashed_token + - token_last_eight + - fingerprint + - url + - created_at + - updated_at + - expires_at + 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 + - 'null' + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: + - string + - 'null' + description: The unique package name within its ecosystem. + required: + - ecosystem + - name + vulnerable_version_range: + type: + - string + - 'null' + description: The range of the package versions affected by the vulnerability. + first_patched_version: + type: + - string + - 'null' + description: The package version that resolves the vulnerability. + vulnerable_functions: + type: + - array + - 'null' + description: The functions in the package that are affected by the vulnerability. + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions + cvss-severities: + type: + - object + - 'null' + properties: + cvss_v3: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 3 vector string. + score: + type: + - number + - 'null' + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 4 vector string. + score: + type: + - number + - 'null' + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + 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 + - 'null' + description: The Common Vulnerabilities and Exposures (CVE) ID. + 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 + - 'null' + format: uri + description: The API URL for the repository advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: + - string + - 'null' + description: A detailed description of what the advisory entails. + maxLength: 65535 + 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 + - 'null' + format: uri + description: The URL of the advisory's source code. + identifiers: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + description: The date and time of when the advisory was reviewed by GitHub, + in ISO 8601 format. + readOnly: true + nvd_published_at: + type: + - string + - 'null' + 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 + withdrawn_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO + 8601 format. + readOnly: true + vulnerabilities: + type: + - array + - 'null' + description: The products and respective version ranges affected by the + advisory. + items: + "$ref": "#/components/schemas/vulnerability" + cvss: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS vector. + score: + type: + - number + - 'null' + description: The CVSS score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + cwes: + type: + - array + - 'null' + 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 + epss: + type: + - object + - 'null' + properties: + percentage: + type: number + percentile: + type: number + credits: + type: + - array + - 'null' + description: In GitHub Enterprise Server, this field will always be empty + because the user metadata of credited users will not be available. + 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 + 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 + 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 + - 'null' + properties: + id: + description: Unique identifier of the GitHub app + type: integer + examples: + - 37 + slug: + description: The slug name of the GitHub app + type: string + examples: + - probot-owners + node_id: + type: string + examples: + - MDExOkludGVncmF0aW9uMQ== + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + name: + description: The name of the GitHub app + type: string + examples: + - Probot Owners + description: + type: + - string + - 'null' + examples: + - The description of the app. + external_url: + type: string + format: uri + examples: + - https://example.com + html_url: + type: string + format: uri + examples: + - https://github.com/apps/super-ci + created_at: + type: string + format: date-time + examples: + - '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + examples: + - '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 + type: array + items: + type: string + examples: + - label + - deployment + installations_count: + description: The number of installations associated with the GitHub app + type: integer + examples: + - 5 + client_secret: + type: string + examples: + - '"1d4b2097ac622ba702d19de498f005747a8b21d3"' + webhook_secret: + type: + - string + - 'null' + examples: + - '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' + pem: + type: string + examples: + - '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END + RSA PRIVATE KEY-----\n"' + 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. + format: uri + examples: + - https://example.com/webhook + 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`. + examples: + - '"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/enterprise-server@3.13/webhooks/event-payloads/#delivery-headers). + examples: + - '"********"' + 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.** + examples: + - '"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 + examples: + - 42 + guid: + description: Unique identifier for the event (shared with all deliveries + for all webhooks that subscribe to this event). + type: string + examples: + - 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + examples: + - '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + examples: + - false + duration: + description: Time spent delivering. + type: number + examples: + - 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + examples: + - failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + examples: + - 502 + event: + description: The event that triggered the delivery. + type: string + examples: + - issues + action: + description: The type of activity for the event that triggered the delivery. + type: + - string + - 'null' + examples: + - opened + installation_id: + description: The id of the GitHub App installation associated with this + event. + type: + - integer + - 'null' + examples: + - 123 + repository_id: + description: The id of the repository associated with this event. + type: + - integer + - 'null' + examples: + - 123 + throttled_at: + description: Time when the webhook delivery was throttled. + type: + - string + - 'null' + format: date-time + examples: + - '2021-05-12T20:33:44Z' + 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 + - 'null' + documentation_url: + type: + - string + - 'null' + detail: + type: + - string + - 'null' + status: + type: integer + scimType: + type: + - string + - 'null' + 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 + - 'null' + - type: + - integer + - 'null' + - type: + - array + - 'null' + 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 + examples: + - 42 + guid: + description: Unique identifier for the event (shared with all deliveries + for all webhooks that subscribe to this event). + type: string + examples: + - 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + examples: + - '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + examples: + - false + duration: + description: Time spent delivering. + type: number + examples: + - 0.03 + status: + description: Description of the status of the attempted delivery + type: string + examples: + - failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + examples: + - 502 + event: + description: The event that triggered the delivery. + type: string + examples: + - issues + action: + description: The type of activity for the event that triggered the delivery. + type: + - string + - 'null' + examples: + - opened + installation_id: + description: The id of the GitHub App installation associated with this + event. + type: + - integer + - 'null' + examples: + - 123 + repository_id: + description: The id of the repository associated with this event. + type: + - integer + - 'null' + examples: + - 123 + throttled_at: + description: Time when the webhook delivery was throttled. + type: + - string + - 'null' + format: date-time + examples: + - '2021-05-12T20:33:44Z' + url: + description: The URL target of the delivery. + type: string + examples: + - https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: + - object + - 'null' + additionalProperties: true + payload: + description: The webhook payload. + type: + - object + - 'null' + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: + - object + - 'null' + additionalProperties: true + payload: + description: The response payload received. + type: + - string + - 'null' + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '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-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 + examples: + - 42 + node_id: + type: string + examples: + - 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 + examples: + - '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 + examples: + - 1 + account: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" + type: + - 'null' + - object + 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 + examples: + - https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/installation/repositories + html_url: + type: string + format: uri + examples: + - https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + examples: + - 1 + target_id: + description: The ID of the user or organization this token is being scoped + to. + type: integer + target_type: + type: string + examples: + - 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 + - 'null' + examples: + - config.yaml + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + app_slug: + type: string + examples: + - github-actions + suspended_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + suspended_at: + type: + - string + - 'null' + format: date-time + contact_email: + type: + - string + - 'null' + examples: + - '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + 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 + license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + examples: + - mit + name: + type: string + examples: + - MIT License + url: + type: + - string + - 'null' + format: uri + examples: + - https://api.github.com/licenses/mit + spdx_id: + type: + - string + - 'null' + examples: + - MIT + node_id: + type: string + examples: + - MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + deprecated: true + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - '"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 + 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 + examples: + - README.md + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + required: + - token + - expires_at + application-grant: + title: Application Grant + description: The authorization associated with an OAuth Access. + type: object + properties: + id: + type: integer + format: int64 + examples: + - 1 + url: + type: string + format: uri + examples: + - https://api.github.com/applications/grants/1 + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + scopes: + type: array + items: + type: string + examples: + - public_repo + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - app + - id + - scopes + - url + - created_at + - updated_at + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + examples: + - contributor_covenant + name: + type: string + examples: + - Contributor Covenant + url: + type: string + format: uri + examples: + - https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + examples: + - | + # 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 + - 'null' + format: uri + required: + - url + - html_url + - key + - name + announcement-message: + type: + - string + - 'null' + description: The announcement text in GitHub Flavored Markdown. For more information + about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.13/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + examples: + - Very **important** announcement about _something_. + announcement-expiration: + type: + - string + - 'null' + format: date-time + description: 'The time at which the announcement expires. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + To set an announcement that never expires, omit this parameter, set it to + `null`, or set it to an empty string.' + examples: + - '"2021-01-01T00:00:00.000-07:00"' + announcement: + title: Enterprise Announcement + description: Enterprise global announcement + type: object + properties: + announcement: + "$ref": "#/components/schemas/announcement-message" + expires_at: + "$ref": "#/components/schemas/announcement-expiration" + required: + - announcement + license-info: + type: object + properties: + seats: + oneOf: + - type: string + - type: integer + seats_used: + type: integer + seats_available: + oneOf: + - type: string + - type: integer + kind: + type: string + days_until_expiration: + type: integer + expire_at: + type: string + enterprise-repository-overview: + title: Repository Enterprise Stats + type: object + properties: + total_repos: + type: integer + root_repos: + type: integer + fork_repos: + type: integer + org_repos: + type: integer + total_pushes: + type: integer + total_wikis: + type: integer + required: + - total_repos + - root_repos + - fork_repos + - org_repos + - total_pushes + - total_wikis + enterprise-hook-overview: + title: Hooks Enterprise Stats + type: object + properties: + total_hooks: + type: integer + active_hooks: + type: integer + inactive_hooks: + type: integer + required: + - total_hooks + - active_hooks + - inactive_hooks + enterprise-page-overview: + title: Enterprise Pages Stats + type: object + properties: + total_pages: + type: integer + required: + - total_pages + enterprise-organization-overview: + title: Enterprise Organization Stats + type: object + properties: + total_orgs: + type: integer + disabled_orgs: + type: integer + total_teams: + type: integer + total_team_members: + type: integer + required: + - total_orgs + - disabled_orgs + - total_teams + - total_team_members + enterprise-user-overview: + title: Enterprise User Stats + type: object + properties: + total_users: + type: integer + admin_users: + type: integer + suspended_users: + type: integer + required: + - total_users + - admin_users + - suspended_users + enterprise-pull-request-overview: + title: Enterprise Pull Request Stats + type: object + properties: + total_pulls: + type: integer + merged_pulls: + type: integer + mergeable_pulls: + type: integer + unmergeable_pulls: + type: integer + required: + - total_pulls + - merged_pulls + - mergeable_pulls + - unmergeable_pulls + enterprise-issue-overview: + title: Enterprise Issue Stats + type: object + properties: + total_issues: + type: integer + open_issues: + type: integer + closed_issues: + type: integer + required: + - total_issues + - open_issues + - closed_issues + enterprise-milestone-overview: + title: Enterprise Milestone Stats + type: object + properties: + total_milestones: + type: integer + open_milestones: + type: integer + closed_milestones: + type: integer + required: + - total_milestones + - open_milestones + - closed_milestones + enterprise-gist-overview: + title: Enterprise Gist Stats + type: object + properties: + total_gists: + type: integer + private_gists: + type: integer + public_gists: + type: integer + required: + - total_gists + - private_gists + - public_gists + enterprise-comment-overview: + title: Enterprise Comment Stats + type: object + properties: + total_commit_comments: + type: integer + total_gist_comments: + type: integer + total_issue_comments: + type: integer + total_pull_request_comments: + type: integer + required: + - total_commit_comments + - total_gist_comments + - total_issue_comments + - total_pull_request_comments + enterprise-overview: + type: object + properties: + repos: + "$ref": "#/components/schemas/enterprise-repository-overview" + hooks: + "$ref": "#/components/schemas/enterprise-hook-overview" + pages: + "$ref": "#/components/schemas/enterprise-page-overview" + orgs: + "$ref": "#/components/schemas/enterprise-organization-overview" + users: + "$ref": "#/components/schemas/enterprise-user-overview" + pulls: + "$ref": "#/components/schemas/enterprise-pull-request-overview" + issues: + "$ref": "#/components/schemas/enterprise-issue-overview" + milestones: + "$ref": "#/components/schemas/enterprise-milestone-overview" + gists: + "$ref": "#/components/schemas/enterprise-gist-overview" + comments: + "$ref": "#/components/schemas/enterprise-comment-overview" + enterprise-security-products-overview: + title: Enterprise Security Products Stats + type: object + properties: + total_repos: + type: integer + nonarchived_repos: + type: integer + secret_scanning_enabled_repos: + type: integer + secret_scanning_push_protection_enabled_repos: + type: integer + code_scanning_enabled_repos: + type: integer + code_scanning_pr_reviews_enabled_repos: + type: integer + code_scanning_default_setup_enabled_repos: + type: integer + code_scanning_default_setup_eligible_repos: + type: integer + dependabot_alerts_enabled_repos: + type: integer + dependabot_security_updates_enabled_repos: + type: integer + dependabot_version_updates_enabled_repos: + type: integer + advanced_security_enabled_repos: + type: integer + active_committers: + type: integer + purchased_committers: + type: integer + maximum_committers: + type: integer + 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-policy-enterprise: + title: Actions cache usage policy for an enterprise + description: GitHub Actions cache usage policy for an enterprise. + type: object + properties: + repo_cache_size_limit_in_gb: + description: For repositories in an enterprise, the default size limit for + the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 + max_repo_cache_size_limit_in_gb: + description: For repositories in an enterprise, the maximum value that can + be set as the limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 15 + enabled-organizations: + type: string + description: The policy that controls the organizations in the enterprise that + are allowed to run GitHub Actions. + enum: + - all + - none + - selected + allowed-actions: + type: string + description: The permissions policy that controls the actions 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 that are allowed to + run, when `allowed_actions` is set to `selected`. + actions-enterprise-permissions: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + selected_organizations_url: + type: string + description: The API URL to use to get or set the selected organizations + that are allowed to run GitHub Actions, when `enabled_organizations` is + set to `selected`. + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" + required: + - enabled_organizations + 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. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow specific + action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, + `monalisa/octocat@v2`, `monalisa/*`. + items: + type: string + required: + - github_owned_allowed + - patterns_allowed + 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-enterprise: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - allows_public_repositories + - default + - runners_url + 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 + examples: + - 5 + runner_group_id: + description: The id of the runner group. + type: integer + examples: + - 1 + name: + description: The name of the runner. + type: string + examples: + - iMac + os: + description: The Operating System of the runner. + type: string + examples: + - macos + status: + description: The status of the runner. + type: string + examples: + - online + busy: + type: boolean + labels: + type: array + items: + "$ref": "#/components/schemas/runner-label" + 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 + examples: + - v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + examples: + - '2016-07-11T22:14:10Z' + permissions: + type: object + examples: + - issues: read + deployments: write + repositories: + description: The repositories this token has access to + type: array + items: + "$ref": "#/components/schemas/repository" + single_file: + type: + - string + - 'null' + examples: + - config.yaml + 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 + audit-log-event: + type: object + properties: + "@timestamp": + type: integer + description: The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + action: + type: string + description: The name of the action that was performed, for example `user.login` + or `repo.create`. + active: + type: boolean + active_was: + type: boolean + actor: + type: string + description: The actor who performed the action. + actor_id: + type: integer + description: The id of the actor who performed the action. + actor_location: + type: object + properties: + country_name: + type: string + data: + type: object + additionalProperties: true + org_id: + type: integer + user_id: + type: integer + business_id: + type: integer + blocked_user: + type: string + description: The username of the account being blocked. + business: + type: string + config: + type: array + items: + type: object + config_was: + type: array + items: + type: object + content_type: + type: string + operation_type: + type: string + created_at: + type: integer + description: The time the audit log event was recorded, given as a [Unix + timestamp](http://en.wikipedia.org/wiki/Unix_time). + deploy_key_fingerprint: + type: string + _document_id: + type: string + description: A unique identifier for an audit event. + emoji: + type: string + events: + type: array + items: + type: object + events_were: + type: array + items: + type: object + explanation: + type: string + fingerprint: + type: string + hook_id: + type: integer + limited_availability: + type: boolean + message: + type: string + name: + type: string + old_user: + type: string + openssh_public_key: + type: string + org: + type: string + previous_visibility: + type: string + read_only: + type: boolean + repo: + type: string + description: The name of the repository. + repository: + type: string + description: The name of the repository. + repository_public: + type: boolean + target_login: + type: string + team: + type: string + transport_protocol: + type: integer + description: The type of protocol (for example, HTTP or SSH) used to transfer + Git data. + transport_protocol_name: + type: string + description: A human readable name for the protocol (for example, HTTP or + SSH) used to transfer Git data. + user: + type: string + description: The user that was affected by the action performed (if available). + visibility: + type: string + description: The repository visibility, for example `public` or `private`. + 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: + type: + - string + - 'null' + 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 + 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 + - 'null' + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + - + alert-fixed-at: + type: + - string + - 'null' + 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 + alert-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-alert-dismissed-reason: + type: + - string + - 'null' + description: "**Required when the state is dismissed.** The reason for dismissing + or closing the alert." + enum: + - false positive + - won't fix + - used in tests + - + code-scanning-alert-dismissed-comment: + type: + - string + - 'null' + description: The dismissal comment associated with the dismissal of the alert. + maxLength: 280 + code-scanning-alert-rule-summary: + type: object + properties: + id: + type: + - string + - 'null' + 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: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + 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. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + code-scanning-analysis-tool-version: + type: + - string + - 'null' + 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`, + `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 + - 'null' + description: A classification of the file. For example to identify it as generated. + 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 + 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 + description: A unique identifier of the repository. + examples: + - 1296269 + node_id: + type: string + description: The GraphQL identifier of the repository. + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + description: The name of the repository. + examples: + - Hello-World + full_name: + type: string + description: The full, globally unique, name of the repository. + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + description: The URL to view the repository on GitHub.com. + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + description: The repository description. + examples: + - This your first repo! + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + description: The URL to get more information about the repository from the + GitHub API. + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + description: A template for the API URL to download the repository as an + archive. + examples: + - https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + description: A template for the API URL to list the available assignees + for issues in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + description: A template for the API URL to get information about branches + in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + description: A template for the API URL to get information about collaborators + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + description: A template for the API URL to get information about comments + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + description: A template for the API URL to get information about commits + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + description: A template for the API URL to compare two commits or refs. + examples: + - https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + description: A template for the API URL to get the contents of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + description: A template for the API URL to list the contributors to the + repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + description: The API URL to list the deployments of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + description: The API URL to list the downloads on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + description: The API URL to list the events of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + description: The API URL to list the forks of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + description: A template for the API URL to get information about Git commits + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + description: A template for the API URL to get information about Git refs + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + description: A template for the API URL to get information about Git tags + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: + type: string + description: A template for the API URL to get information about issue comments + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + description: A template for the API URL to get information about issue events + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + description: A template for the API URL to get information about issues + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + description: A template for the API URL to get information about deploy + keys on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + description: A template for the API URL to get information about labels + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + description: The API URL to get information about the languages of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + description: The API URL to merge branches in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + description: A template for the API URL to get information about milestones + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + description: A template for the API URL to get information about notifications + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + description: A template for the API URL to get information about pull requests + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + description: A template for the API URL to get information about releases + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: + type: string + format: uri + description: The API URL to list the stargazers on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + description: A template for the API URL to get information about statuses + of a commit. + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + description: The API URL to list the subscribers on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + description: The API URL to subscribe to notifications for this repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + description: The API URL to get information about tags on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + description: The API URL to list the teams on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: + type: string + format: uri + description: The API URL to list the hooks on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks + 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-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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + - repository + enterprise-security-analysis-settings: + title: Enterprise Security Analysis Settings + type: object + properties: + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to + this enterprise. + examples: + - false + advanced_security_enabled_for_new_user_namespace_repositories: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled for + new user namespace repositories. + examples: + - false + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this + enterprise. + examples: + - false + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this + enterprise. + examples: + - false + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: |- + Whether secret scanning push protection is automatically enabled for new repositories and repositories + transferred to this enterprise. + examples: + - false + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: An optional URL string to display to contributors who are blocked + from pushing a secret. + examples: + - https://github.com/test-org/test-repo/blob/main/README.md + required: + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + 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 + - 'null' + description: Details pertaining to the package version that patches this + vulnerability. + readOnly: 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 + - 'null' + description: The unique CVE ID assigned to the advisory. + readOnly: 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 + 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 + - 'null' + description: The full CVSS vector string for the advisory. + readOnly: true + required: + - score + - vector_string + additionalProperties: false + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + 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 + - 'null' + description: 'The time that the advisory was withdrawn in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cvss + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + additionalProperties: false + alert-auto-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was auto-dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + 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 + - 'null' + description: The execution scope of the vulnerable dependency. + readOnly: true + enum: + - development + - runtime + - + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + dismissed_reason: + type: + - string + - 'null' + description: The reason that the alert was dismissed. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + - + dismissed_comment: + type: + - string + - 'null' + description: An optional comment associated with the alert's dismissal. + maxLength: 280 + fixed_at: + "$ref": "#/components/schemas/alert-fixed-at" + auto_dismissed_at: + "$ref": "#/components/schemas/alert-auto-dismissed-at" + 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 + 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 + - 'null' + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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/enterprise-server@3.13/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + advanced-security-active-committers-user: + type: object + properties: + user_login: + type: string + last_pushed_date: + type: string + examples: + - '2021-11-03' + last_pushed_email: + type: string + examples: + - monalisa@github.com + required: + - user_login + - last_pushed_date + - last_pushed_email + advanced-security-active-committers-repository: + type: object + properties: + name: + type: string + examples: + - octocat/Hello-World + advanced_security_committers: + type: integer + examples: + - 25 + advanced_security_committers_breakdown: + type: array + items: + "$ref": "#/components/schemas/advanced-security-active-committers-user" + required: + - name + - advanced_security_committers + - advanced_security_committers_breakdown + advanced-security-active-committers: + type: object + properties: + total_advanced_security_committers: + type: integer + examples: + - 25 + total_count: + type: integer + examples: + - 2 + maximum_advanced_security_committers: + type: integer + description: The total number of GitHub Advanced Security licences required + if all repositories were to enable GitHub Advanced Security + examples: + - 4 + purchased_advanced_security_committers: + type: integer + description: The total number of GitHub Advanced Security licences purchased + examples: + - 4 + repositories: + type: array + items: + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + required: + - repositories + actor: + title: Actor + description: Actor + type: object + properties: + id: + type: integer + login: + type: string + display_login: + type: string + gravatar_id: + type: + - string + - 'null' + url: + type: string + format: uri + avatar_url: + type: string + format: uri + required: + - id + - login + - gravatar_id + - url + - avatar_url + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + examples: + - 1002604 + node_id: + type: string + examples: + - MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + examples: + - 42 + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + default: open + examples: + - open + title: + description: The title of the milestone. + type: string + examples: + - v1.0 + description: + type: + - string + - 'null' + examples: + - Tracking milestone for version 1.0 + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + open_issues: + type: integer + examples: + - 4 + closed_issues: + type: integer + examples: + - 8 + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2013-02-12T13:22:01Z' + due_on: + type: + - string + - 'null' + format: date-time + examples: + - '2012-10-09T23:39:01Z' + 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 + author-association: + title: author_association + type: string + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + examples: + - 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 + 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 + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/1 + 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 + type: integer + examples: + - 42 + state: + description: State of the issue; either 'open' or 'closed' + type: string + examples: + - open + state_reason: + description: The reason for the current state + type: + - string + - 'null' + enum: + - completed + - reopened + - not_planned + - + examples: + - not_planned + title: + description: Title of the issue + type: string + examples: + - Widget creation fails in Safari on OS X 10.8 + body: + description: Contents of the issue + type: + - string + - 'null' + examples: + - 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? + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + - 'null' + color: + type: + - string + - 'null' + default: + type: boolean + examples: + - bug + - registration + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + locked: + type: boolean + active_lock_reason: + type: + - string + - 'null' + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: + - string + - 'null' + format: date-time + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + repository: + "$ref": "#/components/schemas/repository" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + author_association: + "$ref": "#/components/schemas/author-association" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + 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 + 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 + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - id + - node_id + - html_url + - issue_url + - author_association + - user + - url + - created_at + - updated_at + event: + title: Event + description: Event + type: object + properties: + id: + type: string + type: + type: + - string + - 'null' + 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: + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + pages: + type: array + items: + type: object + properties: + page_name: + type: string + title: + type: string + summary: + type: + - string + - 'null' + action: + type: string + sha: + type: string + html_url: + type: string + public: + type: boolean + created_at: + type: + - string + - 'null' + format: date-time + 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 + examples: + - https://github.com/timeline + user_url: + type: string + examples: + - https://github.com/{user} + current_user_public_url: + type: string + examples: + - https://github.com/octocat + current_user_url: + type: string + examples: + - https://github.com/octocat.private?token=abc123 + current_user_actor_url: + type: string + examples: + - https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: + type: string + examples: + - https://github.com/octocat-org + current_user_organization_urls: + type: array + items: + type: string + format: uri + examples: + - https://github.com/organizations/github/octocat.private.atom?token=abc123 + security_advisories_url: + type: string + examples: + - https://github.com/security-advisories + repository_discussions_url: + type: string + description: A feed of discussions for a given repository. + examples: + - https://github.com/{user}/{repo}/discussions + repository_discussions_category_url: + type: string + description: A feed of discussions for a given repository and category. + examples: + - https://github.com/{user}/{repo}/discussions/categories/{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 + - 'null' + comments: + type: integer + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + - 'null' + 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 + - 'null' + company: + type: + - string + - 'null' + blog: + type: + - string + - 'null' + location: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + notification_email: + type: + - string + - 'null' + format: email + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + twitter_username: + type: + - string + - 'null' + 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 + examples: + - 1 + total_private_repos: + type: integer + examples: + - 2 + owned_private_repos: + type: integer + examples: + - 2 + disk_usage: + type: integer + examples: + - 1 + collaborators: + type: integer + examples: + - 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + type: + - array + - 'null' + 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 + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/gist-history" + fork_of: + title: Gist + description: Gist + type: + - object + - 'null' + 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 + - 'null' + comments: + type: integer + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments_url: + type: string + format: uri + owner: + anyOf: + - type: 'null' + - "$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 + 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: + type: + - object + - 'null' + 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 + - 'null' + comments: + type: integer + user: + type: + - string + - 'null' + comments_url: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + truncated: + type: boolean + gist-comment: + title: Gist Comment + description: A comment made to a gist. + type: object + properties: + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDExOkdpc3RDb21tZW50MQ== + url: + type: string + format: uri + examples: + - https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: + description: The comment text. + type: string + maxLength: 65535 + examples: + - Body of the attachment + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-18T23:23:56Z' + updated_at: + type: string + format: date-time + examples: + - '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 + examples: + - https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: + type: string + examples: + - 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + committed_at: + type: string + format: date-time + examples: + - '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 + examples: + - C + source: + type: string + examples: + - | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + required: + - name + - source + license: + title: License + description: License + type: object + properties: + key: + type: string + examples: + - mit + name: + type: string + examples: + - MIT License + spdx_id: + type: + - string + - 'null' + examples: + - MIT + url: + type: + - string + - 'null' + format: uri + examples: + - https://api.github.com/licenses/mit + node_id: + type: string + examples: + - MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + examples: + - http://choosealicense.com/licenses/mit/ + description: + type: string + examples: + - 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 + examples: + - 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 + items: + type: string + examples: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + conditions: + type: array + items: + type: string + examples: + - include-copyright + limitations: + type: array + items: + type: string + examples: + - no-liability + body: + type: string + examples: + - |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 + examples: + - true + required: + - key + - name + - url + - spdx_id + - node_id + - html_url + - description + - implementation + - permissions + - conditions + - limitations + - body + - featured + ghes-get-ssh: + type: array + items: + type: object + properties: + key: + type: string + format: ssh-key + description: The full public key + fingerprint: + type: string + format: ssh-key fingerprint + description: The fingerprint of the key + ghes-set-ssh-request: + title: Set SSH key + type: object + properties: + key: + description: The public SSH key to add to the `authorized_keys` file. + type: string + required: + - key + ghes-set-ssh-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + description: Hostname of the node where the SSH key was added. + uuid: + type: string + format: uuid + description: UUID of the SSH key that was added. + message: + type: string + description: Message indicating the result of the SSH key addition. + error: + type: string + description: Error message indicating the reason for the SSH key addition + failure. This field is only present if the SSH key addition failed. + modified: + type: boolean + description: Whether the SSH key was already present on the `authorized_keys` + file. + ghes-delete-ssh-request: + title: Set SSH key + type: object + properties: + key: + description: The public SSH key to remove from the `authorized_keys` file. + type: string + required: + - key + ghes-delete-ssh-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + description: Hostname of the node where the SSH key was removed. + uuid: + type: string + format: uuid + description: UUID of the SSH key that was removed. + message: + type: string + description: Message indicating the result of the SSH key removal. + error: + type: string + description: Error message indicating the reason for the SSH key removal + failure. This field is only present if the SSH key removal failed. + ghes-checks-result-indicator: + type: string + enum: + - OK + - FAILED + ghes-checks-system-requirements: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + roles_status: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + role: + type: string + ghes-cluster-status-indicator: + type: string + enum: + - UNKNOWN + - OK + - WARNING + - CRITICAL + ghes-cluster-status: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + services: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + name: + type: string + details: + type: string + ghes-config-init-request: + title: Initialize configuration with license upload + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + password: + type: string + description: The root site administrator password. + required: + - license + - password + ghes-license-info: + type: object + properties: + advancedSecurityEnabled: + description: Whether the GitHub Advanced Security feature is enabled. + type: boolean + advancedSecuritySeats: + description: If the GitHub Advanced Security feature is enabled, the seat + count. + type: integer + clusterSupport: + description: Whether the cluster support feature is enabled. + type: boolean + company: + description: The company under which the license is issued. + type: string + croquetSupport: + description: Whether the Github Connect feature is enabled. + type: boolean + customTerms: + description: Whether this license is issued under custom terms. + type: boolean + evaluation: + description: Wheter this license is issued as an evaluation license. + type: boolean + expireAt: + description: The expiration date of the license. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + insightsEnabled: + description: Whether the insights feature is enabled. + type: boolean + insightsExpireAt: + description: If the insights feature is enabled, the expiration date. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + learningLabEvaluationExpires: + description: If the learning lab feature is enabled, the expiration date. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + learningLabSeats: + description: If the learning lab feature is enabled, the seat count. + type: integer + perpetual: + description: Whether the perpetual feature is enabled. + type: boolean + referenceNumber: + description: The unique reference number of the license. + type: string + seats: + description: If the license is issued with limited seating, the seat count. + type: integer + sshAllowed: + description: Whether the SSH feature is enabled. + type: boolean + supportKey: + description: The support key of the license. + type: string + unlimitedSeating: + description: Whether the license is issued with unlimited seat count. + type: boolean + ghes-upload-license-request: + title: License upload form + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + required: + - license + ghes-license-check: + type: object + properties: + status: + description: The license status of the currently active enterprise license. + type: string + enum: + - valid + - invalid + - expired + - cluster mode not supported + ghes-cluster-topology: + type: string + enum: + - SingleNode + - Ha + - Cluster + ghes-cluster-roles: + type: string + enum: + - Blank + - ActionsServer + - ConsulServer + - ElasticsearchServer + - GitServer + - JobServer + - LaunchServer + - MemcacheServer + - MetricsServer + - MssqlServer + - MysqlServer + - PagesServer + - RedisServer + - StorageServer + - WebServer + ghes-config-nodes: + type: object + properties: + topology: + "$ref": "#/components/schemas/ghes-cluster-topology" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + uuid: + type: string + replica: + type: boolean + cluster_roles: + type: array + items: + "$ref": "#/components/schemas/ghes-cluster-roles" + ghes-get-settings: + type: object + properties: + private_mode: + type: boolean + public_pages: + type: boolean + subdomain_isolation: + type: boolean + signup_enabled: + type: boolean + github_hostname: + type: string + identicons_host: + type: string + http_proxy: + type: + - string + - 'null' + auth_mode: + type: string + expire_sessions: + type: boolean + admin_password: + type: + - string + - 'null' + configuration_id: + type: integer + configuration_run_count: + type: integer + avatar: + type: object + properties: + enabled: + type: boolean + uri: + type: string + customer: + type: object + properties: + name: + type: string + email: + type: string + uuid: + type: string + secret_key_data: + type: string + public_key_data: + type: string + license: + type: object + properties: + seats: + type: integer + evaluation: + type: boolean + perpetual: + type: boolean + unlimited_seating: + type: boolean + support_key: + type: string + ssh_allowed: + type: boolean + cluster_support: + type: boolean + expire_at: + type: string + github_ssl: + type: object + properties: + enabled: + type: boolean + cert: + type: + - string + - 'null' + key: + type: + - string + - 'null' + ldap: + type: object + properties: + host: + type: + - string + - 'null' + port: + type: integer + base: + type: array + items: + type: string + uid: + type: + - string + - 'null' + bind_dn: + type: + - string + - 'null' + password: + type: + - string + - 'null' + method: + type: string + search_strategy: + type: string + user_groups: + type: array + items: + type: string + admin_group: + type: + - string + - 'null' + virtual_attribute_enabled: + type: boolean + recursive_group_search: + type: boolean + posix_support: + type: boolean + user_sync_emails: + type: boolean + user_sync_keys: + type: boolean + user_sync_interval: + type: integer + team_sync_interval: + type: integer + sync_enabled: + type: boolean + reconciliation: + type: object + properties: + user: + type: + - string + - 'null' + org: + type: + - string + - 'null' + profile: + type: object + properties: + uid: + type: string + name: + type: + - string + - 'null' + mail: + type: + - string + - 'null' + key: + type: + - string + - 'null' + cas: + type: object + properties: + url: + type: + - string + - 'null' + saml: + type: object + properties: + sso_url: + type: + - string + - 'null' + certificate: + type: + - string + - 'null' + certificate_path: + type: + - string + - 'null' + issuer: + type: + - string + - 'null' + idp_initiated_sso: + type: boolean + disable_admin_demote: + type: boolean + github_oauth: + type: object + properties: + client_id: + type: string + client_secret: + type: string + organization_name: + type: string + organization_team: + type: string + smtp: + type: object + properties: + enabled: + type: boolean + address: + type: string + authentication: + type: string + port: + type: string + domain: + type: string + username: + type: string + user_name: + type: string + enable_starttls_auto: + type: boolean + password: + type: string + discard-to-noreply-address: + type: boolean + support_address: + type: string + support_address_type: + type: string + noreply_address: + type: string + ntp: + type: object + properties: + primary_server: + type: string + secondary_server: + type: string + timezone: + type: + - string + - 'null' + snmp: + type: object + properties: + enabled: + type: boolean + community: + type: string + syslog: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + protocol_name: + type: string + assets: + type: + - string + - 'null' + pages: + type: object + properties: + enabled: + type: boolean + collectd: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + port: + type: integer + encryption: + type: + - string + - 'null' + username: + type: + - string + - 'null' + password: + type: + - string + - 'null' + mapping: + type: object + properties: + enabled: + type: boolean + tileserver: + type: + - string + - 'null' + basemap: + type: string + token: + type: + - string + - 'null' + load_balancer: + type: + - string + - 'null' + ghes-get-maintenance: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + uuid: + type: string + format: uuid + status: + type: string + enum: + - 'on' + - 'off' + - scheduled + scheduled_time: + type: string + format: date + connection_services: + type: array + items: + type: object + properties: + name: + type: string + number: + type: integer + can_unset_maintenance: + type: boolean + ip_exception_list: + type: array + items: + type: string + format: ip/cidr + maintenance_mode_message: + type: string + ghes-set-maintenance-request: + title: Set Maintenance mode + type: object + properties: + enabled: + description: Whether to enable maintenance mode. + type: boolean + uuid: + description: The UUID of the node to target. This parameter is incompatible + with maintenance mode scheduling. Only use `uuid` if the value of `when` + is empty or `now`. + type: string + format: uuid + when: + description: The time to enable maintenance mode. If this parameter is empty + or set to `now`, maintenance mode is enabled immediately. Otherwise, maintenance + mode is enabled at the specified time. The format is ISO 8601. + type: string + format: date-time + examples: + - '2006-01-02T15:04:05+00:00' + ip_exception_list: + description: The list of IP addresses to exclude from maintenance mode. + IPv4, IPv6, and CIDR addresses are supported. + type: array + items: + type: string + format: ip/cidr + examples: + - '["1.1.1.1","192.168.1.0/24"]' + maintenance_mode_message: + description: The message to display to users when maintenance mode is enabled. + type: string + required: + - enabled + ghes-set-maintenance-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + uuid: + type: string + format: uuid + message: + type: string + error: + type: string + ghes-replication-status-indicator: + type: string + enum: + - UNKNOWN + - OK + - WARNING + - CRITICAL + ghes-replication-status: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + services: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + name: + type: string + details: + type: string + ghes-version: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + version: + type: object + properties: + version: + type: string + pattern: "[0-9]\\.[0-9]{2}\\.[0-9]" + platform: + type: string + enum: + - ami + - azure + - esx + - gce + - hyperv + - kvm + build_id: + type: string + pattern: "[0-9a-f]{8}" + build_date: + type: string + format: date + api-overview: + title: Api Overview + description: Api Overview + type: object + properties: + verifiable_password_authentication: + type: boolean + examples: + - true + packages: + type: array + items: + type: string + examples: + - 192.0.2.1 + domains: + type: object + properties: + website: + type: array + items: + type: string + examples: + - example.com + codespaces: + type: array + items: + type: string + examples: + - example.com + copilot: + type: array + items: + type: string + examples: + - example.com + packages: + type: array + items: + type: string + examples: + - example.com + actions: + type: array + items: + type: string + examples: + - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + examples: + - example + services: + type: array + items: + type: string + examples: + - example.com + installed_version: + type: string + examples: + - 3.13.0 + required: + - verifiable_password_authentication + security-and-analysis: + type: + - object + - 'null' + properties: + advanced_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 + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: + - string + - 'null' + language: + type: + - string + - 'null' + 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 + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + examples: + - 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 + - 'null' + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + node_id: + type: string + forks: + type: integer + examples: + - 0 + open_issues: + type: integer + examples: + - 0 + watchers: + type: integer + examples: + - 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + examples: + - false + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + 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 + 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 + - 'null' + url: + type: string + subscription_url: + type: string + examples: + - 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 + examples: + - true + ignored: + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/notifications/threads/1/subscription + thread_url: + type: string + format: uri + examples: + - https://api.github.com/notifications/threads/1 + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/1 + required: + - created_at + - ignored + - reason + - url + - subscribed + organization-custom-repository-role: + title: Organization Custom Repository Role + description: Custom repository roles created by organization owners + type: object + properties: + id: + description: The unique identifier of the custom role. + type: integer + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + organization: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - name + - base_role + - permissions + - organization + - created_at + - updated_at + organization-full: + title: Organization Full + description: Organization Full + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + name: + type: string + examples: + - github + company: + type: string + examples: + - GitHub + blog: + type: string + format: uri + examples: + - https://github.com/blog + location: + type: string + examples: + - San Francisco + email: + type: string + format: email + examples: + - octocat@github.com + twitter_username: + type: + - string + - 'null' + examples: + - github + is_verified: + type: boolean + examples: + - true + has_organization_projects: + type: boolean + examples: + - true + has_repository_projects: + type: boolean + examples: + - true + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + type: + type: string + examples: + - Organization + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + private_gists: + type: + - integer + - 'null' + examples: + - 81 + disk_usage: + type: + - integer + - 'null' + examples: + - 10000 + collaborators: + type: + - integer + - 'null' + description: |- + The number of collaborators on private repositories. + + This field may be null if the number of private repositories is over 50,000. + examples: + - 8 + billing_email: + type: + - string + - 'null' + format: email + examples: + - org@example.com + 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 + - 'null' + members_can_create_repositories: + type: + - boolean + - 'null' + examples: + - true + two_factor_requirement_enabled: + type: + - boolean + - 'null' + examples: + - true + members_allowed_repository_creation_type: + type: string + examples: + - all + members_can_create_public_repositories: + type: boolean + examples: + - true + members_can_create_private_repositories: + type: boolean + examples: + - true + members_can_create_internal_repositories: + type: boolean + examples: + - true + members_can_create_pages: + type: boolean + examples: + - true + members_can_create_public_pages: + type: boolean + examples: + - true + members_can_create_private_pages: + type: boolean + examples: + - true + members_can_fork_private_repositories: + type: + - boolean + - 'null' + examples: + - false + web_commit_signoff_required: + type: boolean + examples: + - false + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + 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. + examples: + - false + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + 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. + examples: + - false + dependabot_security_updates_enabled_for_new_repositories: + type: boolean + description: |- + 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. + examples: + - false + dependency_graph_enabled_for_new_repositories: + type: boolean + description: |- + 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. + examples: + - false + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + 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. + examples: + - false + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: |- + 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. + examples: + - false + 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. + examples: + - false + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: An optional URL string to display to contributors who are blocked + from pushing a secret. + examples: + - https://github.com/test-org/test-repo/blob/main/README.md + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + archived_at: + type: + - string + - 'null' + format: date-time + 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 + 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 + examples: + - 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 + examples: + - 2322142 + active_caches_count: + description: The number of active caches in the repository. + type: integer + examples: + - 3 + required: + - full_name + - active_caches_size_in_bytes + - active_caches_count + 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 + 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" + required: + - enabled_repositories + 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 + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories + 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. + type: string + examples: + - SECRET_TOKEN + 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 + examples: + - 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 + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + examples: + - 2 + url: + type: string + examples: + - https://api.github.com/user/keys/2 + title: + type: string + examples: + - ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + examples: + - '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. + type: string + examples: + - USERNAME + value: + description: The value of the variable. + type: string + examples: + - octocat + 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 + examples: + - '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 + examples: + - '2019-01-24T22:45:36.000Z' + visibility: + description: Visibility of a variable + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/org/variables/USERNAME/repositories + required: + - name + - value + - created_at + - updated_at + - visibility + announcement-user-dismissible: + type: + - boolean + - 'null' + description: Whether an announcement can be dismissed by the user. + default: false + examples: + - false + announcement-banner: + title: Announcement Banner + description: Announcement at either the repository, organization, or enterprise + level + type: object + properties: + announcement: + "$ref": "#/components/schemas/announcement-message" + expires_at: + "$ref": "#/components/schemas/announcement-expiration" + user_dismissible: + "$ref": "#/components/schemas/announcement-user-dismissible" + required: + - announcement + - expires_at + - user_dismissible + code-scanning-alert-severity: + type: string + description: Severity of a code scanning alert. + enum: + - critical + - high + - medium + - low + - warning + - note + - error + organization-custom-repository-role-create-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + required: + - name + - base_role + - permissions + organization-custom-repository-role-update-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + 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. + type: string + examples: + - SECRET_TOKEN + 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 + examples: + - 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 + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + package: + title: Package + description: A software package + type: object + properties: + id: + description: Unique identifier of the package. + type: integer + examples: + - 1 + name: + description: The name of the package. + type: string + examples: + - super-linter + package_type: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + examples: + - docker + url: + type: string + examples: + - https://api.github.com/orgs/github/packages/container/super-linter + html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/package/super-linter + version_count: + description: The number of versions of the package. + type: integer + examples: + - 1 + visibility: + type: string + enum: + - private + - public + examples: + - private + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + external-group: + title: ExternalGroup + description: Information about an external group's usage and its members + type: object + required: + - group_id + - group_name + - teams + - members + properties: + group_id: + description: The internal ID of the group + type: integer + examples: + - 1 + group_name: + description: The display name for the group + type: string + examples: + - group-azuread-test + updated_at: + description: The date when the group was last updated_at + type: string + examples: + - 2021-01-03 22:27:15:000 -700 + teams: + description: An array of teams linked to this group + type: array + items: + type: object + required: + - team_id + - team_name + properties: + team_id: + description: The id for a team + type: integer + examples: + - 1 + team_name: + description: The name of the team + type: string + examples: + - team-test + examples: + - team_id: 1 + team_name: team-test + - team_id: 2 + team_name: team-test2 + members: + description: An array of external members linked to this group + type: array + items: + type: object + required: + - member_id + - member_login + - member_name + - member_email + properties: + member_id: + description: The internal user ID of the identity + type: integer + examples: + - 1 + member_login: + description: The handle/login for the user + type: string + examples: + - mona-lisa_eocsaxrs + member_name: + description: The user display name/profile name + type: string + examples: + - Mona Lisa + member_email: + description: An email attached to a user + type: string + examples: + - mona_lisa@github.com + examples: + - member_id: 1 + member_login: mona-lisa_eocsaxrs + member_name: Mona Lisa + member_email: mona_lisa@github.com + - member_id: 2 + member_login: octo-lisa_eocsaxrs + member_name: Octo Lisa + member_email: octo_lisa@github.com + external-groups: + title: ExternalGroups + description: A list of external groups available to be connected to a team + type: object + properties: + groups: + description: An array of external groups available to be mapped to a team + type: array + items: + type: object + required: + - group_id + - group_name + - updated_at + properties: + group_id: + description: The internal ID of the group + type: integer + examples: + - 1 + group_name: + description: The display name of the group + type: string + examples: + - group-azuread-test + updated_at: + description: The time of the last update for this group + type: string + examples: + - 2019-06-03 22:27:15:000 -700 + examples: + - group_id: 1 + group_name: group-azuread-test + updated_at: 2021-01-03 22:27:15:000 -700 + - group_id: 2 + group_name: group-azuread-test2 + updated_at: 2021-06-03 22:27:15:000 -700 + org-hook: + title: Org Hook + description: Org Hook + type: object + properties: + id: + type: integer + examples: + - 1 + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1 + ping_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1/deliveries + name: + type: string + examples: + - web + events: + type: array + items: + type: string + examples: + - push + - pull_request + active: + type: boolean + examples: + - true + config: + type: object + properties: + url: + type: string + examples: + - '"http://example.com/2"' + insecure_ssl: + type: string + examples: + - '"0"' + content_type: + type: string + examples: + - '"form"' + secret: + type: string + examples: + - '"********"' + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + type: + type: string + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + org-membership: + title: Org Membership + description: Org Membership + type: object + properties: + url: + type: string + format: uri + examples: + - 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. + enum: + - active + - pending + examples: + - active + role: + type: string + description: The user's membership type in the organization. + enum: + - admin + - member + - billing_manager + examples: + - admin + organization_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat + organization: + "$ref": "#/components/schemas/organization-simple" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 79 + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + guid: + type: string + examples: + - 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: + type: string + examples: + - pending + lock_repositories: + type: boolean + examples: + - 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 + examples: + - https://api.github.com/orgs/octo-org/migrations/79 + created_at: + type: string + format: date-time + examples: + - '2015-07-06T15:33:38-07:00' + updated_at: + type: string + format: date-time + examples: + - '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 + 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 + examples: + - 1 + name: + description: The name of the package version. + type: string + examples: + - latest + url: + type: string + examples: + - https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 + package_html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/package/super-linter + html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/super-linter/786068 + license: + type: string + examples: + - MIT + description: + type: string + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + deleted_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + metadata: + type: object + title: Package Version Metadata + properties: + package_type: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + examples: + - docker + 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 + - 'null' + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + 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-pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + configuration_url: + type: string + allow_downstream_configuration: + type: boolean + project: + title: Project + description: Projects are a way to organize columns and cards of work. + type: object + properties: + owner_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test + url: + type: string + format: uri + examples: + - https://api.github.com/projects/1002604 + html_url: + type: string + format: uri + examples: + - https://github.com/api-playground/projects-test/projects/12 + columns_url: + type: string + format: uri + examples: + - https://api.github.com/projects/1002604/columns + id: + type: integer + examples: + - 1002604 + node_id: + type: string + examples: + - MDc6UHJvamVjdDEwMDI2MDQ= + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + number: + type: integer + examples: + - 1 + state: + description: State of the project; either 'open' or 'closed' + type: string + examples: + - open + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + organization_permission: + description: The baseline permission that all organization members have + on this project. Only present if owner is an organization. + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. Only present + if owner is an organization. + type: boolean + required: + - id + - node_id + - number + - name + - body + - state + - url + - html_url + - owner_url + - creator + - columns_url + - created_at + - updated_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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - org_actors + - org_and_repo_actors + - + description: Who can edit the values of the property + examples: + - org_actors + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + 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 + type: + - 'null' + - string + - array + 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 + examples: + - 1296269 + repository_name: + type: string + examples: + - Hello-World + repository_full_name: + type: string + examples: + - 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 + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + examples: + - citizen_code_of_conduct + name: + type: string + examples: + - Citizen Code of Conduct + html_url: + type: + - string + - 'null' + format: uri + examples: + - 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 + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + type: boolean + examples: + - true + topics: + type: array + items: + type: string + examples: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + examples: + - true + has_projects: + type: boolean + examples: + - true + has_wiki: + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + type: boolean + examples: + - true + has_discussions: + type: boolean + examples: + - true + 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 + examples: + - public + pushed_at: + type: string + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '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 + examples: + - true + template_repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository" + temp_clone_token: + type: + - string + - 'null' + allow_squash_merge: + type: boolean + examples: + - true + allow_auto_merge: + type: boolean + examples: + - false + delete_branch_on_merge: + type: boolean + examples: + - false + allow_merge_commit: + type: boolean + examples: + - true + allow_update_branch: + type: boolean + examples: + - true + use_squash_pr_title_as_default: + type: boolean + examples: + - false + 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). + examples: + - PR_TITLE + 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. + examples: + - PR_BODY + 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). + examples: + - PR_TITLE + 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. + examples: + - PR_BODY + allow_forking: + type: boolean + examples: + - true + web_commit_signoff_required: + type: boolean + examples: + - false + subscribers_count: + type: integer + examples: + - 42 + network_count: + type: integer + examples: + - 0 + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + repository-fine-grained-permission: + title: Repository Fine-Grained Permission + description: A fine-grained permission that protects repository resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + 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 not available for the `repository` target. + 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_id + - actor_type + - bypass_mode + properties: + actor_id: + type: integer + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + 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. + enum: + - always + - pull_request + 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. + 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. + 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-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-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 the same + syntax as `.gitignore` files. + 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_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id + 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: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string + 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: + - 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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-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: + 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-workflows" + 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 + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + 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 + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + type: + - 'null' + - object + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + 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 + examples: + - '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 + 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 + - 'null' + description: The number that identifies the user. + actor_name: + type: + - string + - 'null' + 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 + examples: + - '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 + - 'null' + enum: + - pass + - fail + 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 + - 'null' + description: The ID of the rule source. + name: + type: + - string + - 'null' + 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 + - 'null' + description: The detailed failure message for the rule. Null if the + rule passed. + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + 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 + - 'null' + 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 + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + team-organization: + title: Team Organization + description: Team Organization + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + name: + type: string + examples: + - github + company: + type: string + examples: + - GitHub + blog: + type: string + format: uri + examples: + - https://github.com/blog + location: + type: string + examples: + - San Francisco + email: + type: string + format: email + examples: + - octocat@github.com + twitter_username: + type: + - string + - 'null' + examples: + - github + is_verified: + type: boolean + examples: + - true + has_organization_projects: + type: boolean + examples: + - true + has_repository_projects: + type: boolean + examples: + - true + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + type: + type: string + examples: + - Organization + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + private_gists: + type: + - integer + - 'null' + examples: + - 81 + disk_usage: + type: + - integer + - 'null' + examples: + - 10000 + collaborators: + type: + - integer + - 'null' + examples: + - 8 + billing_email: + type: + - string + - 'null' + format: email + examples: + - org@example.com + 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 + - 'null' + members_can_create_repositories: + type: + - boolean + - 'null' + examples: + - true + two_factor_requirement_enabled: + type: + - boolean + - 'null' + examples: + - true + members_allowed_repository_creation_type: + type: string + examples: + - all + members_can_create_public_repositories: + type: boolean + examples: + - true + members_can_create_private_repositories: + type: boolean + examples: + - true + members_can_create_internal_repositories: + type: boolean + examples: + - true + members_can_create_pages: + type: boolean + examples: + - true + members_can_create_public_pages: + type: boolean + examples: + - true + members_can_create_private_pages: + type: boolean + examples: + - true + members_can_fork_private_repositories: + type: + - boolean + - 'null' + examples: + - false + web_commit_signoff_required: + type: boolean + examples: + - false + updated_at: + type: string + format: date-time + archived_at: + type: + - string + - 'null' + format: date-time + 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 + 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 + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + name: + description: Name of the team + type: string + examples: + - Developers + slug: + type: string + examples: + - justice-league + description: + type: + - string + - 'null' + examples: + - A great team. + privacy: + description: The level of privacy this team should have + type: string + enum: + - closed + - secret + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + enum: + - notifications_enabled + - notifications_disabled + examples: + - notifications_enabled + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - push + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + members_count: + type: integer + examples: + - 3 + repos_count: + type: integer + examples: + - 10 + created_at: + type: string + format: date-time + examples: + - '2017-07-14T16:53:42Z' + updated_at: + type: string + format: date-time + examples: + - '2017-08-17T12:37:15Z' + organization: + "$ref": "#/components/schemas/team-organization" + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - created_at + - updated_at + - members_count + - repos_count + - organization + team-discussion: + title: Team Discussion + description: A team discussion is a persistent record of a free-form conversation + within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the discussion. + type: string + examples: + - Please suggest improvements to our workflow in comments. + body_html: + type: string + examples: + - "

Hi! This is an area for us to collaborate as a team

" + body_version: + description: 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. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + comments_count: + type: integer + examples: + - 0 + comments_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1/comments + created_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: + type: string + examples: + - MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: + description: The unique sequence number of a team discussion. + type: integer + examples: + - 42 + pinned: + description: Whether or not this discussion should be pinned for easy retrieval. + type: boolean + examples: + - true + private: + description: Whether or not this discussion should be restricted to team + members and organization owners. + type: boolean + examples: + - true + team_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027 + title: + description: The title of the discussion. + type: string + examples: + - How can we improve our workflow? + updated_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - comments_count + - comments_url + - created_at + - last_edited_at + - html_url + - pinned + - private + - node_id + - number + - team_url + - title + - updated_at + - url + team-discussion-comment: + title: Team Discussion Comment + description: A reply to a discussion within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the comment. + type: string + examples: + - I agree with this suggestion. + body_html: + type: string + examples: + - "

Do you like apples?

" + body_version: + description: 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. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + created_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + discussion_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: + type: string + examples: + - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: + description: The unique sequence number of a team discussion comment. + type: integer + examples: + - 42 + updated_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - created_at + - last_edited_at + - discussion_url + - html_url + - node_id + - number + - updated_at + - url + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + 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 + type: string + examples: + - member + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + team-project: + title: Team Project + description: A team's access to a project. + type: object + properties: + owner_url: + type: string + url: + type: string + html_url: + type: string + columns_url: + type: string + id: + type: integer + node_id: + type: string + name: + type: string + body: + type: + - string + - 'null' + number: + type: integer + state: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + updated_at: + type: string + organization_permission: + description: The organization permission for this project. Only present + when owner is an organization. + type: string + private: + description: Whether the project is private or not. Only present when owner + is an organization. + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + - permissions + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - admin + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 80 + size: + type: integer + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + examples: + - false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + examples: + - 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 + project-card: + title: Project Card + description: Project cards represent a scope of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/cards/1478 + id: + description: The project card's ID + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDExOlByb2plY3RDYXJkMTQ3OA== + note: + type: + - string + - 'null' + examples: + - Add payload for delete Project column + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:21:06Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:20:22Z' + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + column_name: + type: string + project_id: + type: string + column_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + content_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + required: + - id + - node_id + - note + - url + - column_url + - project_url + - creator + - created_at + - updated_at + project-column: + title: Project Column + description: Project columns contain cards of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + cards_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367/cards + id: + description: The unique identifier of the project column + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEzOlByb2plY3RDb2x1bW4zNjc= + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:18:44Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:22:28Z' + required: + - id + - node_id + - url + - project_url + - cards_url + - name + - created_at + - updated_at + project-collaborator-permission: + title: Project Collaborator Permission + description: Project Collaborator Permission + type: object + properties: + permission: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - permission + - user + 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" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + examples: + - AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + examples: + - 12345 + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + examples: + - 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 + - 'null' + format: date-time + expires_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + workflow_run: + type: + - object + - 'null' + properties: + id: + type: integer + examples: + - 10 + repository_id: + type: integer + examples: + - 42 + head_repository_id: + type: integer + examples: + - 42 + head_branch: + type: string + examples: + - main + head_sha: + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-usage-policy-for-repository: + title: Actions cache usage policy for repository + description: GitHub Actions cache usage policy for repository. + type: object + properties: + repo_cache_size_limit_in_gb: + description: The size limit for the sum of all caches, in gigabytes. + type: integer + examples: + - 14 + required: + - repo_cache_size_limit_in_gb + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + examples: + - 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + examples: + - 2 + ref: + type: string + examples: + - refs/heads/main + key: + type: string + examples: + - Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + examples: + - 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + examples: + - 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. + type: integer + examples: + - 21 + run_id: + description: The id of the associated workflow run. + type: integer + examples: + - 5 + run_url: + type: string + examples: + - 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. + examples: + - 1 + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + status: + description: The phase of the lifecycle that the job is currently in. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - success + created_at: + description: The time that the job created, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + started_at: + description: The time that the job started, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + name: + description: The name of the job. + type: string + examples: + - test-coverage + 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. + type: string + enum: + - queued + - in_progress + - completed + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + examples: + - success + name: + description: The name of the job. + type: string + examples: + - test-coverage + number: + type: integer + examples: + - 1 + started_at: + description: The time that the step started, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + check_run_url: + type: string + examples: + - 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. + examples: + - self-hosted + - foo + - bar + runner_id: + type: + - integer + - 'null' + 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.) + examples: + - 1 + runner_name: + type: + - string + - 'null' + 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.) + examples: + - my runner + runner_group_id: + type: + - integer + - 'null' + 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.) + examples: + - 2 + runner_group_name: + type: + - string + - 'null' + 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.) + examples: + - my runner group + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + examples: + - Build + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + examples: + - 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. + type: string + examples: + - SECRET_TOKEN + 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. + type: string + examples: + - USERNAME + value: + description: The value of the variable. + type: string + examples: + - octocat + 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 + examples: + - '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 + examples: + - '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" + 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 + 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. `enterprise` level access allows sharing across the enterprise. + enum: + - none + - user + - organization + - enterprise + 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 + 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 + simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + timestamp: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + author: + type: + - object + - 'null' + description: Information about the Git author + properties: + name: + description: Name of the commit's author + type: string + examples: + - Monalisa Octocat + email: + description: Git email address of the commit's author + type: string + format: email + examples: + - monalisa.octocat@example.com + required: + - name + - email + committer: + type: + - object + - 'null' + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + type: string + examples: + - Monalisa Octocat + email: + description: Git email address of the commit's committer + type: string + format: email + examples: + - monalisa.octocat@example.com + required: + - name + - email + required: + - id + - tree_id + - message + - timestamp + - author + - committer + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + examples: + - 5 + name: + type: + - string + - 'null' + description: The name of the workflow run. + examples: + - Build + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + examples: + - 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + examples: + - MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that points to the version of the + workflow being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + path: + description: The full path of the workflow + type: string + examples: + - octocat/octo-repo/.github/workflows/ci.yml@main + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + examples: + - 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was re-run. + examples: + - 1 + referenced_workflows: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/referenced-workflow" + event: + type: string + examples: + - push + status: + type: + - string + - 'null' + examples: + - completed + conclusion: + type: + - string + - 'null' + examples: + - neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + examples: + - 5 + url: + type: string + description: The URL to the workflow run. + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + examples: + - 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 + - 'null' + 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + description: The URL to the previous attempted run of this workflow, if + one exists. + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-commit" + repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository_id: + type: integer + examples: + - 5 + display_title: + type: string + 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. + examples: + - Simple 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. + type: integer + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - 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. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO + 8601 format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + state: + description: Whether deployment to the environment(s) was approved or rejected + or pending (with comments) + enum: + - approved + - rejected + - pending + type: string + examples: + - approved + user: + "$ref": "#/components/schemas/simple-user" + comment: + type: string + description: The comment submitted with the deployment review + examples: + - 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 + examples: + - 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 + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + examples: + - 30 + wait_timer_started_at: + description: The time that the wait timer began. + format: date-time + type: + - string + - 'null' + examples: + - '2020-11-23T22:00:40Z' + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + sha: + type: string + examples: + - a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + type: string + examples: + - topic-branch + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + payload: + oneOf: + - type: object + additionalProperties: true + - type: string + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - 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.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDg6V29ya2Zsb3cxMg== + name: + type: string + examples: + - CI + path: + type: string + examples: + - ruby.yaml + state: + type: string + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + examples: + - active + created_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + url: + type: string + examples: + - https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + examples: + - https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + examples: + - https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + activity: + title: Activity + description: Activity + type: object + properties: + id: + type: integer + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: + type: string + description: The SHA of the commit before the activity. + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + after: + type: string + description: The SHA of the commit after the activity. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + ref: + type: string + description: The full Git reference, formatted as `refs/heads/`. + examples: + - refs/heads/main + timestamp: + type: string + format: date-time + description: The time when the activity occurred. + examples: + - '2011-01-26T19:06:43Z' + activity_type: + type: string + enum: + - push + - force_push + - branch_deletion + - branch_creation + - pr_merge + - merge_queue_merge + description: The type of the activity that was performed. + examples: + - force_push + actor: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 3 + key_prefix: + description: The prefix of a key that is linkified. + type: string + examples: + - TICKET- + url_template: + description: A template for the target URL that is generated if a key was + found. + type: string + examples: + - https://example.com/TICKET?query= + is_alphanumeric: + description: Whether this autolink reference matches alphanumeric characters. + If false, this autolink reference only matches numeric characters. + type: boolean + examples: + - true + required: + - id + - key_prefix + - url_template + - is_alphanumeric + check-automated-security-fixes: + title: Check Automated Security Fixes + description: Check Automated Security Fixes + type: object + properties: + enabled: + type: boolean + description: Whether automated security fixes are enabled for the repository. + examples: + - true + paused: + type: boolean + description: Whether automated security fixes are paused for the repository. + examples: + - false + 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 + - 'null' + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"' + users_url: + type: string + examples: + - '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"' + teams_url: + type: string + examples: + - '"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 + examples: + - true + require_code_owner_reviews: + type: boolean + examples: + - true + required_approving_review_count: + type: integer + minimum: 0 + maximum: 6 + examples: + - 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 + default: false + examples: + - true + 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: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + html_url: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + members_url: + type: string + repositories_url: + type: string + parent: + type: + - string + - 'null' + 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 + examples: + - '""' + html_url: + type: string + examples: + - '"https://github.com/testorg-ea8ec76d71c3af4b"' + followers_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"' + following_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"' + gists_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"' + starred_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"' + subscriptions_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"' + organizations_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"' + received_events_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"' + type: + type: string + examples: + - '"Organization"' + site_admin: + type: boolean + examples: + - false + user_view_type: + type: string + examples: + - 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 + examples: + - '"branch/with/protection"' + protection_url: + type: string + examples: + - '"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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + examples: + - 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 + git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + examples: + - '"Chris Wanstrath"' + email: + type: string + examples: + - '"chris@ozmm.org"' + date: + type: string + examples: + - '"2007-10-29T02:42:39.000-07:00"' + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: + - string + - 'null' + signature: + type: + - string + - 'null' + required: + - verified + - reason + - payload + - signature + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + examples: + - bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + examples: + - file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + examples: + - added + additions: + type: integer + examples: + - 103 + deletions: + type: integer + examples: + - 21 + changes: + type: integer + examples: + - 124 + blob_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + examples: + - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + previous_filename: + type: string + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + examples: + - MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + message: + type: string + examples: + - Fix all the bugs + comment_count: + type: integer + examples: + - 0 + tree: + type: object + properties: + sha: + type: string + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + examples: + - 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: + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object + committer: + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object + parents: + type: array + items: + type: object + properties: + sha: + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + examples: + - 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 + examples: + - '"mas*"' + required_approving_review_count: + type: integer + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: + type: boolean + examples: + - true + contexts: + type: array + items: + type: string + examples: + - continuous-integration/travis-ci + checks: + type: array + items: + type: object + properties: + context: + type: string + examples: + - continuous-integration/travis-ci + app_id: + type: + - integer + - 'null' + required: + - context + - app_id + contexts_url: + type: string + format: uri + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - 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.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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. + type: integer + format: int64 + examples: + - 21 + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + external_id: + type: + - string + - 'null' + examples: + - '42' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + details_url: + type: + - string + - 'null' + examples: + - https://example.com + 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. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + examples: + - queued + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + started_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + output: + type: object + properties: + title: + type: + - string + - 'null' + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + 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. + type: string + examples: + - test-coverage + check_suite: + type: + - object + - 'null' + properties: + id: + type: integer + required: + - id + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - README.md + start_line: + type: integer + examples: + - 2 + end_line: + type: integer + examples: + - 2 + start_column: + type: + - integer + - 'null' + examples: + - 5 + end_column: + type: + - integer + - 'null' + examples: + - 10 + annotation_level: + type: + - string + - 'null' + examples: + - warning + title: + type: + - string + - 'null' + examples: + - Spell Checker + message: + type: + - string + - 'null' + examples: + - Check your spelling for 'banaas'. + raw_details: + type: + - string + - 'null' + examples: + - Do you mean 'bananas' or 'banana'? + blob_href: + type: string + required: + - path + - blob_href + - start_line + - end_line + - start_column + - end_column + - annotation_level + - title + - message + - raw_details + check-suite: + title: CheckSuite + description: A suite of checks performed on the code of a given code change + type: object + properties: + id: + type: integer + format: int64 + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + status: + type: + - string + - 'null' + 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. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + - + examples: + - completed + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - startup_failure + - stale + - + examples: + - neutral + url: + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/pull-request-minimal" + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + repository: + "$ref": "#/components/schemas/minimal-repository" + created_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + 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: + type: + - string + - 'null' + 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: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + 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: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + help: + type: + - string + - 'null' + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + type: + - string + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + 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-analysis-sarif-id: + type: string + description: An identifier for the upload. + examples: + - 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 + examples: + - 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 + examples: + - 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 + - 'null' + description: Next deletable analysis in chain, without last analysis deletion + confirmation + format: uri + readOnly: true + confirm_delete_url: + type: + - string + - 'null' + description: Next deletable analysis in chain, with last analysis deletion + confirmation + format: uri + readOnly: true + required: + - next_analysis_url + - confirm_delete_url + 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: + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - javascript + - python + - ruby + - typescript + - swift + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + updated_at: + description: Timestamp of latest configuration update. + type: + - string + - 'null' + format: date-time + examples: + - '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + type: + - string + - 'null' + enum: + - weekly + - + 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 + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + languages: + description: CodeQL languages to be analyzed. + type: array + items: + type: string + enum: + - 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. + 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-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)/.*$" + examples: + - 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/enterprise-server@3.13/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 + - 'null' + description: The REST API URL for getting the analyses associated with the + upload. + format: uri + readOnly: true + errors: + type: + - array + - 'null' + items: + type: string + description: Any errors that ocurred during processing of the delivery. + readOnly: true + 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 + examples: + - 7 + column: + description: The column number where this errors occurs. + type: integer + examples: + - 3 + source: + description: The contents of the line where the error occurs. + type: string + examples: + - "* user" + kind: + description: The type of error. + type: string + examples: + - Invalid owner + suggestion: + description: Suggested action to fix the error. This will usually + be `null`, but is provided for some common errors. + type: + - string + - 'null' + examples: + - 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 + examples: + - |- + Invalid owner on line 7: + + * user + ^ + path: + description: The path of the file where the error occured. + type: string + examples: + - ".github/CODEOWNERS" + required: + - line + - column + - kind + - message + - path + required: + - errors + collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + email: + type: + - string + - 'null' + name: + type: + - string + - 'null' + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - 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 + examples: + - admin + user_view_type: + type: string + examples: + - 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 + repository-collaborator-permission: + title: Repository Collaborator Permission + description: Repository Collaborator Permission + type: object + properties: + permission: + type: string + role_name: + type: string + examples: + - admin + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + position: + type: + - integer + - 'null' + line: + type: + - integer + - 'null' + commit_id: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + 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 + - 'null' + 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 + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + examples: + - 1347 + state: + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + type: string + examples: + - new-feature + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/team" + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + anyOf: + - type: 'null' + - "$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: + anyOf: + - type: 'null' + - "$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. + type: boolean + examples: + - false + 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 + simple-commit-status: + title: Simple Commit Status + type: object + properties: + description: + type: + - string + - 'null' + id: + type: integer + node_id: + type: string + state: + type: string + context: + type: string + target_url: + type: + - string + - 'null' + format: uri + required: + type: + - boolean + - 'null' + avatar_url: + type: + - string + - 'null' + 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 + - 'null' + id: + type: integer + node_id: + type: string + state: + type: string + description: + type: + - string + - 'null' + target_url: + type: + - string + - 'null' + context: + type: string + created_at: + type: string + updated_at: + type: string + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - url + - avatar_url + - id + - node_id + - state + - description + - target_url + - context + - created_at + - updated_at + - creator + commit-comparison: + title: Commit Comparison + description: Commit Comparison + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: + type: string + format: uri + examples: + - 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 + examples: + - ahead + ahead_by: + type: integer + examples: + - 4 + behind_by: + type: integer + examples: + - 5 + total_commits: + type: integer + examples: + - 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + examples: + - '"actual/actual.md"' + submodule_git_url: + type: string + examples: + - '"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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + 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 + 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 + - 'null' + payload: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The execution scope of the vulnerable dependency. + readOnly: true + enum: + - development + - runtime + - + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + dismissed_reason: + type: + - string + - 'null' + description: The reason that the alert was dismissed. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + - + dismissed_comment: + type: + - string + - 'null' + description: An optional comment associated with the alert's dismissal. + maxLength: 280 + fixed_at: + "$ref": "#/components/schemas/alert-fixed-at" + auto_dismissed_at: + "$ref": "#/components/schemas/alert-auto-dismissed-at" + 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. + type: string + examples: + - MY_ARTIFACTORY_PASSWORD + 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 + examples: + - path/to/package-lock.json + ecosystem: + type: string + examples: + - npm + name: + type: string + examples: + - "@actions/core" + version: + type: string + examples: + - 1.0.0 + package_url: + type: + - string + - 'null' + examples: + - pkg:/npm/%40actions/core@1.1.0 + license: + type: + - string + - 'null' + examples: + - MIT + source_repository_url: + type: + - string + - 'null' + examples: + - https://github.com/github/actions + vulnerabilities: + type: array + items: + type: object + properties: + severity: + type: string + examples: + - critical + advisory_ghsa_id: + type: string + examples: + - GHSA-rf4j-j272-fj86 + advisory_summary: + type: string + examples: + - A summary of the advisory. + advisory_url: + type: string + examples: + - 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 + description: The SPDX identifier for the SPDX document. + examples: + - SPDXRef-DOCUMENT + spdxVersion: + type: string + description: The version of the SPDX specification that this document + conforms to. + examples: + - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - '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/' + creationInfo: + type: object + properties: + created: + type: string + description: The date and time the SPDX document was created. + examples: + - '2021-11-03T00:00:00Z' + creators: + type: array + items: + type: string + examples: + - GitHub + description: The tools that were used to generate the SPDX document. + required: + - created + - creators + name: + type: string + description: The name of the SPDX document. + examples: + - github/github + dataLicense: + type: string + description: The license under which the SPDX document is licensed. + examples: + - CC0-1.0 + documentNamespace: + type: string + description: The namespace for the SPDX document. + examples: + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + packages: + type: array + items: + type: object + properties: + SPDXID: + type: string + description: A unique SPDX identifier for the package. + examples: + - SPDXRef-Package + name: + type: string + description: The name of the package. + examples: + - github/github + versionInfo: + type: string + description: |- + The version of the package. If the package does not have an exact version specified, + a version range is given. + examples: + - 1.0.0 + downloadLocation: + type: string + description: |- + The location where the package can be downloaded, + or NOASSERTION if this has not been determined. + examples: + - NOASSERTION + filesAnalyzed: + type: boolean + description: |- + Whether the package's file content has been subjected to + analysis during the creation of the SPDX document. + examples: + - false + licenseConcluded: + type: string + description: The license of the package as determined while creating + the SPDX document. + examples: + - MIT + licenseDeclared: + type: string + 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. + examples: + - NOASSERTION + supplier: + type: string + description: The distribution source of this package, or NOASSERTION + if this was not determined. + examples: + - NOASSERTION + copyrightText: + type: string + description: The copyright holders of the package, and any dates + present with those notices, if available. + examples: + - Copyright (c) 1985 GitHub.com + externalRefs: + type: array + items: + type: object + properties: + referenceCategory: + type: string + description: The category of reference to an external resource + this reference refers to. + examples: + - PACKAGE-MANAGER + referenceLocator: + type: string + description: A locator for the particular external resource + this reference refers to. + examples: + - pkg:gem/rails@6.0.1 + referenceType: + type: string + description: The category of reference to an external resource + this reference refers to. + examples: + - purl + required: + - referenceCategory + - referenceLocator + - referenceType + required: + - SPDXID + - name + - versionInfo + - downloadLocation + - filesAnalyzed + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + 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: + anyOf: + - type: string + - type: number + - type: boolean + type: + - 'null' + - string + - number + - 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. + pattern: "^pkg" + examples: + - pkg:/npm/%40actions/http-client@1.0.11 + 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. + enum: + - direct + - indirect + examples: + - direct + 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. + enum: + - runtime + - development + examples: + - runtime + dependencies: + type: array + description: Array of package-url (PURLs) of direct child dependencies. + items: + type: string + examples: + - "@actions/http-client" + additionalProperties: false + manifest: + type: object + properties: + name: + type: string + description: The name of the manifest. + examples: + - 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. + examples: + - "/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. + examples: + - 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. + examples: + - yourworkflowname_yourjobname + html_url: + type: string + description: The url for the job. + examples: + - 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 + minLength: 40 + maxLength: 40 + examples: + - ddc951f4b1293222421f2c8df679786153acf689 + ref: + description: The repository branch that triggered this snapshot. + type: string + pattern: "^refs/" + examples: + - refs/heads/main + detector: + type: object + description: A description of the detector used. + properties: + name: + type: string + description: The name of the detector used. + examples: + - docker buildtime detector + version: + type: string + description: The version of the detector used. + examples: + - 1.0.0 + url: + type: string + description: The url of the detector used. + examples: + - 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. + examples: + - '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 + examples: + - https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: + description: The state of the status. + enum: + - error + - failure + - inactive + - pending + - success + - queued + - in_progress + type: string + examples: + - success + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + description: + description: A short description of the status. + default: '' + type: string + maxLength: 140 + examples: + - Deployment finished successfully. + environment: + description: The environment of the deployment that the status is for. + default: '' + type: string + examples: + - production + target_url: + description: 'Closing down notice: the URL to associate with this status.' + default: '' + type: string + format: uri + examples: + - https://example.com/deployment/42/output + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + deployment_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/42 + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example + environment_url: + description: The URL for accessing your environment. + default: '' + type: string + format: uri + examples: + - https://staging.example.com/ + log_url: + description: The URL to associate with this status. + default: '' + type: string + format: uri + examples: + - https://example.com/deployment/42/output + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - state + - creator + - description + - deployment_url + - target_url + - repository_url + - url + - created_at + - updated_at + wait-timer: + type: integer + 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). + examples: + - 30 + deployment-branch-policy-settings: + type: + - object + - 'null' + 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`. + 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. + type: integer + format: int64 + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - 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. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO 8601 + format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + protection_rules: + type: array + description: Built-in deployment protection rules for the environment. + items: + anyOf: + - type: object + properties: + id: + type: integer + examples: + - 3515 + node_id: + type: string + examples: + - MDQ6R2F0ZTM1MTU= + type: + type: string + examples: + - wait_timer + wait_timer: + "$ref": "#/components/schemas/wait-timer" + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + examples: + - 3755 + node_id: + type: string + examples: + - MDQ6R2F0ZTM3NTU= + prevent_self_review: + type: boolean + description: Whether deployments to this environment can be approved + by the user who created the deployment. + examples: + - false + type: + type: string + examples: + - 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 + examples: + - 3515 + node_id: + type: string + examples: + - MDQ6R2F0ZTM1MTU= + type: + type: string + examples: + - 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 + description: Whether or not a user who created the job is prevented from approving + their own job. + examples: + - false + 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 + examples: + - 361471 + node_id: + type: string + examples: + - MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: + description: The name pattern that branches or tags must match in order + to deploy to the environment. + type: string + examples: + - release/* + type: + description: Whether this rule targets a branch or tag. + type: string + enum: + - branch + - tag + examples: + - branch + 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 + examples: + - release/* + type: + description: Whether this rule targets a branch or tag + type: string + enum: + - branch + - tag + examples: + - branch + 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 + examples: + - 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 + description: The unique identifier of the deployment protection rule integration. + examples: + - 3515 + slug: + type: string + description: The slugified name of the deployment protection rule integration. + examples: + - my-custom-app + integration_url: + type: string + description: The URL for the endpoint to get details about the app. + examples: + - https://api.github.com/apps/custom-app-slug + node_id: + type: string + description: The node ID for the deployment protection rule integration. + examples: + - MDQ6R2F0ZTM1MTU= + required: + - id + - slug + - integration_url + - node_id + deployment-protection-rule: + title: Deployment protection rule + description: Deployment protection rule + type: object + properties: + id: + type: integer + description: The unique identifier for the deployment protection rule. + examples: + - 3515 + node_id: + type: string + description: The node ID for the deployment protection rule. + examples: + - MDQ6R2F0ZTM1MTU= + enabled: + type: boolean + description: Whether the deployment protection rule is enabled for the environment. + examples: + - true + 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 + - 'null' + 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 + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + tree: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + - 'null' + payload: + type: + - string + - 'null' + required: + - verified + - reason + - signature + - payload + 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 + type: string + minLength: 40 + maxLength: 40 + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + examples: + - MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: + description: Name of the tag + type: string + examples: + - v0.0.1 + sha: + type: string + examples: + - 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: + description: URL for the tag + type: string + format: uri + examples: + - https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + message: + description: Message describing the purpose of the tag + type: string + examples: + - Initial public release + 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 + properties: + path: + type: string + examples: + - test/file.rb + mode: + type: string + examples: + - '040000' + type: + type: string + examples: + - tree + sha: + type: string + examples: + - 23f6827669e43831def8a7ad935069c8bd418261 + size: + type: integer + examples: + - 12 + url: + type: string + examples: + - https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 + examples: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + properties: + path: + type: string + mode: + type: string + type: + type: string + size: + type: integer + sha: + type: string + url: + type: string + required: + - path + - mode + - type + - sha + - url + - size + required: + - sha + - url + - tree + - truncated + hook-response: + title: Hook Response + type: object + properties: + code: + type: + - integer + - 'null' + status: + type: + - string + - 'null' + message: + type: + - string + - 'null' + required: + - code + - status + - message + hook: + title: Webhook + description: Webhooks for repositories. + type: object + properties: + type: + type: string + id: + description: Unique identifier of the webhook. + type: integer + examples: + - 42 + name: + description: The name of a valid service, use 'web' for a webhook. + type: string + examples: + - web + active: + description: Determines whether the hook is actually triggered on pushes. + type: boolean + examples: + - true + events: + description: 'Determines what events the hook is triggered for. Default: + [''push''].' + type: array + items: + type: string + examples: + - push + - pull_request + config: + "$ref": "#/components/schemas/webhook-config" + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1 + test_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1/test + ping_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + deliveries_url: + type: string + format: uri + examples: + - 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 + 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. + type: integer + format: int64 + examples: + - 42 + repository: + "$ref": "#/components/schemas/minimal-repository" + invitee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + inviter: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + permissions: + description: The permission associated with the invitation. + type: string + enum: + - read + - write + - admin + - triage + - maintain + examples: + - read + created_at: + type: string + format: date-time + examples: + - '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 + type: string + examples: + - https://api.github.com/user/repository-invitations/1 + html_url: + type: string + examples: + - https://github.com/octocat/Hello-World/invitations + node_id: + type: string + required: + - id + - node_id + - permissions + - inviter + - invitee + - repository + - url + - html_url + - created_at + issue-event-label: + title: Issue Event Label + description: Issue Event Label + type: object + properties: + name: + type: + - string + - 'null' + color: + type: + - string + - 'null' + 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 + - 'null' + dismissal_commit_id: + type: + - string + - 'null' + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDEwOklzc3VlRXZlbnQx + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + event: + type: string + examples: + - closed + commit_id: + type: + - string + - 'null' + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: + type: + - string + - 'null' + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue" + label: + "$ref": "#/components/schemas/issue-event-label" + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assigner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + review_requester: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + requested_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + type: + - string + - 'null' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + lock_reason: + type: + - string + - 'null' + examples: + - '"off-topic"' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + 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" + 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 + examples: + - 208045946 + node_id: + type: string + examples: + - MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + type: string + format: uri + examples: + - https://api.github.com/repositories/42/labels/bug + name: + description: The name of the label. + type: string + examples: + - bug + description: + description: Optional description of the label, such as its purpose. + type: + - string + - 'null' + examples: + - Something isn't working + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + examples: + - FFFFFF + default: + description: Whether this label comes by default in a new repository. + type: boolean + examples: + - true + required: + - id + - node_id + - url + - name + - description + - color + - default + 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 + type: integer + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + 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 + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + 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 + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + tree: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + - 'null' + payload: + type: + - string + - 'null' + required: + - verified + - reason + - signature + - payload + 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 + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: + - string + - 'null' + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - 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. + type: string + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + 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 + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + format: int64 + examples: + - 42 + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + examples: + - 1 + node_id: + description: The node ID of the pull request review comment. + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + description: The relative path of the file to which the comment applies. + type: string + examples: + - config/database.yaml + position: + description: The line index in the diff to which the comment applies. This + field is closing down; use `line` instead. + type: integer + examples: + - 1 + 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. + type: integer + examples: + - 4 + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + description: The SHA of the original commit to which the comment applies. + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + description: The comment ID to reply to. + type: integer + examples: + - 8 + user: + "$ref": "#/components/schemas/simple-user" + body: + description: The text of the comment. + type: string + examples: + - We should probably include a check for null values here. + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + examples: + - 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 + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: + - integer + - 'null' + description: The first line of the range for a multi-line comment. + examples: + - 2 + original_start_line: + type: + - integer + - 'null' + description: The first line of the range for a multi-line comment. + examples: + - 2 + start_side: + type: + - string + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + 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 + examples: + - 2 + 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 + examples: + - 2 + 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 + examples: + - '"

comment body

"' + body_text: + type: string + examples: + - '"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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + state_reason: + type: + - string + - 'null' + 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 + - 'null' + last_used: + type: + - string + - 'null' + 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 + - 'null' + format: uri + git_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + examples: + - approved + description: + type: string + examples: + - Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + examples: + - 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 + examples: + - https://api.github.com/repos/github/hello-world/pages + status: + type: + - string + - 'null' + description: The status of the most recent build of the Page. + enum: + - built + - building + - errored + - + examples: + - built + cname: + description: The Pages site's custom domain + type: + - string + - 'null' + examples: + - example.com + protected_domain_state: + type: + - string + - 'null' + description: The state if the domain is verified + enum: + - pending + - verified + - unverified + - + examples: + - pending + pending_domain_unverified_at: + type: + - string + - 'null' + description: The timestamp when a pending domain becomes unverified. + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + default: false + examples: + - false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + examples: + - https://example.com + build_type: + type: + - string + - 'null' + description: The process in which the Page will be built. + enum: + - legacy + - workflow + - + examples: + - legacy + 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. + examples: + - true + https_certificate: + "$ref": "#/components/schemas/pages-https-certificate" + https_enforced: + type: boolean + description: Whether https is enabled on the domain + examples: + - 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 + - 'null' + required: + - message + pusher: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + examples: + - 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 + examples: + - 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 + examples: + - hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + examples: + - 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 + repository-pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + configuration_url: + type: string + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + type: integer + examples: + - 42 + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + description: The title of the pull request. + type: string + examples: + - Amazing new feature + user: + "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + 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 + - 'null' + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + 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. + type: boolean + examples: + - false + merged: + type: boolean + mergeable: + type: + - boolean + - 'null' + examples: + - true + rebaseable: + type: + - boolean + - 'null' + examples: + - true + mergeable_state: + type: string + examples: + - clean + merged_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments: + type: integer + examples: + - 10 + review_comments: + type: integer + examples: + - 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + examples: + - true + commits: + type: integer + examples: + - 3 + additions: + type: integer + examples: + - 100 + deletions: + type: integer + examples: + - 3 + changed_files: + type: integer + examples: + - 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 + 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 + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: string + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - 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`. + type: + - string + - 'null' + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: + - integer + - 'null' + format: int64 + examples: + - 42 + id: + type: integer + format: int64 + examples: + - 10 + node_id: + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + type: string + examples: + - file1.txt + position: + type: + - integer + - 'null' + examples: + - 1 + original_position: + type: integer + examples: + - 4 + commit_id: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + examples: + - 8 + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: string + examples: + - Great stuff + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + examples: + - 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 + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + 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 + examples: + - 2 + 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 + type: integer + examples: + - 2 + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + original_start_line: + description: The original first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + 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-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 + examples: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - 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 + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + created_at: + type: string + format: date-time + published_at: + type: + - string + - 'null' + 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 + 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-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 + examples: + - 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-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-workflows" + - "$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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + 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/enterprise-server@3.13/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + secret-scanning-alert-resolution-comment: + description: An optional comment when closing an alert. Cannot be updated or + deleted. Must be `null` when changing `state` to `open`. + type: + - string + - 'null' + 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 + examples: + - "/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 + examples: + - 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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - blob_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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + secret-scanning-location: + type: object + properties: + type: + type: string + enum: + - 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. + examples: + - commit + details: + oneOf: + - "$ref": "#/components/schemas/secret-scanning-location-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" + required: + - type + - details + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + items: + type: integer + examples: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + total: + type: integer + examples: + - 89 + week: + type: integer + examples: + - 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + total: + type: integer + examples: + - 135 + weeks: + type: array + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + examples: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + 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 + examples: + - true + ignored: + description: Determines if all notifications should be blocked from this + repository. + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: string + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + examples: + - 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 + examples: + - v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + tag-protection: + title: Tag protection + description: Tag protection + type: object + properties: + id: + type: integer + examples: + - 2 + created_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + enabled: + type: boolean + examples: + - true + pattern: + type: string + examples: + - v1.* + required: + - pattern + 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 + group-response: + type: object + required: + - schemas + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:Group + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: + type: + - string + - 'null' + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: + type: + - string + - 'null' + description: A human-readable name for a security group. + examples: + - Engineering + members: + type: array + description: The group members. + items: + type: object + required: + - value + - "$ref" + properties: + value: + type: string + description: The local unique identifier for the member + examples: + - 23a35c27-23d3-4c03-b4c5-6443c09e7173 + "$ref": + type: string + display: + type: string + description: The display name associated with the member + examples: + - Monalisa Octocat + meta: + type: object + description: The metadata associated with the creation/updates to the user. + required: + - resourceType + properties: + resourceType: + type: string + description: A type of a resource + enum: + - User + - Group + examples: + - User + created: + type: string + description: A date and time when the user was created. + examples: + - '2022-03-27T19:59:26.000Z' + lastModified: + type: string + description: A data and time when the user was last modified. + examples: + - '2022-03-27T19:59:26.000Z' + location: + type: string + description: A URL location of an object + scim-enterprise-group-response: + allOf: + - "$ref": "#/components/schemas/group-response" + - type: object + properties: + id: + type: string + description: The internally generated id for the group object. + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + description: The security group members. + examples: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + "$ref": "#/components/schemas/meta" + scim-enterprise-group-list: + type: object + required: + - schemas + - totalResults + - Resources + - startIndex + - itemsPerPage + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the list + SCIM schemas. + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: + type: integer + description: Number of results found + examples: + - 1 + Resources: + type: array + description: Information about each provisioned group. + items: + "$ref": "#/components/schemas/scim-enterprise-group-response" + startIndex: + type: integer + description: A starting index for the returned page + examples: + - 1 + itemsPerPage: + type: integer + description: Number of objects per page + examples: + - 20 + group: + type: object + required: + - schemas + - externalId + - displayName + - members + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:Group + examples: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: + type: string + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: + type: string + description: A human-readable name for a security group. + examples: + - Engineering + members: + type: array + description: The group members. + items: + type: object + required: + - value + - displayName + properties: + value: + type: string + description: The local unique identifier for the member + examples: + - 23a35c27-23d3-4c03-b4c5-6443c09e7173 + displayName: + type: string + description: The display name associated with the member + examples: + - Monalisa Octocat + patch-schema: + type: object + required: + - Operations + - schemas + properties: + Operations: + type: array + description: patch operations list + items: + type: object + required: + - op + properties: + op: + type: string + enum: + - add + - replace + - remove + path: + type: string + value: + type: string + description: Corresponding 'value' of that field specified by 'path' + schemas: + type: array + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + user-name-response: + type: object + properties: + formatted: + type: string + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + examples: + - Ms. Mona Lisa Octocat + familyName: + type: string + description: The family name of the user. + examples: + - Octocat + givenName: + type: string + description: The given name of the user. + examples: + - Mona + middleName: + type: string + description: The middle name(s) of the user. + examples: + - Lisa + user-emails-response: + type: array + description: The emails for the user. + items: + type: object + required: + - value + properties: + value: + type: string + description: The email address. + examples: + - mlisa@example.com + type: + type: string + description: The type of email address. + examples: + - work + primary: + type: boolean + description: Whether this email address is the primary address. + examples: + - true + user-role: + type: array + description: The roles assigned to the user. + items: + type: object + required: + - value + properties: + display: + type: string + type: + type: string + value: + type: string + description: The role value representing a user role in GitHub. + enum: + - user + - 27d9891d-2c17-4f45-a262-781a0e55c80a + - guest_collaborator + - 1ebc4a02-e56c-43a6-92a5-02ee09b90824 + - enterprise_owner + - 981df190-8801-4618-a08a-d91f6206c954 + - ba4987ab-a1c3-412a-b58c-360fc407cb10 + - billing_manager + - 0e338b8c-cc7f-498a-928d-ea3470d7e7e3 + - e6be2762-e4ad-4108-b72d-1bbe884a0f91 + examples: + - user + primary: + type: boolean + description: Is the role a primary role for the user. + examples: + - false + user-response: + type: object + required: + - schemas + - active + - emails + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:User + examples: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: + type: + - string + - 'null' + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - E012345 + active: + type: boolean + description: Whether the user active in the IdP. + examples: + - true + userName: + type: string + description: The username for the user. + examples: + - E012345 + name: + "$ref": "#/components/schemas/user-name-response" + displayName: + type: + - string + - 'null' + description: A human-readable name for the user. + examples: + - Mona Lisa + emails: + "$ref": "#/components/schemas/user-emails-response" + roles: + "$ref": "#/components/schemas/user-role" + scim-enterprise-user-response: + allOf: + - "$ref": "#/components/schemas/user-response" + - type: object + required: + - id + - meta + properties: + id: + type: string + description: The internally generated id for the user object. + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + groups: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + description: Provisioned SCIM groups that the user is a member of. + meta: + "$ref": "#/components/schemas/meta" + scim-enterprise-user-list: + type: object + required: + - schemas + - totalResults + - Resources + - startIndex + - itemsPerPage + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the list + SCIM schemas. + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: + type: integer + description: Number of results found + examples: + - 1 + Resources: + type: array + description: Information about each provisioned account. + items: + "$ref": "#/components/schemas/scim-enterprise-user-response" + startIndex: + type: integer + description: A starting index for the returned page + examples: + - 1 + itemsPerPage: + type: integer + description: Number of objects per page + examples: + - 20 + user-name: + type: object + required: + - familyName + - givenName + properties: + formatted: + type: string + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + examples: + - Ms. Mona Lisa Octocat + familyName: + type: string + description: The family name of the user. + examples: + - Octocat + givenName: + type: string + description: The given name of the user. + examples: + - Mona + middleName: + type: string + description: The middle name(s) of the user. + examples: + - Lisa + user-emails: + type: array + description: The emails for the user. + items: + type: object + required: + - value + - type + - primary + properties: + value: + type: string + description: The email address. + examples: + - mlisa@example.com + type: + type: string + description: The type of email address. + examples: + - work + primary: + type: boolean + description: Whether this email address is the primary address. + examples: + - true + user: + type: object + required: + - schemas + - externalId + - userName + - active + - displayName + - emails + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:User + examples: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: + type: string + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - E012345 + active: + type: boolean + description: Whether the user active in the IdP. + examples: + - true + userName: + type: string + description: The username for the user. + examples: + - E012345 + name: + "$ref": "#/components/schemas/user-name" + displayName: + type: string + description: A human-readable name for the user. + examples: + - Mona Lisa + emails: + "$ref": "#/components/schemas/user-emails" + roles: + "$ref": "#/components/schemas/user-role" + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + type: + - string + - 'null' + 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 + - 'null' + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + examples: + - 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + 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 + state: + type: string + state_reason: + type: + - string + - 'null' + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: + - string + - 'null' + format: date-time + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + 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 + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + 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 + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: + - string + - 'null' + 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 + - 'null' + format: uri + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 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 + - 'null' + short_description: + type: + - string + - 'null' + description: + type: + - string + - 'null' + created_by: + type: + - string + - 'null' + released: + type: + - string + - 'null' + 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 + - 'null' + logo_url: + type: + - string + - 'null' + format: uri + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + related: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + bio: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + location: + type: + - string + - 'null' + site_admin: + type: boolean + hireable: + type: + - boolean + - 'null' + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + blog: + type: + - string + - 'null' + company: + type: + - string + - 'null' + suspended_at: + type: + - string + - 'null' + format: date-time + 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 + configuration-status: + type: object + properties: + status: + type: string + progress: + type: array + items: + type: object + properties: + status: + type: string + key: + type: string + required: + - status + - key + maintenance-status: + type: object + properties: + status: + type: string + scheduled_time: + type: string + connection_services: + type: array + items: + type: object + properties: + name: + type: string + number: + type: integer + required: + - name + - number + enterprise-settings: + type: object + properties: + enterprise: + type: object + properties: + private_mode: + type: boolean + public_pages: + type: boolean + subdomain_isolation: + type: boolean + signup_enabled: + type: boolean + github_hostname: + type: string + identicons_host: + type: string + http_proxy: + type: + - string + - 'null' + auth_mode: + type: string + expire_sessions: + type: boolean + admin_password: + type: + - string + - 'null' + configuration_id: + type: integer + configuration_run_count: + type: integer + avatar: + type: object + properties: + enabled: + type: boolean + uri: + type: string + customer: + type: object + properties: + name: + type: string + email: + type: string + uuid: + type: string + secret_key_data: + type: string + public_key_data: + type: string + license: + type: object + properties: + seats: + type: integer + evaluation: + type: boolean + perpetual: + type: boolean + unlimited_seating: + type: boolean + support_key: + type: string + ssh_allowed: + type: boolean + cluster_support: + type: boolean + expire_at: + type: string + github_ssl: + type: object + properties: + enabled: + type: boolean + cert: + type: + - string + - 'null' + key: + type: + - string + - 'null' + ldap: + type: object + properties: + host: + type: + - string + - 'null' + port: + type: integer + base: + type: array + items: {} + uid: + type: + - string + - 'null' + bind_dn: + type: + - string + - 'null' + password: + type: + - string + - 'null' + method: + type: string + search_strategy: + type: string + user_groups: + type: array + items: {} + admin_group: + type: + - string + - 'null' + virtual_attribute_enabled: + type: boolean + recursive_group_search: + type: boolean + posix_support: + type: boolean + user_sync_emails: + type: boolean + user_sync_keys: + type: boolean + user_sync_interval: + type: integer + team_sync_interval: + type: integer + sync_enabled: + type: boolean + reconciliation: + type: object + properties: + user: + type: + - string + - 'null' + org: + type: + - string + - 'null' + profile: + type: object + properties: + uid: + type: string + name: + type: + - string + - 'null' + mail: + type: + - string + - 'null' + key: + type: + - string + - 'null' + cas: + type: object + properties: + url: + type: + - string + - 'null' + saml: + type: object + properties: + sso_url: + type: + - string + - 'null' + certificate: + type: + - string + - 'null' + certificate_path: + type: + - string + - 'null' + issuer: + type: + - string + - 'null' + idp_initiated_sso: + type: boolean + disable_admin_demote: + type: boolean + github_oauth: + type: object + properties: + client_id: + type: string + client_secret: + type: string + organization_name: + type: string + organization_team: + type: string + smtp: + type: object + properties: + enabled: + type: boolean + address: + type: string + authentication: + type: string + port: + type: string + domain: + type: string + username: + type: string + user_name: + type: string + enable_starttls_auto: + type: boolean + password: + type: string + discard-to-noreply-address: + type: boolean + support_address: + type: string + support_address_type: + type: string + noreply_address: + type: string + ntp: + type: object + properties: + primary_server: + type: string + secondary_server: + type: string + timezone: + type: + - string + - 'null' + snmp: + type: object + properties: + enabled: + type: boolean + community: + type: string + syslog: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + protocol_name: + type: string + assets: + type: + - string + - 'null' + pages: + type: object + properties: + enabled: + type: boolean + collectd: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + port: + type: integer + encryption: + type: + - string + - 'null' + username: + type: + - string + - 'null' + password: + type: + - string + - 'null' + mapping: + type: object + properties: + enabled: + type: boolean + tileserver: + type: + - string + - 'null' + basemap: + type: string + token: + type: + - string + - 'null' + load_balancer: + type: + - string + - 'null' + run_list: + type: array + items: + type: string + ssh-key: + type: object + properties: + key: + type: string + pretty-print: + type: string + private-user: + title: Private User + description: Private User + type: object + properties: + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + user_view_type: + type: string + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + notification_email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - 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 + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + examples: + - octocat@github.com + primary: + type: boolean + examples: + - true + verified: + type: boolean + examples: + - true + visibility: + type: + - string + - 'null' + examples: + - public + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + format: int64 + examples: + - 3 + name: + type: + - string + - 'null' + examples: + - Octocat's GPG Key + primary_key_id: + type: + - integer + - 'null' + key_id: + type: string + examples: + - 3262EFF25BA0D270 + public_key: + type: string + examples: + - xsBNBFayYZ... + emails: + type: array + items: + type: object + properties: + email: + type: string + verified: + type: boolean + examples: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + type: array + 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 + - 'null' + raw_key: + type: + - string + - 'null' + revoked: + type: boolean + examples: + - 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 + can_sign: + type: boolean + examples: + - true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + examples: + - true + created_at: + type: string + format: date-time + examples: + - '2016-03-24T11:31:04-06:00' + expires_at: + type: + - string + - 'null' + format: date-time + revoked: + type: boolean + examples: + - true + raw_key: + type: + - string + - 'null' + 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 + 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 + examples: + - linkedin + url: + type: string + examples: + - 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 + required: + - key + - id + enterprise-webhooks: + 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/enterprise-server@3.13/admin/overview/about-enterprise-accounts)." + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '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 + for and sent to a GitHub App. For more information, + see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.13/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 + examples: + - 1 + node_id: + description: The global node ID of the installation. + type: string + examples: + - 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 + organization, or when the event occurs from activity in a repository owned by an organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + 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 + when the event occurs from activity in a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - 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 + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + template_repository: + type: + - object + - 'null' + 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 + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - '"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 + webhooks_rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/enterprise-server@3.13/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 + 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: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + app: + "$ref": "#/components/schemas/integration" + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - stale + - startup_failure + - + examples: + - neutral + created_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + repository: + "$ref": "#/components/schemas/minimal-repository" + status: + type: string + enum: + - queued + - in_progress + - completed + - pending + - waiting + examples: + - completed + updated_at: + type: string + format: date-time + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + check-run-with-simple-check-suite: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + check_suite: + "$ref": "#/components/schemas/simple-check-suite" + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + conclusion: + type: + - string + - 'null' + enum: + - waiting + - pending + - startup_failure + - stale + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + deployment: + "$ref": "#/components/schemas/deployment-simple" + details_url: + type: string + examples: + - https://example.com + external_id: + type: string + examples: + - '42' + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + html_url: + type: string + examples: + - https://github.com/github/hello-world/runs/4 + id: + description: The id of the check. + type: integer + examples: + - 21 + name: + description: The name of the check. + type: string + examples: + - test-coverage + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + output: + type: object + properties: + annotations_count: + type: integer + annotations_url: + type: string + format: uri + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + title: + type: + - string + - 'null' + required: + - title + - summary + - text + - annotations_count + - annotations_url + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + started_at: + type: string + format: date-time + examples: + - '2018-05-04T01:14:52Z' + status: + description: The phase of the lifecycle that the check is currently in. + type: string + enum: + - queued + - in_progress + - completed + - pending + examples: + - queued + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + 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/enterprise-server@3.13/rest/git/refs#get-a-reference) + resource. + type: string + webhooks_deploy_key: + description: The [`deploy key`](https://docs.github.com/enterprise-server@3.13/rest/deploy-keys/deploy-keys#get-a-deploy-key) + resource. + type: object + properties: + added_by: + type: + - string + - 'null' + created_at: + type: string + id: + type: integer + key: + type: string + last_used: + type: + - string + - 'null' + read_only: + type: boolean + title: + type: string + url: + type: string + format: uri + verified: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + webhooks_workflow: + title: Workflow + type: + - object + - 'null' + 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 + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: + type: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + answer_chosen_at: + type: + - string + - 'null' + answer_chosen_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + type: + - string + - 'null' + enum: + - resolved + - outdated + - duplicate + - reopened + - + examples: + - resolved + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - author_association + - active_lock_reason + - 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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/enterprise-server@3.13/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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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_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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - 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 + 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 + required: + - name + - id + webhooks_milestone_3: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + state: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + repositories: + type: + - array + - 'null' + 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 + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + description: Date and time when the associated fine-grained personal access + token was last used for authentication. + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + node_id: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: + type: + - string + - 'null' + public: + type: boolean + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + number: + type: integer + short_description: + type: + - string + - 'null' + deleted_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + deleted_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + webhooks_project_changes: + type: object + properties: + archived_at: + type: object + properties: + from: + type: + - string + - 'null' + format: date-time + to: + type: + - string + - 'null' + format: date-time + 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: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + required: + - id + - content_node_id + - content_type + - created_at + - updated_at + - archived_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. + - `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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + webhooks_review_comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + webhooks_release: + title: Release + description: The [release](https://docs.github.com/enterprise-server@3.13/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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - content_type + - size + - download_count + - created_at + - updated_at + assets_url: + type: string + format: uri + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: uri + required: + - url + - assets_url + - upload_url + - html_url + - id + - node_id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + - assets + - tarball_url + - zipball_url + - body + webhooks_release_1: + title: Release + description: The [release](https://docs.github.com/enterprise-server@3.13/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 + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + 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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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: + - open + secret-scanning-alert-resolution-webhook: + type: + - string + - 'null' + description: The reason for resolving the alert. + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - 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 + 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 + 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 + - 'null' + 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 + - 'null' + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + linear_history_requirement_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + 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 + - 'null' + 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-cache-sync: + type: object + properties: + after: + type: string + before: + type: string + cache_location: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + 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" + required: + - cache_location + - ref + - before + - after + 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" + 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" + 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" + 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" + 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/enterprise-server@3.13/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: The client ID of the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + - 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/enterprise-server@3.13/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: Client ID of the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + 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/enterprise-server@3.13/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: The Client ID for the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + 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: + 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 + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + 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 + - 'null' + 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: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-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 + - 'null' + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + 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: + - 'null' + fixed_at: + type: + - 'null' + 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 + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: + - string + - 'null' + enum: + - open + - dismissed + - + tool: + type: + - object + - 'null' + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + required: + - name + - version + updated_at: + type: + - string + - 'null' + 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-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: + 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 + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + 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 + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + 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 + - 'null' + dismissed_by: + type: + - object + - 'null' + 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 + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + 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: + 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 + - 'null' + 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 + - 'null' + 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: + 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: + - 'null' + dismissed_by: + type: + - 'null' + 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: + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + 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 + - 'null' + 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-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 + - 'null' + 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 + - 'null' + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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-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-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/enterprise-server@3.13/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - 'null' + 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: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + deployment_callback_url: + description: The URL to review the deployment protection rule. + type: string + format: uri + deployment: + "$ref": "#/components/schemas/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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + 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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + completed_at: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - skipped + - + 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/enterprise-server@3.13/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + environment: + type: string + id: + type: integer + node_id: + type: string + original_environment: + type: string + payload: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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/enterprise-server@3.13/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - startup_failure + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - 'null' + 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: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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-enterprise-anonymous-access-disabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_disabled + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + webhook-enterprise-anonymous-access-enabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_enabled + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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: + type: + - 'null' + languages_url: + type: string + license: + type: + - object + - 'null' + merges_url: + type: string + milestones_url: + type: string + mirror_url: + type: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + avatar_url: + type: string + created_at: + type: string + description: + type: + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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/enterprise-server@3.13/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: + anyOf: + - type: 'null' + - "$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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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-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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + type: + - object + - 'null' + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: + - object + - 'null' + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + 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_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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.13/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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-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/enterprise-server@3.13/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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-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-member-added: + title: member added event + type: object + properties: + action: + type: string + enum: + - added + changes: + type: object + properties: + permission: + type: object + properties: + to: + type: string + enum: + - write + - admin + - read + 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 + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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-meta-deleted: + title: meta deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + hook: + description: 'The modified 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: + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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-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 + - 'null' + failed_at: + type: + - string + - 'null' + format: date-time + failed_reason: + type: + - string + - 'null' + id: + type: number + invitation_teams_url: + type: string + format: uri + inviter: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + description: + type: + - string + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + namespace: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + labels: + type: + - object + - 'null' + manifest: + type: + - object + - 'null' + 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 + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + type: + - object + - 'null' + bugs: + type: + - object + - 'null' + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + type: + - object + - 'null' + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + namespace: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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/enterprise-server@3.13/rest/pages/pages#list-github-pages-builds) + itself. + type: object + properties: + commit: + type: + - string + - 'null' + created_at: + type: string + duration: + type: integer + error: + type: object + properties: + message: + type: + - string + - 'null' + required: + - message + pusher: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + archived: + description: Whether or not the card is archived + type: boolean + column_id: + type: + - integer + - 'null' + column_url: + type: string + format: uri + content_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + archived: + type: boolean + column_id: + type: integer + column_url: + type: string + created_at: + type: string + creator: + type: + - object + - 'null' + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + to: + type: + - string + - 'null' + public: + type: object + properties: + from: + type: boolean + to: + type: boolean + short_description: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + 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. + It includes 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 + required: + - field_value + - type: object + properties: + body: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + to: + type: + - string + - 'null' + 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-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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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_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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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-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-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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + required: + - action + - thread + - pull_request + - repository + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + required: + - action + - thread + - pull_request + - repository + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + manifest: + type: + - object + - 'null' + 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 + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + bugs: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + 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 + type: + - 'null' + - string + - object + 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 + - 'null' + items: + type: object + properties: + id: + oneOf: + - type: string + - type: object + - type: integer + type: + - 'null' + - string + - object + - integer + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + about_url: + type: string + name: + type: string + type: + type: string + url: + type: string + vendor: + type: string + updated_at: + type: + - string + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + 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 + - 'null' + 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 + 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/enterprise-server@3.13/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 + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + 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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-anonymous-access-disabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_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 + webhook-repository-anonymous-access-enabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_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 + 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 + - 'null' + 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 + - 'null' + required: + - from + homepage: + type: object + properties: + from: + type: + - string + - 'null' + required: + - from + topics: + type: object + properties: + from: + type: + - array + - 'null' + 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-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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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-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-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-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-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 + - 'null' + 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 + - 'null' + 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 + 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 + - 'null' + 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.' + type: + - 'null' + required: + - action + - starred_at + - repository + - sender + webhook-status: + title: status event + type: object + properties: + avatar_url: + type: + - string + - 'null' + 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 + - 'null' + url: + type: + - string + - 'null' + format: uri + required: + - sha + - url + name: + type: string + protected: + type: boolean + required: + - name + - commit + - protected + commit: + type: object + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + verified: + type: boolean + required: + - verified + - reason + - signature + - payload + required: + - author + - committer + - message + - tree + - url + - comment_count + - verification + committer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + updated_at: + type: string + required: + - id + - sha + - name + - target_url + - context + - description + - state + - commit + - branches + - created_at + - updated_at + - repository + - sender + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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-user-created: + 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" + user: + "$ref": "#/components/schemas/webhooks_user" + required: + - action + webhook-user-deleted: + 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" + user: + "$ref": "#/components/schemas/webhooks_user" + required: + - action + 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 + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + format: uri + id: + type: integer + labels: + description: Custom labels for the job. Specified by the [`"runs-on"` + attribute](https://docs.github.com/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + name: + type: string + node_id: + type: string + run_attempt: + type: integer + run_id: + type: integer + run_url: + type: string + runner_group_id: + type: + - number + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - number + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + status: + type: string + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + type: + - object + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - + - 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/enterprise-server@3.13/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - + - cancelled + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - number + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + status: + type: string + enum: + - in_progress + - completed + - queued + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - integer + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + format: date-time + status: + type: string + enum: + - queued + - in_progress + - completed + - waiting + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - integer + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + status: + type: string + enum: + - queued + - in_progress + - completed + - waiting + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: + type: + - object + - 'null' + required: + - url + - id + - number + - head + - base + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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. + examples: + - Simple 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: + type: + - object + - 'null' + required: + - url + - id + - number + - head + - base + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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} + global-hook-items: + value: + - type: Global + id: 1 + name: web + active: true + events: + - organization + - user + config: + url: https://example.com + content_type: json + insecure_ssl: '0' + secret: "********" + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + global-hook: + value: + type: Global + id: 1 + name: web + active: true + events: + - organization + - user + config: + url: https://example.com + content_type: json + insecure_ssl: '0' + secret: "********" + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + global-hook-2: + value: + type: Global + id: 1 + name: web + active: true + events: + - organization + config: + url: https://example.com + content_type: form + insecure_ssl: '0' + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + enterprise-public-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 + last_used: '2020-06-11T22:31:57Z' + user_id: 1 + repository_id: 2 + - key: 9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234 + id: 3 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + last_used: '2020-06-11T22:31:57Z' + user_id: 1 + repository_id: 2 + ldap-mapping-team: + value: + ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com + 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: + ldap-mapping-user: + value: + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: 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 + 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 + pre-receive-environment-items: + value: + - id: 1 + name: Default + image_url: githubenterprise://internal + url: https://github.example.com/api/v3/admin/pre-receive-environments/1 + html_url: https://github.example.com/admin/pre-receive-environments/1 + default_environment: true + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 14 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest + state: not_started + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + - id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-environment: + value: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: not_started + downloaded_at: + message: + pre-receive-environment-default-response: + value: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-environment-download-status-default-response: + value: + url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest + state: not_started + downloaded_at: + message: + pre-receive-environment-download-status: + value: + url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-hook-items: + value: + - id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: false + pre-receive-hook: + value: + id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: false + pre-receive-hook-2: + value: + id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 1 + name: Default + image_url: githubenterprise://internal + url: https://github.example.com/api/v3/admin/pre-receive-environments/1 + html_url: https://github.example.com/admin/pre-receive-environments/1 + default_environment: true + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: true + classic-personal-access-tokens: + value: + - id: 2 + url: https://enterprise.octocat.com/api/v3/authorizations/2 + app: + name: My personal access token + url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens + client_id: '00000000000000000000' + token: ghp_16C7e42F292c6912E7710c838347Ae178B4a + hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 + token_last_eight: Ae178B4a + note: My personal access token + note_url: + created_at: '2019-04-24T21:49:02Z' + updated_at: '2019-04-24T21:49:02Z' + scopes: + - admin:business + - admin:gpg_key + - admin:org + - admin:org_hook + - admin:pre_receive_hook + - admin:public_key + - admin:repo_hook + - delete_repo + - gist + - notifications + - repo + - user + - write:discussion + fingerprint: + 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 + authorization: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + 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: + 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: + 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----- + 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: + 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: + suspended_by: + 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: + suspended_by: + 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: + 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 + application-grant-items: + value: + - id: 1 + url: https://api.github.com/applications/grants/1 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + created_at: '2011-09-06T17:26:27Z' + updated_at: '2011-09-06T20:39:23Z' + scopes: + - public_repo + application-grant: + value: + id: 1 + url: https://api.github.com/applications/grants/1 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + created_at: '2011-09-06T17:26:27Z' + updated_at: '2011-09-06T20:39:23Z' + scopes: + - public_repo + 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: [] + authorization-items: + value: + - id: 2 + url: https://enterprise.octocat.com/api/v3/authorizations/2 + app: + name: My personal access token + url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens + client_id: '00000000000000000000' + token: ghp_16C7e42F292c6912E7710c838347Ae178B4a + hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 + token_last_eight: Ae178B4a + note: My personal access token + note_url: + created_at: '2019-04-24T21:49:02Z' + updated_at: '2019-04-24T21:49:02Z' + scopes: + - admin:business + - admin:gpg_key + - admin:org + - admin:org_hook + - admin:pre_receive_hook + - admin:public_key + - admin:repo_hook + - delete_repo + - gist + - notifications + - repo + - user + - write:discussion + fingerprint: + authorization-response-if-returning-an-existing-token-2: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: '' + authorization-response-if-returning-an-existing-token: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + authorization-3: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2012-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + authorization-2: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + 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/ + 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 + 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 + announcement: + summary: Announcement banner + value: + announcement: Very **important** announcement about _something_. + expires_at: '2021-01-01T00:00:00.000+00:00' + user_dismissible: false + license-info: + value: + seats: 1400 + seats_used: 1316 + seats_available: 84 + kind: standard + days_until_expiration: 365 + expire_at: 2016/02/06 12:41:52 -0600 + enterprise-overview: + value: + repos: + total_repos: 212 + root_repos: 194 + fork_repos: 18 + org_repos: 51 + total_pushes: 3082 + total_wikis: 15 + hooks: + total_hooks: 27 + active_hooks: 23 + inactive_hooks: 4 + pages: + total_pages: 36 + orgs: + total_orgs: 33 + disabled_orgs: 0 + total_teams: 60 + total_team_members: 314 + users: + total_users: 254 + admin_users: 45 + suspended_users: 21 + pulls: + total_pulls: 86 + merged_pulls: 60 + mergeable_pulls: 21 + unmergeable_pulls: 3 + issues: + total_issues: 179 + open_issues: 83 + closed_issues: 96 + milestones: + total_milestones: 7 + open_milestones: 6 + closed_milestones: 1 + gists: + total_gists: 178 + private_gists: 151 + public_gists: 25 + comments: + total_commit_comments: 6 + total_gist_comments: 28 + total_issue_comments: 366 + total_pull_request_comments: 30 + enterprise-security-products-overview: + value: + total_repos: 150 + nonarchived_repos: 130 + secret_scanning_enabled_repos: 150 + secret_scanning_push_protection_enabled_repos: 120 + code_scanning_enabled_repos: 140 + code_scanning_pr_reviews_enabled_repos: 100 + code_scanning_default_setup_enabled_repos: 50 + code_scanning_default_setup_eligible_repos: 30 + dependabot_alerts_enabled_repos: 130 + dependabot_security_updates_enabled_repos: 120 + dependabot_version_updates_enabled_repos: 121 + advanced_security_enabled_repos: 150 + active_committers: 30 + purchased_committers: 90 + maximum_committers: 80 + actions-cache-usage-org-enterprise: + value: + total_active_caches_size_in_bytes: 3344284 + total_active_caches_count: 5 + actions-cache-usage-policy-enterprise: + value: + repo_cache_size_limit_in_gb: 10 + max_repo_cache_size_limit_in_gb: 15 + actions-enterprise-permissions: + value: + enabled_organizations: all + allowed_actions: selected + selected_actions_url: https://api.github.com/enterprises/2/actions/permissions/selected-actions + organization-targets: + value: + total_count: 1 + organizations: + - login: octocat + id: 161335 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + 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-enterprise: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners + allows_public_repositories: false + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners + 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 + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners + 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-enterprise: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + allows_public_repositories: false + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-update-enterprise: + value: + id: 2 + name: Expensive hardware runners + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + 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-paginated: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + 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 + 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-airgap: + value: + - os: osx + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz + filename: actions-runner-osx-x64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b + - os: linux + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz + filename: actions-runner-linux-x64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: 02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98 + - os: linux + architecture: arm + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz + filename: actions-runner-linux-arm-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw + sha256_checksum: 2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85 + - os: win + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip + filename: actions-runner-win-x64-2.277.1.zip + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: 7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30 + - os: linux + architecture: arm64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz + filename: actions-runner-linux-arm64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64 + 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 + 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 + audit-log: + value: + - actor_ip: 88.123.45.123 + from: pull_requests#merge + device_cookie: + actor: mona-admin + actor_id: 7 + repo: octo-org/octo-repo + repo_id: 17 + business: github + business_id: 1 + org: octo-org + org_id: 8 + action: pull_request.merge + "@timestamp": 1635940599755 + created_at: 1635940599755 + operation_type: modify + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: POST + request_id: e4dabc4d-ba16-4bca-1234-649be7ae1188 + server_id: 5d17aab5-fd9f-abcd-a820-16bed246441b + request_category: other + controller_action: merge + url: https://example.com/octo-org/octo-repo/pull/1/merge + client_id: 322299977.1635936 + referrer: https://example.com/octo-org/octo-repo/pull/1 + actor_session: 1 + pull_request_id: 1 + category_type: Resource Management + - actor_ip: 88.123.45.123 + from: pull_request_review_events#create + device_cookie: + actor: mona-admin + actor_id: 7 + business_id: 1 + org_id: 8 + action: pull_request_review.submit + "@timestamp": 1635940593079 + created_at: 1635940593079 + operation_type: modify + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: PUT + request_id: c0f63bb7-17b6-4796-940c-12345c5a581b + server_id: 2abc1234-f651-43e3-9696-e942ad5f8c89 + request_category: other + controller_action: create + url: https://example.com/octo-org/octo-repo/pull/1/reviews + client_id: 322299977.1635936 + referrer: https://example.com/octo-org/octo-repo/pull/1/files + actor_session: 1 + spammy: false + pull_request_id: 1 + body: + allowed: true + id: 1 + state: 40 + issue_id: 1 + review_id: 1 + category_type: Resource Management + - actor_ip: 88.123.45.123 + from: pull_requests#create + device_cookie: + actor: mona + actor_id: 9 + user_id: 9 + repo: octo-org/octo-repo + repo_id: 17 + business: github + business_id: 1 + org: octo-org + org_id: 8 + action: pull_request.create + "@timestamp": 1635940554161 + created_at: 1635940554161 + operation_type: create + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: POST + request_id: 2773abeb-477f-4ebf-a017-f8e8a206c305 + server_id: 796e3115-4ce8-4606-8fd0-99ea57a2e12b + request_category: other + controller_action: create + url: https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1 + client_id: 386351111.163594 + referrer: https://example.com/octo-org/octo-repo/compare/main...mona:patch-1 + actor_session: 2 + pull_request_id: 1 + category_type: Resource Management + 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: + 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 + enterprise-security-analysis-settings: + value: + advanced_security_enabled_for_new_repositories: true + dependabot_alerts_enabled_for_new_repositories: true + secret_scanning_enabled_for_new_repositories: true + secret_scanning_push_protection_enabled_for_new_repositories: true + secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md + 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 + 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: + 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: + 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} + 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 + - number: 1 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 + html_url: https://github.com/owner/repo/security/secret-scanning/1 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations + state: open + resolution: + resolved_at: + resolved_by: + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + 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: + 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 + advanced-security-active-committers: + value: + total_advanced_security_committers: 2 + total_count: 2 + maximum_advanced_security_committers: 4 + purchased_advanced_security_committers: 4 + repositories: + - name: octocat-org/Hello-World + advanced_security_committers: 2 + advanced_security_committers_breakdown: + - user_login: octocat + last_pushed_date: '2021-11-03' + last_pushed_email: octocat@github.com + - user_login: octokitten + last_pushed_date: '2021-10-25' + last_pushed_email: octokitten@github.com + - name: octocat-org/server + advanced_security_committers: 1 + advanced_security_committers_breakdown: + - user_login: octokitten + last_pushed_date: '2021-10-26' + last_pushed_email: octokitten@github.com + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-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 + 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: + 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 + 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 + 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: + 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 + 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: + 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: + 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: + 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 + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + 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: + 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 + 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 + 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 + 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 + 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: |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 + ghes-get-ssh: + value: + - key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ== + fingeprint: bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw== + fingeprint: e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4 + ghes-set-ssh: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: SSH key added successfully + modified: true + ghes-delete-ssh: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: SSH key removed successfully + ghes-checks-system-requirements: + value: + status: OK + nodes: + - hostname: ghe-local-app + status: OK + roles_status: + - status: OK + role: ConsulServer + - status: OK + role: JobServer + - status: OK + role: WebServer + - hostname: ghe-local-app2 + status: OK + roles_status: + - status: OK + role: ConsulServer + - status: OK + role: GitServer + ghes-cluster-status: + value: + status: OK + nodes: + - hostname: ghe-local-app + status: OK + services: + - status: OK + name: es + details: Elasticsearch cluster is in sync (0 shards initializing, 0 shards + unassigned) + - status: OK + name: git-replication + details: Git replication is in sync + - status: OK + name: kafka-lite-admin-healthcheck + details: '' + - status: OK + name: kafka-lite-broker-is-reachable + details: '' + - status: OK + name: memcache + details: '' + - status: OK + name: metrics + details: '' + - status: OK + name: mysql-replication + details: Replication is running + - status: OK + name: mysql-failover + details: '' + - status: OK + name: pages + details: Pages replication is in sync + - status: OK + name: redis + details: Redis is OK + - status: OK + name: storage + details: Storage replication is in sync + - hostname: ghe-local-app2 + status: OK + services: + - status: OK + name: kafka-lite-admin-healthcheck + details: '' + - status: OK + name: kafka-lite-broker-is-reachable + details: '' + ghes-license-info: + value: + - advancedSecurityEnabled: true + advancedSecuritySeats: 0 + clusterSupport: false + company: GitHub + croquetSupport: true + customTerms: true + evaluation: false + expireAt: '2025-01-02T07:59:59Z' + insightsEnabled: true + insightsExpireAt: '2025-01-02T07:59:59.999Z' + learningLabEvaluationExpires: '2023-01-02T07:59:59Z' + learningLabSeats: 100 + perpetual: false + referenceNumber: 32a145 + seats: 0 + sshAllowed: true + supportKey": '' + unlimitedSeating: true + ghes-license-check: + value: + - status: valid + ghes-config-nodes: + value: + topology: Cluster + nodes: + - hostname: data1 + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + cluster_roles: + - ConsulServer + - ElasticsearchServer + - GitServer + - StorageServer + - hostname: data2 + uuid: 228406d4-f97c-11ed-ab01-062281bbcf03 + cluster_roles: + - ElasticsearchServer + - StorageServer + - PagesServer + ghes-get-settings: + value: + private_mode: false + public_pages: false + subdomain_isolation: true + signup_enabled: false + github_hostname: ghe.local + identicons_host: dotcom + http_proxy: + auth_mode: default + expire_sessions: false + admin_password: + configuration_id: 1401777404 + configuration_run_count: 4 + avatar: + enabled: false + uri: '' + customer: + name: GitHub + email: stannis@themannis.biz + uuid: af6cac80-e4e1-012e-d822-1231380e52e9 + secret_key_data: | + -----BEGIN PGP PRIVATE KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + lQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx... + -----END PGP PRIVATE KEY BLOCK----- + public_key_data: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + mI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7.... + -----END PGP PUBLIC KEY BLOCK----- + license: + seats: 0 + evaluation: false + perpetual: false + unlimited_seating: true + support_key: ssh-rsa AAAAB3N.... + ssh_allowed: true + cluster_support: false + expire_at: '2016-04-27T00:00:00-07:00' + github_ssl: + enabled: false + cert: + key: + ldap: + host: + port: 0 + base: [] + uid: + bind_dn: + password: + method: Plain + search_strategy: detect + user_groups: [] + admin_group: + virtual_attribute_enabled: false + recursive_group_search: false + posix_support: true + user_sync_emails: false + user_sync_keys: false + user_sync_interval: 4 + team_sync_interval: 4 + sync_enabled: false + reconciliation: + user: + org: + profile: + uid: uid + name: + mail: + key: + cas: + url: + saml: + sso_url: + certificate: + certificate_path: + issuer: + idp_initiated_sso: false + disable_admin_demote: false + github_oauth: + client_id: '12313412' + client_secret: kj123131132 + organization_name: Homestar Runners + organization_team: homestarrunners/characters + smtp: + enabled: true + address: smtp.example.com + authentication: plain + port: '1234' + domain: blah + username: foo + user_name: mr_foo + enable_starttls_auto: true + password: bar + discard-to-noreply-address: true + support_address: enterprise@github.com + support_address_type: email + noreply_address: noreply@github.com + ntp: + primary_server: 0.pool.ntp.org + secondary_server: 1.pool.ntp.org + timezone: + snmp: + enabled: false + community: '' + syslog: + enabled: false + server: + protocol_name: udp + assets: + pages: + enabled: true + collectd: + enabled: false + server: + port: 0 + encryption: + username: + password: + mapping: + enabled: true + tileserver: + basemap: company.map-qsz2zrvs + token: + load_balancer: + ghes-get-maintenance: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + status: scheduled + scheduled_time: '2006-01-02T15:04:05+00:00' + connection_services: + - name: git operations + number: 15 + - name: mysql queries + number: 6 + - name: resque jobs + number: 10 + - name: aqueduct jobs + number: 0 + can_unset_maintenance: true + ip_exception_list: + - 1.1.1.1 + maintenance_mode_message: Scheduled maintenance for upgrading. + ghes-set-maintenance: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: maintenance mode scheduled with exception list [1.1.1.1] + ghes-replication-status: + value: + status: OK + nodes: + - hostname: ghe-local-primary + status: OK + services: [] + - hostname: ghe-local-replica + status: OK + services: + - status: OK + name: redis + details: replication is in sync + - status: OK + name: elasticsearch + details: cluster is in sync (0 shards initializing, 0 shards unassigned) + - status: OK + name: git + details: replication is in sync + - status: OK + name: pages + details: replication is in sync + - status: OK + name: alambic + details: replication is in sync + - status: OK + name: git-hooks + details: replication is in sync + - status: OK + name: consul + details: replication is in sync + - status: OK + name: mysql + details: replication is in sync + ghes-version: + value: + - hostname: ghe-local-primary + version: + version: 3.9.0 + platform: azure + build_id: fc542058b5 + build_date: '2023-05-02' + api-overview: + value: + verifiable_password_authentication: true + packages: + - 192.0.2.1 + domains: + website: + - "*.example.com" + codespaces: + - "*.example.com" + copilot: + - "*.example.com" + packages: + - "*.example.com" + installed_version: 3.13.0 + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/rrubenich + 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: + 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: |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~~~~ + ~~~~~~==~==~~~==~==~~~~~~ + ~~~~~~==~==~==~==~~~~~~ + :~==~==~==~==~~ + 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-custom-repository-role-example: + value: + id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + 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' + 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 + 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_fork_private_repositories: false + web_commit_signoff_required: false + updated_at: '2014-03-03T18:58:10Z' + 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 + 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 + 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 + 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: + 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 + 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 + 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 + 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: + 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 + 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 + organization-custom-repository-role-list-example: + value: + total_count: 2 + custom_roles: + - id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + 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: Community manager + description: Able to handle all the community interactions without being + able to contribute code + base_role: read + permissions: + - mark_as_duplicate + - manage_settings_pages + - manage_settings_wiki + - set_social_preview + - edit_repo_metadata + - toggle_discussion_comment_minimize + 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-05T12:01:11Z' + updated_at: '2022-07-05T12:20:11Z' + 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' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/oct-repo + payload: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + external-group: + value: + group_id: '123' + group_name: Octocat admins + updated_at: '2021-01-24T11:31:04-06:00' + teams: + - team_id: 1 + team_name: team-test + - team_id: 2 + team_name: team-test2 + members: + - member_id: 1 + member_login: mona-lisa_eocsaxrs + member_name: Mona Lisa + member_email: mona_lisa@github.com + - member_id: 2 + member_login: octo-lisa_eocsaxrs + member_name: Octo Lisa + member_email: octo_lisa@github.com + external-groups: + value: + groups: + - group_id: '123' + group_name: Octocat admins + updated_at: '2021-01-24T11:31:04-06:00' + - group_id: '456' + group_name: Octocat docs members + updated_at: '2021-03-24T11:31:04-06:00' + 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 + 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: + suspended_by: + 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: + suspended_by: + 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 + 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 + 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: + 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= + 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: + 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' + 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: + 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' + 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: + 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 + 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: + 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: + org-pre-receive-hook-items: + value: + - id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 + allow_downstream_configuration: true + org-pre-receive-hook: + value: + id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 + allow_downstream_configuration: true + org-pre-receive-hook-2: + value: + id: 42 + name: Check Commits + enforcement: enabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + allow_downstream_configuration: false + project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: true + project-2: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + 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 + - 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: + 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 + repository-fine-grained-permission-example: + value: + - name: add_assignee + description: Assign or remove a user + - name: remove_assignee + description: Remove an assigned user + - name: add_label + description: Add or remove a label + 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 + 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: + 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 + 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 + 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 + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + team-discussion-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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion: + 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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-2: + 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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 1 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: '2018-01-26T18:22:20Z' + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Welcome to our first team post + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-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 + body: Do you like apples? + body_html: "

Do you like apples?

" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment: + 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 + body: Do you like apples? + body_html: "

Do you like apples?

" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-2: + 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 + body: Do you like pineapples? + body_html: "

Do you like pineapples?

" + body_version: e6907b24d9c93cc0c5024a7af5888116 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: '2018-01-26T18:22:20Z' + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + 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' + 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-project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-project: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + 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: + 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 + project-card: + value: + url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + 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: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-column: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + project-card-items: + value: + - url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + 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: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-3: + value: + owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + project-collaborator-permission: + value: + permission: 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 + project-column-items: + value: + - url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + 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: + 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 + 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' + 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' + 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' + 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-usage-policy: + value: + repo_cache_size_limit_in_gb: 14 + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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 + 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 + 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 + 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: + 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 + 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: + 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: + 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: + 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 + + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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 + fixed_at: + 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 + fixed_at: '2020-02-14T12:29:18Z' + 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: + 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: '' + 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: + version: 2.4.0 + deletable: true + warning: '' + code-scanning-analysis-sarif: + summary: application/json+sarif 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-default-setup: + value: + state: configured + languages: + - ruby + - python + query_suite: default + updated_at: '2023-01-19T11:21:34Z' + schedule: weekly + code-scanning-default-setup-update: + value: + state: configured + 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 + 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: + 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-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: + payload: + 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: + 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 + 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 + 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 @@ + ..... + 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: + 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 + 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 + 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 + 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 + 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: + 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: + _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: + _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: + _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 + 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 + file-commit: + value: + 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 + 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 + 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: + - 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: + 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 + 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: + 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: + 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: + 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: + 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: + - SPDXID: SPDXRef-Package + name: rubygems:rails + versionInfo: 1.0.0 + downloadLocation: NOASSERTION + filesAnalyzed: false + licenseConcluded: NOASSERTION + licenseDeclared: NOASSERTION + 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 + 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: trues + 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 + 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 + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + minimal-repository-items-2: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/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== + 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 + 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 + 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 + 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: + status: unused + message: + 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: + status: unused + message: + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + single_file: 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 + 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: + label: + name: label + color: red + 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: + 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 + deploy-key-items: + value: + enabled: + - 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' + 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' + 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 + 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== + 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: + 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: + 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 + repository-pre-receive-hook-items: + value: + - id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + repository-pre-receive-hook: + value: + id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + repository-pre-receive-hook-2: + value: + id: 42 + name: Check Commits + enforcement: enabled + configuration_url: https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 + project-items-2: + value: + - owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + 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 + 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: + 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: + 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 + 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: + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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' + 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 + - number: 1 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 + html_url: https://github.com/owner/repo/security/secret-scanning/1 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/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 + 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 + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed: false + validity: unknown + 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 + resolution_comment: Example comment + validity: unknown + 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 + 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: + 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: + 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= + tag-protection-items: + value: + - id: 2 + pattern: v1.* + tag-protection: + value: + enabled: true + topic: + value: + names: + - octocat + - atom + - electron + - api + 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: + 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 + 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 + scim-enterprise-group-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + id: 24b28bbb-5fc4-4686-a153-a020debb1155 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + resourceType: Group + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 + startIndex: 1 + itemsPerPage: 20 + scim-enterprise-group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + resourceType: Group + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 + scim-enterprise-user-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + id: 7fce0092-d52e-4f76-b727-3955bd72c939 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + startIndex: 1 + itemsPerPage: 20 + in-user: + summary: User + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + in-user-owner: + summary: Enterprise Owner + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: Enterprise Owner + primary: false + scim-enterprise-user: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 7fce0092-d52e-4f76-b727-3955bd72c939 + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + meta: + resourceType: User + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 + 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: + value: + total_count: 280 + incomplete_results: false + 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 + 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 + configuration-status: + value: + status: running + progress: + - status: DONE + key: Appliance core components + - status: DONE + key: GitHub utilities + - status: DONE + key: GitHub applications + - status: CONFIGURING + key: GitHub services + - status: PENDING + key: Reloading appliance services + maintenance-status: + value: + status: scheduled + scheduled_time: Tuesday, January 22 at 15:34 -0800 + connection_services: + - name: git operations + number: 0 + - name: mysql queries + number: 233 + - name: aqueduct jobs + number: 34 + - name: resque jobs + number: 54 + enterprise-settings: + value: + enterprise: + private_mode: false + public_pages: false + subdomain_isolation: true + signup_enabled: false + github_hostname: ghe.local + identicons_host: dotcom + http_proxy: + auth_mode: default + expire_sessions: false + admin_password: + configuration_id: 1401777404 + configuration_run_count: 4 + avatar: + enabled: false + uri: '' + customer: + name: GitHub + email: stannis@themannis.biz + uuid: af6cac80-e4e1-012e-d822-1231380e52e9 + secret_key_data: | + -----BEGIN PGP PRIVATE KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + + lQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx... + -----END PGP PRIVATE KEY BLOCK----- + public_key_data: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + + mI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7.... + -----END PGP PUBLIC KEY BLOCK----- + license: + seats: 0 + evaluation: false + perpetual: false + unlimited_seating: true + support_key: ssh-rsa AAAAB3N.... + ssh_allowed: true + cluster_support: false + expire_at: '2016-04-27T00:00:00-07:00' + github_ssl: + enabled: false + cert: + key: + ldap: + host: + port: 0 + base: [] + uid: + bind_dn: + password: + method: Plain + search_strategy: detect + user_groups: [] + admin_group: + virtual_attribute_enabled: false + recursive_group_search: false + posix_support: true + user_sync_emails: false + user_sync_keys: false + user_sync_interval: 4 + team_sync_interval: 4 + sync_enabled: false + reconciliation: + user: + org: + profile: + uid: uid + name: + mail: + key: + cas: + url: + saml: + sso_url: + certificate: + certificate_path: + issuer: + idp_initiated_sso: false + disable_admin_demote: false + github_oauth: + client_id: '12313412' + client_secret: kj123131132 + organization_name: Homestar Runners + organization_team: homestarrunners/characters + smtp: + enabled: true + address: smtp.example.com + authentication: plain + port: '1234' + domain: blah + username: foo + user_name: mr_foo + enable_starttls_auto: true + password: bar + discard-to-noreply-address: true + support_address: enterprise@github.com + support_address_type: email + noreply_address: noreply@github.com + ntp: + primary_server: 0.pool.ntp.org + secondary_server: 1.pool.ntp.org + timezone: + snmp: + enabled: false + community: '' + syslog: + enabled: false + server: + protocol_name: udp + assets: + pages: + enabled: true + collectd: + enabled: false + server: + port: 0 + encryption: + username: + password: + mapping: + enabled: true + tileserver: + basemap: company.map-qsz2zrvs + token: + load_balancer: + run_list: + - recipe[enterprise-configure] + ssh-key-items: + value: + - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... + pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... + pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... + pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 + 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: + 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... + 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... + 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... + 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 + 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-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: + - email: mona@github.com + primary: false + verified: false + visibility: + 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: + 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: + 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 + 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 + 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 + 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 + 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 + 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: + 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= + 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: + 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' + 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 + project: + value: + owner_url: https://api.github.com/users/octocat + url: https://api.github.com/projects/1002603 + html_url: https://github.com/users/octocat/projects/1 + columns_url: https://api.github.com/projects/1002603/columns + id: 1002603 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + name: My Projects + body: A board to manage my personal projects. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + 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 + social-account-items: + value: + - provider: twitter + url: https://twitter.com/github + ssh-signing-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' + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + ssh-signing-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' + 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: + 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 + 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 + 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 + 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 + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: 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: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: false + 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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-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 + project-items-3: + value: + - owner_url: https://api.github.com/users/octocat + url: https://api.github.com/projects/1002603 + html_url: https://github.com/users/octocat/projects/1 + columns_url: https://api.github.com/projects/1002603/columns + id: 1002603 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + name: My Projects + body: A board to manage my personal projects. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + avatar_url: https://avatars.githubusercontent.com/u/9919? + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + avatar_url: https://avatars.githubusercontent.com/u/9919? + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + 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 + secret_type: mailchimp_api_key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + 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 + 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: + 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/enterprise-server@3.13/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/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + 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 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + key-ids: + name: key_ids + description: The unique identifier of the key. + 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 + 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 + pre-receive-environment-id: + name: pre_receive_environment_id + description: The unique identifier of the pre-receive environment. + in: path + required: true + schema: + type: integer + pre-receive-hook-id: + name: pre_receive_hook_id + description: The unique identifier of the pre-receive hook. + in: path + required: true + schema: + type: integer + token-id: + name: token_id + description: The unique identifier of the token. + in: path + required: true + schema: + type: integer + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + ghsa_id: + name: ghsa_id + description: The GHSA (GitHub Security Advisory) identifier of the advisory. + in: path + required: true + schema: + type: string + 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 + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + 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 + grant-id: + name: grant_id + description: The unique identifier of the grant. + in: path + required: true + schema: + type: integer + 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 + oauth-client-id: + name: client_id + in: path + required: true + description: The client ID of the OAuth app. + schema: + type: string + examples: + default: + value: abcde12345fghij67890 + authorization-id: + name: authorization_id + description: The unique identifier of the authorization. + in: path + required: true + schema: + type: integer + enterprise: + name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + org-id: + name: org_id + description: The unique identifier of the organization. + in: path + required: true + schema: + type: integer + visible-to-organization: + name: visible_to_organization + description: Only return runner groups that are allowed to be used by this organization. + 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 + audit-log-enterprise-phrase: + name: phrase + description: A search phrase. For more information, see [Searching the audit + log](https://docs.github.com/enterprise-server@3.13/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). + in: query + required: false + schema: + type: string + audit-log-include: + name: include + description: |- + The event types to include: + + - `web` - returns web (non-Git) events. + - `git` - returns Git events. + - `all` - returns both web and Git events. + + The default is `web`. + in: query + required: false + schema: + type: string + enum: + - web + - git + - all + audit-log-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events after this cursor. + in: query + required: false + schema: + type: string + audit-log-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events before this cursor. + in: query + required: false + schema: + type: string + audit-log-order: + name: order + description: |- + The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + + The default is `desc`. + in: query + required: false + schema: + type: string + enum: + - desc + - asc + 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-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-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. + schema: + type: string + enum: + - created + - updated + default: created + pagination-first: + name: first + description: |- + **Deprecated**. The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + Instead, use `per_page` in combination with `after` to fetch the first page of results. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + pagination-last: + name: last + description: |- + **Deprecated**. The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + Instead, use `per_page` in combination with `before` to fetch the last page of results. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + 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. By default all + secret types are returned. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.13/enterprise-cloud@latest/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-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-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-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 + enterprise-security-product: + name: security_product + in: path + description: The security feature to enable or disable. + required: true + schema: + type: string + enum: + - advanced_security + - advanced_security_user_namespace + - dependabot_alerts + - secret_scanning + - secret_scanning_push_protection + enterprise-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 enterprise. + `disable_all` means to disable the specified security feature for all repositories in the enterprise. + required: true + schema: + type: string + enum: + - enable_all + - disable_all + 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 + license-apply: + name: apply + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.13/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. + in: query + required: false + schema: + type: boolean + uuid: + name: uuid + description: The UUID which identifies a node. + in: query + required: false + schema: + type: string + cluster-roles: + name: cluster_roles + description: The cluster roles from the cluster configuration file. + in: query + required: false + 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 + 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/enterprise-server@3.13/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 + 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 + 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/enterprise-server@3.13/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 + audit-log-phrase: + name: phrase + description: A search phrase. For more information, see [Searching the audit + log](https://docs.github.com/enterprise-server@3.13/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). + in: query + required: false + schema: + type: string + role-id: + name: role_id + description: The unique identifier of the role. + in: path + required: true + schema: + type: integer + group-id: + name: group_id + description: The unique identifier of the group. + in: path + required: true + schema: + type: integer + members-per-page: + name: per_page + description: The number of results per page for the "members" array (max 100). + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + members-page: + name: page + description: The page number of the "members" array results to fetch. For more + information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.13/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 + 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/enterprise-server@3.13/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 + examples: + - 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 + examples: + - Hello-World + personal-access-token-permission: + name: permission + description: The permission to use to filter the results. + in: query + required: false + schema: + type: string + examples: + - 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 + 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 + 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 + examples: + - branch,tag,push + ref-in-query: + name: ref + description: The name of the ref. Cannot contain wildcard characters. 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 insights 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 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/enterprise-server@3.13/rest/repos/rule-suites#list-repository-rule-suites) + for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.13/rest/orgs/rule-suites#list-organization-rule-suites) + for organizations. + in: path + required: true + schema: + type: integer + secret-scanning-pagination-before-org-repo: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.13/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/enterprise-server@3.13/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 + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string + discussion-number: + name: discussion_number + description: The number that identifies the discussion. + in: path + required: true + schema: + type: integer + comment-number: + name: comment_number + description: The number that identifies the comment. + in: path + required: true + schema: + type: integer + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer + project-id: + name: project_id + description: The unique identifier of the project. + 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 + card-id: + name: card_id + description: The unique identifier of the card. + in: path + required: true + schema: + type: integer + column-id: + name: column_id + description: The unique identifier of the column. + in: path + required: true + schema: + type: integer + 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/enterprise-server@3.13/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/enterprise-server@3.13/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/enterprise-server@3.13/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" + 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" + 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. + 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" + 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 + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + 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 + 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 + tag-protection-id: + name: tag_protection_id + description: The unique identifier of the tag protection. + in: path + required: true + schema: + type: integer + 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 + excluded-attributes: + name: excludedAttributes + description: Excludes the specified attribute from being returned in the results. + Using this parameter can speed up response time. + in: query + required: false + schema: + type: string + examples: + - members + start-index: + name: startIndex + description: 'Used for pagination: the starting index of the first result to + return when paginating through values.' + in: query + required: false + schema: + type: integer + default: 1 + format: int32 + examples: + - 1 + count: + name: count + description: 'Used for pagination: the number of results to return per page.' + in: query + required: false + schema: + type: integer + default: 30 + format: int32 + examples: + - 1 + scim-group-id: + name: scim_group_id + description: A unique identifier of the SCIM group. + in: path + required: true + schema: + type: string + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + scim-user-id: + name: scim_user_id + description: The unique identifier of the SCIM user. + in: path + required: true + schema: + type: string + 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 + 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 + 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 + 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 + 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: + 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" + gone: + description: Gone + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-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" + 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" + 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 + - 'null' + message: + type: string + documentation_url: + type: string + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + conflict: + description: Conflict + 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. + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + no_content: + description: A header with no content is returned. + temporary_redirect: + description: Temporary Redirect + 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_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" + found: + description: Found + dependency_review_forbidden: + description: Response if GitHub Advanced Security is not enabled for this repository + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + unacceptable: + description: Unacceptable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + scim_bad_request: + description: Bad request + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + authorization_failure: + description: Authorization failure + permission_denied: + description: Permission denied + scim_too_many_requests: + description: Too many requests + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + scim_internal_error: + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + duplicate_record_detected: + description: Duplicate record detected diff --git a/etc/specs/GitHubEnterprise-3.14/current.spec.yaml b/etc/specs/GitHubEnterprise-3.14/current.spec.yaml new file mode 100644 index 00000000000..9785e3f3dfc --- /dev/null +++ b/etc/specs/GitHubEnterprise-3.14/current.spec.yaml @@ -0,0 +1,218112 @@ +--- +openapi: 3.1.0 +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: ghes + x-github-release: 3.14 +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 GitHub Orgs. +- name: packages + description: Manage packages for authenticated users and organizations. +- name: projects + description: Interact with GitHub Projects. +- 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: Look for stuff 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: scim + description: Provisioning of GitHub organization membership for SCIM-enabled providers. +- name: enterprise-admin + description: Enterprise Administration +- name: oauth-authorizations + description: OAuth Authorizations API +- name: security-advisories + description: Manage security advisories. +servers: +- url: "{protocol}://{hostname}/api/v3" + variables: + hostname: + description: Self-hosted Enterprise Server hostname + default: HOSTNAME + protocol: + description: Self-hosted Enterprise Server protocol + default: http +externalDocs: + description: GitHub Enterprise Developer Docs + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/rest/meta/meta#github-api-root + "/admin/hooks": + get: + summary: List global webhooks + description: '' + operationId: enterprise-admin/list-global-webhooks + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#list-global-webhooks + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + post: + summary: Create a global webhook + description: '' + operationId: enterprise-admin/create-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#create-a-global-webhook + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook" + 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: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: 'The [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) + that trigger this webhook. A global webhook can be triggered by + `user` and `organization` events. Default: `user` and `organization`.' + 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 + events: + - organization + - user + config: + url: https://example.com/webhook + content_type: json + secret: secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/hooks/{hook_id}": + get: + summary: Get a global webhook + description: '' + operationId: enterprise-admin/get-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#get-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + patch: + summary: Update a global webhook + description: Parameters that are not provided will be overwritten with the default + value or removed if no default exists. + operationId: enterprise-admin/update-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#update-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook-2" + examples: + default: + "$ref": "#/components/examples/global-hook-2" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: 'The [events](https://docs.github.com/enterprise-server@3.14/webhooks/event-payloads) + that trigger this webhook. A global webhook can be triggered by + `user` and `organization` events. Default: `user` and `organization`.' + 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: + events: + - organization + config: + url: https://example.com/webhook + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + delete: + summary: Delete a global webhook + description: '' + operationId: enterprise-admin/delete-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#delete-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/hooks/{hook_id}/pings": + post: + summary: Ping a global webhook + description: This will trigger a [ping event](https://docs.github.com/enterprise-server@3.14/webhooks/#ping-event) + to be sent to the webhook. + operationId: enterprise-admin/ping-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/global-webhooks#ping-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/keys": + get: + summary: List public keys + description: '' + operationId: enterprise-admin/list-public-keys + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#list-public-keys + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/public-key-full" + examples: + default: + "$ref": "#/components/examples/enterprise-public-key-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/keys/{key_ids}": + delete: + summary: Delete a public key + description: '' + operationId: enterprise-admin/delete-public-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-a-public-key + parameters: + - "$ref": "#/components/parameters/key-ids" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/ldap/teams/{team_id}/mapping": + patch: + summary: Update LDAP mapping for a team + description: Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) + (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) + must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.14/rest/teams/teams/#create-a-team) + endpoint to create a team with LDAP mapping. + operationId: enterprise-admin/update-ldap-mapping-for-team + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team + parameters: + - "$ref": "#/components/parameters/team-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ldap-mapping-team" + examples: + default: + "$ref": "#/components/examples/ldap-mapping-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + 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. + required: + - ldap_dn + examples: + default: + value: + ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/teams/{team_id}/sync": + post: + summary: Sync LDAP mapping for a team + description: Note that this API call does not automatically initiate an LDAP + sync. Rather, if a `201` is returned, the sync job is queued successfully, + and is performed when the instance is ready. + operationId: enterprise-admin/sync-ldap-mapping-for-team + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team + parameters: + - "$ref": "#/components/parameters/team-id" + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: + status: + type: string + examples: + default: + value: + status: queued + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/users/{username}/mapping": + patch: + summary: Update LDAP mapping for a user + description: '' + operationId: enterprise-admin/update-ldap-mapping-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ldap-mapping-user" + examples: + default: + "$ref": "#/components/examples/ldap-mapping-user" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + 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. + required: + - ldap_dn + examples: + default: + value: + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/users/{username}/sync": + post: + summary: Sync LDAP mapping for a user + description: Note that this API call does not automatically initiate an LDAP + sync. Rather, if a `201` is returned, the sync job is queued successfully, + and is performed when the instance is ready. + operationId: enterprise-admin/sync-ldap-mapping-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: + status: + type: string + examples: + default: + value: + status: queued + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/organizations": + post: + summary: Create an organization + description: '' + operationId: enterprise-admin/create-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/orgs#create-an-organization + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The organization's username. + admin: + type: string + description: The login of the user who will manage this organization. + profile_name: + type: string + description: The organization's display name. + required: + - login + - admin + examples: + default: + value: + login: github + profile_name: GitHub, Inc. + admin: monalisaoctocat + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: orgs + "/admin/organizations/{org}": + patch: + summary: Update an organization name + description: '' + operationId: enterprise-admin/update-org-name + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/orgs#update-an-organization-name + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Job queued to rename organization. It may take a few + minutes to complete. + url: https:///api/v3/organizations/1 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The organization's new name. + required: + - login + examples: + default: + value: + login: the-new-octocats + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: orgs + "/admin/pre-receive-environments": + get: + summary: List pre-receive environments + description: '' + operationId: enterprise-admin/list-pre-receive-environments + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + post: + summary: Create a pre-receive environment + description: '' + operationId: enterprise-admin/create-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The new pre-receive environment's name. + image_url: + type: string + description: URL from which to download a tarball of this environment. + required: + - name + - image_url + examples: + default: + value: + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}": + get: + summary: Get a pre-receive environment + description: '' + operationId: enterprise-admin/get-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + patch: + summary: Update a pre-receive environment + description: You cannot modify the default environment. If you attempt to modify + the default environment, you will receive a `422 Unprocessable Entity` response. + operationId: enterprise-admin/update-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default-response: + "$ref": "#/components/examples/pre-receive-environment-default-response" + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Cannot modify or delete the default environment + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: This pre-receive environment's new name. + image_url: + type: string + description: URL from which to download a tarball of this environment. + examples: + default: + value: + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + delete: + summary: Delete a pre-receive environment + description: |- + If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. + + The possible error messages are: + + * _Cannot modify or delete the default environment_ + * _Cannot delete environment that has hooks_ + * _Cannot delete environment when download is in progress_ + operationId: enterprise-admin/delete-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '204': + description: Response + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Cannot modify or delete the default environment + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": + post: + summary: Start a pre-receive environment download + description: |- + Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. + + If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + + The possible error messages are: + + * _Cannot modify or delete the default environment_ + * _Can not start a new download when a download is in progress_ + operationId: enterprise-admin/start-pre-receive-environment-download + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment-download-status" + examples: + default-response: + "$ref": "#/components/examples/pre-receive-environment-download-status-default-response" + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Can not start a new download when a download is in + progress + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": + get: + summary: Get the download status for a pre-receive environment + description: In addition to seeing the download status at the "[Get a pre-receive + environment](#get-a-pre-receive-environment)" endpoint, there is also this + separate endpoint for just the download status. + operationId: enterprise-admin/get-download-status-for-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment-download-status" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment-download-status" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-hooks": + get: + summary: List pre-receive hooks + description: '' + operationId: enterprise-admin/list-pre-receive-hooks + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + post: + summary: Create a pre-receive hook + description: '' + operationId: enterprise-admin/create-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the hook. + script: + type: string + description: The script that the hook runs. + script_repository: + type: object + description: The GitHub repository where the script is kept. + properties: {} + additionalProperties: true + environment: + type: object + description: The pre-receive environment where the script is executed. + properties: {} + additionalProperties: true + enforcement: + type: string + description: 'The state of enforcement for this hook. default: `disabled`' + allow_downstream_configuration: + type: boolean + description: 'Whether enforcement can be overridden at the org or + repo level. default: `false`' + required: + - name + - script + - script_repository + - environment + examples: + default: + value: + name: Check Commits + script: scripts/commit_check.sh + enforcement: disabled + allow_downstream_configuration: false + script_repository: + full_name: DevIT/hooks + environment: + id: 2 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + "/admin/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook + description: '' + operationId: enterprise-admin/get-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + patch: + summary: Update a pre-receive hook + description: '' + operationId: enterprise-admin/update-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the hook. + script: + type: string + description: The script that the hook runs. + script_repository: + type: object + description: The GitHub repository where the script is kept. + properties: {} + additionalProperties: true + environment: + type: object + description: The pre-receive environment where the script is executed. + properties: {} + additionalProperties: true + enforcement: + type: string + description: The state of enforcement for this hook. + allow_downstream_configuration: + type: boolean + description: Whether enforcement can be overridden at the org or + repo level. + examples: + default: + value: + name: Check Commits + environment: + id: 1 + allow_downstream_configuration: true + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + delete: + summary: Delete a pre-receive hook + description: '' + operationId: enterprise-admin/delete-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + "/admin/tokens": + get: + summary: List personal access tokens + description: Lists personal access tokens for all users, including admin users. + operationId: enterprise-admin/list-personal-access-tokens + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#list-personal-access-tokens + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/classic-personal-access-tokens" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/tokens/{token_id}": + delete: + summary: Delete a personal access token + description: Deletes a personal access token. Returns a `403 - Forbidden` status + when a personal access token is in use. For example, if you access this endpoint + with the same personal access token that you are trying to delete, you will + receive this error. + operationId: enterprise-admin/delete-personal-access-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-a-personal-access-token + parameters: + - "$ref": "#/components/parameters/token-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users": + post: + summary: Create a user + description: |- + If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + + The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. + + If the login name or email address is already associated with an account, the server will return a `422` response. + operationId: enterprise-admin/create-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#create-a-user + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The user's username. + email: + type: string + description: |- + **Required for built-in authentication.** The user's email + address. This parameter can be omitted when using CAS, LDAP, or SAML. + For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." + suspended: + type: boolean + description: Whether to set the user as suspended when the user + is created. + default: false + required: + - login + examples: + default: + value: + login: monalisa + email: octocat@github.com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users/{username}": + patch: + summary: Update the username for a user + description: '' + operationId: enterprise-admin/update-username-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#update-the-username-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Job queued to rename user. It may take a few minutes + to complete. + url: https://api.github.com/user/1 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The user's new username. + required: + - login + examples: + default: + value: + login: thenewmonalisa + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Delete a user + description: |- + Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#suspend-a-user) is often a better option. + + You can delete any user account except your own. + operationId: enterprise-admin/delete-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users/{username}/authorizations": + post: + summary: Create an impersonation OAuth token + description: '' + operationId: enterprise-admin/create-impersonation-o-auth-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#create-an-impersonation-oauth-token + parameters: + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Response when creating a new impersonation OAuth token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + '200': + description: Response when getting an existing impersonation OAuth token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scopes: + type: array + description: A list of [scopes](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + items: + type: string + required: + - scopes + examples: + default: + value: + scopes: + - public_repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Delete an impersonation OAuth token + description: '' + operationId: enterprise-admin/delete-impersonation-o-auth-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#delete-an-impersonation-oauth-token + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + "/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/enterprise-server@3.14/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + 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)." + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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)." + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/rest/apps/webhooks#list-deliveries-for-an-app-webhook + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/cursor" + 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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 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/enterprise-server@3.14/rest/apps/apps#suspend-an-app-installation)" endpoint. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + "/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\nWhen using the repository or permission parameters to + reduce the access of the token, the complexity of the token is increased due + to both the number of permissions in the request and the number of repositories + the token will have access to. If the complexity is too large, the token will + fail to be issued. If this occurs, the error message will indicate the maximum + number of repositories that should be requested. For the average application + requesting 8 permissions, this limit is around 5000 repositories. With fewer + permissions requested, more repositories are supported.\n\nYou must use a + [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - rails + repository_ids: + description: List of repository IDs that the token should have access + to + type: array + items: + type: integer + examples: + - 1 + 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 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 Enterprise Server API or webhook events is blocked for that account. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/grants": + get: + summary: List your grants + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-grants + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/application-grant" + examples: + default: + "$ref": "#/components/examples/application-grant-items" + 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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/applications/grants/{grant_id}": + get: + summary: Get a single grant + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-grant + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant + parameters: + - "$ref": "#/components/parameters/grant-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/application-grant" + examples: + default: + "$ref": "#/components/examples/application-grant" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + delete: + summary: Delete a grant + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-grant + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#delete-a-grant + parameters: + - "$ref": "#/components/parameters/grant-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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + examples: + - 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 + examples: + - octocat + target_id: + description: The ID of the user or organization to scope the user + access token to. **Required** unless `target` is specified. + type: integer + examples: + - 1 + 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 + examples: + - 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. + type: array + items: + type: integer + examples: + - 1 + 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] + > 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/enterprise-server@3.14/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 + "/authorizations": + get: + summary: List your authorizations + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-items" + 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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + post: + summary: Create a new authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.14/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + + To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + + You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.14/articles/creating-an-access-token-for-command-line-use). + + Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.14/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. + tags: + - oauth-authorizations + operationId: oauth-authorizations/create-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + client_id: + description: The OAuth app client key for which to create the token. + maxLength: 20 + type: string + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + examples: + default: + summary: Create an authorization + value: + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + client_id: abcde12345fghij67890 + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + '410': + "$ref": "#/components/responses/gone" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/clients/{client_id}": + put: + summary: Get-or-create an authorization for a specific app + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app + parameters: + - "$ref": "#/components/parameters/oauth-client-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + required: + - client_secret + type: object + examples: + default: + summary: Create an authorization for an app + value: + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + responses: + '200': + description: if returning an existing token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + response-if-returning-an-existing-token: + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token-2" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '201': + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/clients/{client_id}/{fingerprint}": + put: + summary: Get-or-create an authorization for a specific app and fingerprint + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + parameters: + - "$ref": "#/components/parameters/oauth-client-id" + - name: fingerprint + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + properties: + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + required: + - client_secret + type: object + examples: + default: + summary: Create an authorization for an app and fingerprint + value: + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + responses: + '200': + description: if returning an existing token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + response-if-returning-an-existing-token: + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '201': + description: Response if returning a new token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-3" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/{authorization_id}": + get: + summary: Get a single authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization + parameters: + - "$ref": "#/components/parameters/authorization-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-2" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + patch: + summary: Update an existing authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.14/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + + You can only send one of these scope keys at a time. + tags: + - oauth-authorizations + operationId: oauth-authorizations/update-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization + parameters: + - "$ref": "#/components/parameters/authorization-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + add_scopes: + description: A list of scopes to add to this authorization. + type: array + items: + type: string + remove_scopes: + description: A list of scopes to remove from this authorization. + type: array + items: + type: string + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + examples: + default: + summary: Example of updating scopes and note + value: + add_scopes: + - public_repo + remove_scopes: + - user + note: optional note + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-2" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + delete: + summary: Delete an authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.14/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization + parameters: + - "$ref": "#/components/parameters/authorization-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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + "/emojis": + get: + summary: Get emojis + description: Lists all the emojis available to use on GitHub Enterprise Server. + operationId: emojis/get + tags: + - emojis + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + "/enterprise/announcement": + get: + summary: Get the global announcement banner + description: Gets the current message and expiration date of the global announcement + banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/get-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/announcement#get-the-global-announcement-banner + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + patch: + summary: Set the global announcement banner + description: Sets the message and expiration time for the global announcement + banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/set-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/announcement#set-the-global-announcement-banner + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + value: + announcement: Very **important** announcement about _something_. + expires_at: '2021-01-01T00:00:00.000+00:00' + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + delete: + summary: Remove the global announcement banner + description: Removes the global announcement banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/announcement#remove-the-global-announcement-banner + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + "/enterprise/settings/license": + get: + summary: Get license information + description: '' + operationId: enterprise-admin/get-license-information + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/license#get-license-information + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/license-info" + examples: + default: + "$ref": "#/components/examples/license-info" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: license + "/enterprise/stats/all": + get: + summary: Get all statistics + description: '' + operationId: enterprise-admin/get-all-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-all-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-overview" + examples: + default: + "$ref": "#/components/examples/enterprise-overview" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/comments": + get: + summary: Get comment statistics + description: '' + operationId: enterprise-admin/get-comment-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-comment-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-comment-overview" + examples: + default: + value: + total_commit_comments: 5000 + total_gist_comments: 400 + total_issue_comments: 10900 + total_pull_request_comments: 9900 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/gists": + get: + summary: Get gist statistics + description: '' + operationId: enterprise-admin/get-gist-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-gist-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-gist-overview" + examples: + default: + value: + total_gists: 500 + private_gists: 30 + public_gists: 470 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/hooks": + get: + summary: Get hooks statistics + operationId: enterprise-admin/get-hooks-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-hooks-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-hook-overview" + examples: + default: + value: + total_hooks: 50 + active_hooks: 47 + inactive_hooks: 3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/issues": + get: + summary: Get issue statistics + description: '' + operationId: enterprise-admin/get-issue-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-issue-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-issue-overview" + examples: + default: + value: + total_issues: 5000 + open_issues: 300 + closed_issues: 4700 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/milestones": + get: + summary: Get milestone statistics + description: '' + operationId: enterprise-admin/get-milestone-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-milestone-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-milestone-overview" + examples: + default: + value: + total_milestones: 90 + open_milestones: 10 + closed_milestones: 80 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/orgs": + get: + summary: Get organization statistics + description: '' + operationId: enterprise-admin/get-org-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-organization-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-organization-overview" + examples: + default: + value: + total_orgs: 50 + disabled_orgs: 1 + total_teams: 70 + total_team_members: 700 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/pages": + get: + summary: Get pages statistics + description: '' + operationId: enterprise-admin/get-pages-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-pages-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-page-overview" + examples: + default: + value: + total_pages: 20 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/pulls": + get: + summary: Get pull request statistics + description: '' + operationId: enterprise-admin/get-pull-request-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-pull-request-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-pull-request-overview" + examples: + default: + value: + total_pulls: 1200 + merged_pulls: 1100 + mergeable_pulls: 90 + unmergeable_pulls: 10 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/repos": + get: + summary: Get repository statistics + operationId: enterprise-admin/get-repo-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-repository-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-repository-overview" + examples: + default: + value: + total_repos: 200 + root_repos: 1 + fork_repos: 10 + org_repos: 150 + total_pushes: 39000 + total_wikis: 5 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/security-products": + get: + summary: Get security products statistics + description: |- + Gets the statistics about security products for a GitHub Enterprise Server instance. + + To use this endpoint, you must be a site admin. + operationId: enterprise-admin/get-security-products + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-security-products-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-security-products-overview" + examples: + default: + "$ref": "#/components/examples/enterprise-security-products-overview" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/users": + get: + summary: Get users statistics + description: '' + operationId: enterprise-admin/get-user-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/admin-stats#get-users-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-user-overview" + examples: + default: + value: + total_users: 100 + admin_users: 3 + suspended_users: 1 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprises/{enterprise}/actions/cache/usage": + get: + summary: Get GitHub Actions cache usage for an enterprise + description: |- + Gets the total GitHub Actions cache usage for an enterprise. + 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 `admin:enterprise` scope to use this endpoint. + operationId: actions/get-actions-cache-usage-for-enterprise + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/usage-policy": + get: + summary: Get GitHub Actions cache usage policy for an enterprise + description: |- + Gets the GitHub Actions cache usage policy for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-policy-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-usage-policy-enterprise" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + category: actions + subcategory: cache + patch: + summary: Set GitHub Actions cache usage policy for an enterprise + description: |- + Sets the GitHub Actions cache usage policy for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-usage-policy-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-usage-policy-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/permissions": + get: + summary: Get GitHub Actions permissions for an enterprise + description: |- + Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-enterprise-permissions" + examples: + default: + "$ref": "#/components/examples/actions-enterprise-permissions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set GitHub Actions permissions for an enterprise + description: |- + Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + required: + - enabled_organizations + examples: + default: + value: + enabled_organizations: all + allowed_actions: selected + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/organizations": + get: + summary: List selected organizations enabled for GitHub Actions in an enterprise + description: |- + Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + organizations: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + required: + - total_count + - organizations + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set selected organizations enabled for GitHub Actions in an enterprise + description: |- + Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + examples: + default: + value: + selected_organization_ids: + - 32 + - 91 + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": + put: + summary: Enable a selected organization for GitHub Actions in an enterprise + description: |- + Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + delete: + summary: Disable a selected organization for GitHub Actions in an enterprise + description: |- + Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for an enterprise + description: |- + Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set allowed actions for an enterprise + description: |- + Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/workflow": + get: + summary: Get default workflow permissions for an enterprise + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, + as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success 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: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set default workflow permissions for an enterprise + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets + whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + responses: + '204': + description: Success response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an enterprise + description: |- + Lists all self-hosted runner groups for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runner-groups-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/visible-to-organization" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runner_groups: + type: array + items: + "$ref": "#/components/schemas/runner-groups-enterprise" + required: + - total_count + - runner_groups + examples: + default: + "$ref": "#/components/examples/runner-groups-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + post: + summary: Create a self-hosted runner group for an enterprise + description: |- + Creates a new self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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 organizations + or select individual organization. + type: string + enum: + - selected + - all + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_organization_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an enterprise + description: |- + Gets a specific self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + patch: + summary: Update a self-hosted runner group for an enterprise + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/update-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: false + 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 organizations + or select individual organizations. + type: string + enum: + - selected + - all + default: all + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-update-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Delete a self-hosted runner group from an enterprise + description: |- + Deletes a self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": + get: + summary: List organization access to a self-hosted runner group in an enterprise + description: |- + Lists the organizations with access to a self-hosted runner group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + properties: + total_count: + type: number + organizations: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + required: + - total_count + - organizations + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set organization access for a self-hosted runner group in an enterprise + description: |- + Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + examples: + default: + value: + selected_organization_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": + put: + summary: Add organization access to a self-hosted runner group in an enterprise + description: |- + Adds an organization to the list of selected organizations 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 enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove organization access to a self-hosted runner group in an enterprise + description: |- + Removes an organization from the list of selected organizations 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 enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an enterprise + description: |- + Lists the self-hosted runners that are in a specific enterprise group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + required: + - total_count + - runners + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set self-hosted runners in a group for an enterprise + description: |- + Replaces the list of self-hosted runners that are part of an enterprise runner group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an enterprise + description: |- + Adds a self-hosted runner to a runner group configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-self-hosted-runner-to-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove a self-hosted runner from a group for an enterprise + description: |- + Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runners": + get: + summary: List self-hosted runners for an enterprise + description: |- + Lists all self-hosted runners configured for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + 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: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/downloads": + get: + summary: List runner applications for an enterprise + description: |- + Lists binaries for the runner application that you can download and run. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-runner-applications-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/runner-application" + examples: + default: + "$ref": "#/components/examples/runner-application-items-airgap" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/generate-jitconfig": + post: + summary: Create configuration for a just-in-time runner for an Enterprise + description: |- + Generates a configuration that can be passed to the runner application at startup. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/registration-token": + post: + summary: Create a registration token for an enterprise + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + 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/enterprises/octo-enterprise --token TOKEN + ``` + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-registration-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authentication-token" + examples: + default: + "$ref": "#/components/examples/authentication-token" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/remove-token": + post: + summary: Create a remove token for an enterprise + description: |- + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + + Example using remove token: + + To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + endpoint. + + ``` + ./config.sh remove --token TOKEN + ``` + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-remove-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authentication-token" + examples: + default: + "$ref": "#/components/examples/authentication-token-2" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}": + get: + summary: Get a self-hosted runner for an enterprise + description: |- + Gets a specific self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + delete: + summary: Delete a self-hosted runner from an enterprise + description: |- + Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": + get: + summary: List labels for a self-hosted runner for an enterprise + description: |- + Lists all labels for a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '200': + "$ref": "#/components/responses/actions_runner_labels" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + post: + summary: Add custom labels to a self-hosted runner for an enterprise + description: |- + Add custom labels to a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + put: + summary: Set custom labels for a self-hosted runner for an enterprise + description: |- + Remove all previous custom labels and set the new custom labels for a specific + self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + delete: + summary: Remove all custom labels from a self-hosted runner for an enterprise + description: |- + Remove all custom labels from a self-hosted runner configured in an + enterprise. Returns the remaining read-only labels from the runner. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '200': + "$ref": "#/components/responses/actions_runner_labels_readonly" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": + delete: + summary: Remove a custom label from a self-hosted runner for an enterprise + description: |- + Remove a custom label from a self-hosted runner configured + in an enterprise. 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. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/audit-log": + get: + summary: Get the audit log for an enterprise + operationId: enterprise-admin/get-audit-log + description: |- + Gets the audit log for an enterprise. + + The authenticated user must be an enterprise admin to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/audit-log-enterprise-phrase" + - "$ref": "#/components/parameters/audit-log-include" + - "$ref": "#/components/parameters/audit-log-after" + - "$ref": "#/components/parameters/audit-log-before" + - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/audit-log-event" + examples: + default: + "$ref": "#/components/examples/audit-log" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: audit-log + "/enterprises/{enterprise}/code-scanning/alerts": + get: + summary: List code scanning alerts for an enterprise + description: |- + Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + The authenticated user must be a member of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + 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: true + enabledForGitHubApps: false + previews: [] + category: code-scanning + subcategory: code-scanning + "/enterprises/{enterprise}/code_security_and_analysis": + get: + summary: Get code security and analysis features for an enterprise + description: |- + Gets code security and analysis settings for the specified 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: + - enterprise-admin + operationId: secret-scanning/get-security-analysis-settings-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-security-analysis-settings" + examples: + default: + "$ref": "#/components/examples/enterprise-security-analysis-settings" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + patch: + summary: Update code security and analysis features for an enterprise + description: |- + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. + + The authenticated user must be an administrator of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: secret-scanning/patch-security-analysis-settings-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + advanced_security_enabled_for_new_repositories: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled + for new repositories. For more information, see "[About GitHub + Advanced Security](https://docs.github.com/enterprise-server@3.14/get-started/learning-about-github/about-github-advanced-security)." + advanced_security_enabled_new_user_namespace_repos: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled + for new user namespace repositories. For more information, see + "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.14/get-started/learning-about-github/about-github-advanced-security)." + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: Whether Dependabot alerts are automatically enabled + for new repositories. For more information, see "[About Dependabot + alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + secret_scanning_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning is automatically enabled for + new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning push protection is automatically + enabled for new repositories. For more information, see "[Protecting + pushes with secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: |- + The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + To disable this functionality, set this field to `null`. + examples: + default: + value: + advanced_security_enabled_for_new_repositories: true + advanced_security_enabled_new_user_namespace_repos: true + dependabot_alerts_enabled_for_new_repositories: true + secret_scanning_enabled_for_new_repositories: true + secret_scanning_push_protection_enabled_for_new_repositories: true + secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md + 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 + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + "/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + - "$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}/secret-scanning/alerts": + get: + summary: List secret scanning alerts for an enterprise + description: |- + 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/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/secret-scanning-alert-state" + - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" + 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: false + category: secret-scanning + subcategory: secret-scanning + "/enterprises/{enterprise}/settings/billing/advanced-security": + get: + summary: Get GitHub Advanced Security active committers for an enterprise + description: |- + Gets the GitHub Advanced Security active committers for an enterprise per repository. + + Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository. + + The total number of repositories with committer information is tracked by the `total_count` field. + tags: + - billing + operationId: billing/get-github-advanced-security-billing-ghe + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/advanced-security-active-committers" + examples: + default: + "$ref": "#/components/examples/advanced-security-active-committers" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: billing + "/enterprises/{enterprise}/{security_product}/{enablement}": + post: + summary: Enable or disable a security feature + description: |- + Enables or disables the specified security feature for all repositories in an enterprise. + + The authenticated user must be an administrator of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: secret-scanning/post-security-product-enablement-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-security-product" + - "$ref": "#/components/parameters/enterprise-security-product-enablement" + 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 + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + "/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/enterprise-server@3.14/rest/activity/events#list-public-events + parameters: + - "$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-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. + + * **Timeline**: The GitHub Enterprise Server global public timeline + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.14/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 Enterprise Server. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/rest/gists/gists#create-a-gist + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: Description of the gist + type: string + examples: + - Example Ruby script + files: + description: Names and content for the files that make up the gist + type: object + additionalProperties: + type: object + properties: + content: + description: Content of the file + readOnly: false + type: string + required: + - content + examples: + - hello.rb: + content: puts "Hello, World!" + public: + oneOf: + - description: Flag indicating whether the gist is public + type: boolean + default: false + examples: + - true + - type: string + default: 'false' + enum: + - 'true' + - 'false' + examples: + - 'true' + 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. + + Note: With [pagination](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/update + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + type: string + examples: + - Example Ruby script + 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`. + type: object + additionalProperties: + type: + - object + - 'null' + properties: + content: + description: The new content of the file. + type: string + filename: + description: The new filename for the file. + type: + - string + - 'null' + examples: + - hello.rb: + content: blah + filename: goodbye.rb + type: + - object + - 'null' + 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: + "$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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + examples: + - 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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + examples: + - 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get-revision + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: + "$ref": "#/components/schemas/repository" + repository_selection: + type: string + examples: + - 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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + "/manage/v1/access/ssh": + get: + summary: Get the configured SSH keys + description: Gets the configured SSH keys on all available nodes. For more information, + see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/get-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-ssh" + examples: + default: + "$ref": "#/components/examples/ghes-get-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Set a new SSH key + description: Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise + Server instance. This will grant access via SSH to your instance. For more + information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/set-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-ssh-request" + examples: + default: + value: + key: ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw== + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-ssh-response" + examples: + default: + "$ref": "#/components/examples/ghes-set-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + delete: + summary: Delete a SSH key + description: Deletes a SSH key from the `authorized_keys` file for your GitHub + Enterprise Server instance. This will remove access via SSH to your instance. + For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.14/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/delete-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#delete-a-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-delete-ssh-request" + examples: + default: + value: + key: ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw== + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-delete-ssh-response" + examples: + default: + "$ref": "#/components/examples/ghes-delete-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/checks/system-requirements": + get: + summary: Get the system requirement check results for configured cluster nodes + description: |- + Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-checks-system-requirements + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-checks-system-requirements" + examples: + default: + "$ref": "#/components/examples/ghes-checks-system-requirements" + '400': + description: Bad request + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/cluster/status": + get: + summary: Get the status of services running on all cluster nodes + description: |- + Gets the status of all services running on each cluster node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-cluster-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-cluster-status" + examples: + default: + "$ref": "#/components/examples/ghes-cluster-status" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/apply": + get: + summary: Get the status of a ghe-config-apply run + description: Displays the current status of `ghe-config-apply` in the environment + or the status of a historical run by ID. + operationId: enterprise-admin/get-manage-config-apply-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run + parameters: + - name: run_id + description: The unique run ID of the `ghe-config-apply` run. + in: query + required: false + schema: + type: string + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + running: + type: boolean + description: Whether the ghe-config-apply run is still running + in the environment + successful: + type: boolean + description: Whether the ghe-config-apply run was successful in + the environment + nodes: + type: array + items: + type: object + properties: + run_id: + type: string + description: The unique Run ID of the ghe-config-apply run + on the host + hostname: + type: string + description: The hostname of the node + running: + type: boolean + description: Whether the ghe-config-apply run is still running + on the host + successful: + type: boolean + description: Whether the ghe-config-apply run was successful + on the host + examples: + default: + value: + running: true + successful: false + nodes: + - run_id: d34db33f + hostname: ghes-01.lan + running: true + successful: false + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Trigger a ghe-config-apply run + description: |- + Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + You can provide a run ID or allow one to be generated randomly. + operationId: enterprise-admin/post-manage-run-config-apply + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + description: The run ID to execute `ghe-config-apply` with. If not + provided, a run ID will be generated randomly. + examples: + default: + value: + run_id: d34db33f + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + description: Run ID the job was launched with + examples: + default: + value: + run_id: d34db33f + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/apply/events": + get: + summary: List events from ghe-config-apply + description: Lists events from an in-process `ghe-config-apply` run on your + Github Enterprise Server instance. + operationId: enterprise-admin/get-manage-config-apply-events + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply + parameters: + - name: last_request_id + description: The unique ID of the last response from a host, used for pagination. + in: query + required: false + schema: + type: string + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + nodes: + type: array + items: + type: object + properties: + node: + type: string + description: Hostname of the node + last_request_id: + type: string + description: Unique ID of the last response from a host + used for pagination + events: + type: array + items: + type: object + properties: + timestamp: + type: string + severity_text: + type: string + body: + type: string + event_name: + type: string + topology: + type: string + hostname: + type: string + config_run_id: + type: string + trace_id: + type: string + span_id: + type: string + span_parent_id: + type: string + span_depth: + type: integer + examples: + default: + value: + nodes: + - node: ghes-01.lan + last_request_id: 387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000 + events: + - timestamp: '2023-01-01T13:00:00+00:00' + severity_text: INFO + body: Validating services + event_name: Enterprise::ConfigApply::PhaseValidation#config_phase_validation + topology: multinode + hostname: ghes-01.lan + config_run_id: d34db33f + trace_id: 387cd628c06d606700e79be368e5e574 + span_id: 0cde553750689c76 + span_parent_id: 0 + span_depth: 0 + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/init": + post: + summary: Initialize instance configuration with license and password + description: |- + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/initialize-instance-configuration + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + multipart/form-data: + schema: + "$ref": "#/components/schemas/ghes-config-init-request" + examples: + default: + value: + license: "@enterprise.ghl" + password: provide-password-here! + responses: + '202': + description: Response + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/license": + get: + summary: Get the enterprise license information + description: Gets information about the license that is currently set for the + enterprise. + operationId: enterprise-admin/license-info + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-license-info" + examples: + default: + "$ref": "#/components/examples/ghes-license-info" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + put: + summary: Upload an enterprise license + description: |- + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/license-upload + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/license-apply" + requestBody: + required: true + content: + multipart/form-data: + schema: + "$ref": "#/components/schemas/ghes-upload-license-request" + examples: + default: + value: + license: "@enterprise.ghl" + responses: + '201': + description: Created + '202': + description: Accepted + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/license/check": + get: + summary: Check a license + description: Check the status of the license that is currently set for the enterprise. + operationId: enterprise-admin/license-check + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#check-a-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-license-check" + examples: + default: + "$ref": "#/components/examples/ghes-license-check" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/nodes": + get: + summary: Get GHES node metadata for all nodes + description: Get node metadata for all configured nodes in the current cluster. + For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.14/admin/enterprise-management/configuring-clustering/about-clustering)." + operationId: enterprise-admin/get-config-nodes + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-config-nodes" + examples: + default: + "$ref": "#/components/examples/ghes-config-nodes" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/settings": + get: + summary: Get the GHES settings + description: Gets a list of settings for a GitHub Enterprise Server instance. + operationId: enterprise-admin/get-manage-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-ghes-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-settings" + examples: + default: + "$ref": "#/components/examples/ghes-get-settings" + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + put: + summary: Set settings + description: |- + Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-settings). + + **Notes:** + - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + operationId: enterprise-admin/set-manage-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#set-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + description: Only the settings parameters that should be modified need to + be specified. + content: + application/json: + schema: + type: object + examples: + default: + value: + public_pages: true + responses: + '204': + description: Response + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/maintenance": + get: + summary: Get the status of maintenance mode + description: Gets the status and details of maintenance mode on all available + nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + operationId: enterprise-admin/get-manage-maintenance + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-maintenance" + examples: + default: + "$ref": "#/components/examples/ghes-get-maintenance" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Set the status of maintenance mode + description: Sets or schedules the maintenance mode. For more information, see + "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + operationId: enterprise-admin/set-manage-maintenance + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-maintenance-request" + examples: + default: + value: + enabled: true + when: '2006-01-02T15:04:05+00:00' + ip_exception_list: + - 192.168.1.0/24 + - 1.1.1.1 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-maintenance-response" + examples: + default: + "$ref": "#/components/examples/ghes-set-maintenance" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/replication/status": + get: + summary: Get the status of services running on all replica nodes + description: |- + Gets the status of all services running on each replica node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-replication-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-replication-status" + examples: + default: + "$ref": "#/components/examples/ghes-replication-status" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/version": + get: + summary: Get all GHES release versions for all nodes + description: Gets the GitHub Enterprise Server release versions that are currently + installed on all available nodes. For more information, see "[GitHub Enterprise + Server releases](https://docs.github.com/enterprise-server@3.14/admin/all-releases)." + operationId: enterprise-admin/get-version + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-version" + examples: + default: + "$ref": "#/components/examples/ghes-version" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/markdown": + post: + summary: Render a Markdown document + description: '' + operationId: markdown/render + tags: + - markdown + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + type: string + examples: + - markdown + 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/enterprise-server@3.14/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 + "/meta": + get: + summary: Get GitHub Enterprise Server meta information + description: '' + tags: + - meta + operationId: meta/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise + Server: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-read + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 Enterprise + Server as done: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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**. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/{organization_id}/custom_roles": + get: + summary: Closing down - List custom repository roles in an organization + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be administrator of the organization or of a repository of the organization 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/list-custom-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization + parameters: + - name: organization_id + description: The unique identifier of the organization. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response - list of custom role names + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of custom roles in this organization + type: integer + examples: + - 3 + custom_roles: + type: array + items: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + removalDate: '2025-02-15' + deprecationDate: '2023-02-15' + category: orgs + subcategory: custom-roles + deprecated: true + "/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, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.14/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 Enterprise Server plan, GitHub Apps need the `Organization plan` permission. + tags: + - orgs + operationId: orgs/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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] + > **Closing down notice:** GitHub Enterprise Server 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 and will be replaced with code security configurations in a future GitHub Enterprise Server version. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. \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_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 + examples: + - '"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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + 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 + 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/enterprise-server@3.14/site-policy/github-terms/github-terms-of-service + operationId: orgs/delete + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + "/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/enterprise-server@3.14/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. + 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/enterprise-server@3.14/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/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + "$ref": "#/components/schemas/oidc-custom-sub" + 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: + '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 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. + operationId: actions/get-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 in an organization. + + If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the 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/enterprise-server@3.14/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" + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: all + allowed_actions: selected + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + 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/enterprise-server@3.14/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)." + + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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 for an organization + description: |- + Gets the selected actions 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. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 for an organization + description: |- + Sets the actions 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)." + + If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the 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/enterprise-server@3.14/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/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + can submit approving pull request reviews. For more information, see + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/rest/actions/permissions#set-default-workflow-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Success response + '409': + description: Conflict response when changing a setting is prevented by the + owning enterprise + 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + 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. + + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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-airgap" + 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/enterprise-server@3.14/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" + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/rest/actions/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: + '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/enterprise-server@3.14/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` + 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/enterprise-server@3.14/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/actions/secrets#add-selected-repository-to-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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}/announcement": + get: + summary: Get announcement banner for organization + description: |- + Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the + organization level. Organization members may also see an enterprise-level announcement banner. To get an + announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + tags: + - orgs + operationId: announcement-banners/get-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/announcement-banners/organizations#get-announcement-banner-for-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement-banner" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + patch: + summary: Set announcement banner for organization + description: Sets the announcement banner to display for the organization. + tags: + - orgs + operationId: announcement-banners/set-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/announcement-banners/organizations#set-announcement-banner-for-organization + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement-banner" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + delete: + summary: Remove announcement banner from organization + description: Removes the announcement banner currently set for the organization. + tags: + - orgs + operationId: announcement-banners/remove-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/announcement-banners/organizations#remove-announcement-banner-from-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + "/orgs/{org}/audit-log": + get: + summary: Get the audit log for an organization + description: |- + Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + + By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.14/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + + Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api)." + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + operationId: orgs/get-audit-log + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/orgs#get-the-audit-log-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/audit-log-phrase" + - "$ref": "#/components/parameters/audit-log-include" + - "$ref": "#/components/parameters/audit-log-after" + - "$ref": "#/components/parameters/audit-log-before" + - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/audit-log-event" + examples: + default: + "$ref": "#/components/examples/audit-log" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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" + 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}/custom-repository-roles": + get: + summary: List custom repository roles in an organization + description: |- + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/list-custom-repo-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response - list of custom role names + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of custom roles in this organization + type: integer + examples: + - 3 + custom_roles: + type: array + items: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-list-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + post: + summary: Create a custom repository role + description: |- + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/create-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#create-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" + examples: + default: + value: + name: Labeler + description: A role for issue and pull request labelers + base_role: read + permissions: + - add_label + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/orgs/{org}/custom-repository-roles/{role_id}": + get: + summary: Get a custom repository role + description: |- + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/get-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#get-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + patch: + summary: Update a custom repository role + description: |- + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/update-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#update-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" + examples: + default: + value: + name: Labeler + description: A role for issue and PR labelers + base_role: read + permissions: + - add_label + - remove_label + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + delete: + summary: Delete a custom repository role + description: |- + Deletes a custom role from an organization. Once the custom role has been deleted, any + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/delete-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#delete-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/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/enterprise-server@3.14/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + - "$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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + 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: + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: 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/enterprise-server@3.14/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` + 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/enterprise-server@3.14/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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}/external-group/{group_id}": + get: + summary: Get an external group + description: |- + Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/external-idp-group-info-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#get-an-external-group + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/group-id" + - "$ref": "#/components/parameters/members-per-page" + - "$ref": "#/components/parameters/members-page" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-group" + examples: + default: + "$ref": "#/components/examples/external-group" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + "/orgs/{org}/external-groups": + get: + summary: List external groups in an organization + description: |- + Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/list-external-idp-groups-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-external-groups-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - name: page + description: Page token + in: query + schema: + type: integer + - name: display_name + description: Limits the list to groups containing the text in the group name + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-groups" + examples: + default: + "$ref": "#/components/examples/external-groups" + headers: + Link: + example: ; + rel="next" + schema: + type: string + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + "/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + examples: + - '"kdaigle"' + password: + type: string + examples: + - '"password"' + required: + - url + events: + type: array + description: Determines what [events](https://docs.github.com/enterprise-server@3.14/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 + `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/enterprise-server@3.14/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, + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - '"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. + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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" + 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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/enterprise-server@3.14/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. This options is only available for organization + owners. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 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/enterprise-server@3.14/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. + tags: + - orgs + operationId: orgs/remove-member + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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. + tags: + - orgs + operationId: orgs/remove-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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). + + 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/enterprise-server@3.14/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 + type: string + examples: + - repositories + 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. + + Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.14/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." + tags: + - migrations + operationId: migrations/start-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + description: Indicates whether repositories should be locked (to + prevent manipulation) while migrating data. + default: false + examples: + - true + 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 + description: Indicates whether attachments should be excluded from + the migration (to reduce migration archive file size). + default: false + examples: + - true + exclude_releases: + type: boolean + description: Indicates whether releases should be excluded from + the migration (to reduce migration archive file size). + default: false + examples: + - true + exclude_owner_projects: + type: boolean + description: Indicates whether projects owned by the organization + or users should be excluded. from the migration. + default: false + examples: + - true + org_metadata_only: + type: boolean + description: Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore other + flags). + default: false + examples: + - true + 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. + + 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/enterprise-server@3.14/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 + type: string + examples: + - repositories + 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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + "/orgs/{org}/organization-fine-grained-permissions": + get: + summary: List organization fine-grained permissions for an organization + description: |- + Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-repository-fine-grained-permissions-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 permissions of `read_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-organization-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/organization-fine-grained-permission-example" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/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/enterprise-server@3.14/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. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in 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-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + post: + summary: Create a custom organization role + description: |- + Creates a custom organization role that can be assigned to users and teams, granting them specific + permissions over the organization and optionally across all repositories in the organization. For + more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + 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 permissions of `write_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/create-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#create-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-organization-role-create-schema" + examples: + default: + value: + 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 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + 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:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: true + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + 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/enterprise-server@3.14/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 + patch: + summary: Update a custom organization role + description: |- + Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + 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 permissions of `write_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/patch-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#update-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-organization-role-update-schema" + examples: + default: + value: + description: Permissions to manage custom roles within an org. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + 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:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Delete a custom organization role. + description: |- + Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + 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 permissions of `write_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/delete-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/organization-roles#delete-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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" + 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. + + 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/enterprise-server@3.14/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 + - 'null' + description: Reason for approving or denying the requests. Max 1024 + characters. + maxLength: 1024 + 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. + + 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/enterprise-server@3.14/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 + - 'null' + description: Reason for approving or denying the request. Max 1024 + characters. + maxLength: 1024 + 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. + + 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/enterprise-server@3.14/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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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" + 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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-accesses + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-access + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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}/pre-receive-hooks": + get: + summary: List pre-receive hooks for an organization + description: List all pre-receive hooks that are enabled or testing for this + organization as well as any disabled hooks that can be configured at the organization + level. Globally disabled pre-receive hooks that do not allow downstream configuration + are not listed. + operationId: enterprise-admin/list-pre-receive-hooks-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook for an organization + description: '' + operationId: enterprise-admin/get-pre-receive-hook-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + patch: + summary: Update pre-receive hook enforcement for an organization + description: For pre-receive hooks which are allowed to be configured at the + org level, you can set `enforcement` and `allow_downstream_configuration` + operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + enforcement: + description: The state of enforcement for the hook on this repository. + type: string + allow_downstream_configuration: + description: Whether repositories can override enforcement. + type: boolean + examples: + default: + value: + enforcement: enabled + allow_downstream_configuration: false + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + delete: + summary: Remove pre-receive hook enforcement for an organization + description: Removes any overrides for this hook at the org level for this org. + operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + "/orgs/{org}/projects": + get: + summary: List organization projects + description: 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. + tags: + - projects + operationId: projects/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#list-organization-projects + parameters: + - "$ref": "#/components/parameters/org" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + post: + summary: Create an organization project + description: 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. + tags: + - projects + operationId: projects/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#create-an-organization-project + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the project. + body: + type: string + description: The description of the project. + required: + - name + examples: + default: + value: + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-2" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/get-all-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + 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/create-or-update-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/get-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + 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/create-or-update-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + 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/remove-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/list-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 Enterprise Server. The REST API + supports the same qualifiers as the web interface for GitHub Enterprise + Server. To learn more about the format of the query, see [Constructing a + search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-server@3.14/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. + 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/create-or-update-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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.) + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/rest/repos/repos#list-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + - name: type + description: Specifies the types of repositories you want returned. `internal` + is not yet supported when a GitHub App calls this endpoint with an installation + access token. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + - forks + - sources + - member + - internal + - 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. + + 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/enterprise-server@3.14/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. **Note**: For GitHub + Enterprise Server, this endpoint will only list repositories available + to all users on the enterprise. For more information, see \"[Creating + an internal repository](https://docs.github.com/enterprise-server@3.14/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" + in the GitHub Help documentation. \nThe `visibility` parameter + overrides the `private` parameter when you use both parameters + with the `nebula-preview` preview header." + enum: + - public + - private + - internal + 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 + examples: + - 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/enterprise-server@3.14/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 + "/orgs/{org}/repository-fine-grained-permissions": + get: + summary: List repository fine-grained permissions for an organization + description: |- + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/list-repo-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/repository-fine-grained-permission-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/repository-rule" + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + 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" + '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. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + **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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/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* + 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" + '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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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-resolution" + - "$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" + 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}/security-managers": + get: + summary: List security manager teams + description: |- + Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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: + - orgs + operationId: orgs/list-security-manager-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + "/orgs/{org}/security-managers/teams/{team_slug}": + put: + summary: Add a security manager team + description: |- + Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + + The authenticated user must be an administrator 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: + - orgs + operationId: orgs/add-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + delete: + summary: Remove a security manager team + description: |- + 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/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + + 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/remove-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + "/orgs/{org}/settings/billing/advanced-security": + get: + summary: Get GitHub Advanced Security active committers for an organization + description: |- + Gets the GitHub Advanced Security active committers for an organization per repository. + + Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository. + + If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. + + The total number of repositories with committer information is tracked by the `total_count` field. + tags: + - billing + operationId: billing/get-github-advanced-security-billing-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/advanced-security-active-committers" + examples: + default: + "$ref": "#/components/examples/advanced-security-active-committers" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: billing + subcategory: billing + "/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/enterprise-server@3.14/rest/teams/teams#list-teams + 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/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 IDs 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. + 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. LDAP synchronization + must be enabled to map LDAP entries to a team. Use the "[Update + LDAP mapping for a team](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" + endpoint to change the LDAP DN. For more information, see "[Using + LDAP](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." + 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 + "/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 Enterprise Server 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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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 + - 'null' + description: The ID of a team to set as the parent team. + 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. + + 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/enterprise-server@3.14/rest/teams/teams#delete-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/orgs/{org}/teams/{team_slug}/discussions": + get: + summary: List discussions + description: |- + List all discussions on a team's page. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + post: + summary: Create a discussion + description: |- + Creates a new discussion post on a team's page. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + private: + type: boolean + description: Private posts are only visible to team members, organization + owners, and team maintainers. Public posts are visible to all + members of the organization. Set to `true` to create a private + post. + default: false + required: + - title + - body + examples: + default: + value: + title: Our first team post + body: Hi! This is an area for us to collaborate as a team. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": + get: + summary: Get a discussion + description: |- + Get a specific discussion on a team's page. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + patch: + summary: Update a discussion + description: |- + Edits the title and body text of a discussion post. Only the parameters you provide are updated. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + examples: + default: + value: + title: Welcome to our first team post + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + delete: + summary: Delete a discussion + description: |- + Delete a discussion from a team's page. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": + get: + summary: List discussion comments + description: |- + List all comments on a team discussion. + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussion-comments-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$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/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + post: + summary: Create a discussion comment + description: |- + Creates a new comment on a team discussion. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like apples? + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": + get: + summary: Get a discussion comment + description: |- + Get a specific comment on a team discussion. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + patch: + summary: Update a discussion comment + description: |- + Edits the body text of a discussion comment. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like pineapples? + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + delete: + summary: Delete a discussion comment + description: |- + Deletes a comment on a team discussion. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": + get: + summary: List reactions for a team discussion comment + description: |- + List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + post: + summary: Create reaction for a team discussion comment + description: |- + Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). + + 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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) + to add to the team discussion comment. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Response when the reaction type has already been added to this + team discussion comment + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": + delete: + summary: Delete team discussion comment reaction + description: |- + > [!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/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/delete-for-team-discussion-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-team-discussion-comment-reaction + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - "$ref": "#/components/parameters/reaction-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": + get: + summary: List reactions for a team discussion + description: |- + List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + post: + summary: Create reaction for a team discussion + description: |- + Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). + + 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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) + to add to the team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": + delete: + summary: Delete team discussion reaction + description: |- + > [!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/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/delete-for-team-discussion + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#delete-team-discussion-reaction + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/reaction-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/external-groups": + get: + summary: List a connection between an external group and a team + description: |- + Lists a connection between a team and an external group. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/list-linked-external-idp-groups-to-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-groups" + examples: + default: + "$ref": "#/components/examples/external-groups" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + patch: + summary: Update the connection between an external group and a team + description: |- + Creates a connection between a team and an external group. Only one external group can be linked to a team. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/link-external-idp-group-to-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + group_id: + type: integer + description: External Group Id + examples: + - 1 + required: + - group_id + examples: + default: + value: + group_id: 123 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-group" + examples: + default: + "$ref": "#/components/examples/external-group" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: teams + subcategory: external-groups + delete: + summary: Remove the connection between an external group and a team + description: |- + Deletes a connection between a team and an external group. + + You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - teams + operationId: teams/unlink-external-idp-group-from-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: teams + subcategory: external-groups + "/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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}/projects": + get: + summary: List team projects + description: |- + 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`. + tags: + - teams + operationId: teams/list-projects-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects + 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/team-project" + examples: + default: + "$ref": "#/components/examples/team-project-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": + get: + summary: Check team permissions for a project + description: |- + 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}`. + tags: + - teams + operationId: teams/check-permissions-for-project-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-project" + examples: + default: + "$ref": "#/components/examples/team-project" + '404': + description: Not Found if project is not managed by this team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + put: + summary: Add or update team project permissions + description: |- + 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}`. + tags: + - teams + operationId: teams/add-or-update-project-permissions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + permission: + type: string + description: 'The permission to grant to the team for this project. + Default: the team''s `permission` attribute will be used to determine + what permission to grant the team on this project. Note that, + if you choose not to pass any parameters, you''ll need to set + `Content-Length` to zero when calling this endpoint. For more + information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)."' + enum: + - read + - write + - admin + examples: + default: + summary: Updates the permissions for the team to write for the project + value: + permission: write + responses: + '204': + description: Response + '403': + description: Forbidden if the project is not owned by the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-the-project-is-not-owned-by-the-organization: + value: + message: Must have admin rights to Repository. + documentation_url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + delete: + summary: Remove a project from a team + description: |- + 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}`. + tags: + - teams + operationId: teams/remove-project-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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}`. + + > [!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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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 + "/projects/columns/cards/{card_id}": + get: + summary: Get a project card + description: Gets information about a project card. + tags: + - projects + operationId: projects/get-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/cards#get-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '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: cards + patch: + summary: Update an existing project card + description: '' + tags: + - projects + operationId: projects/update-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/cards#update-an-existing-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + note: + description: The project card's note + type: + - string + - 'null' + examples: + - Update all gems + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + examples: + default: + summary: Change the note on the card + value: + note: Add payload for delete Project column + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + delete: + summary: Delete a project card + description: Deletes a project card + tags: + - projects + operationId: projects/delete-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/cards#delete-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + responses: + '204': + description: Response + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/cards/{card_id}/moves": + post: + summary: Move a project card + description: '' + tags: + - projects + operationId: projects/move-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/cards#move-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + position: + description: 'The position of the card in a column. Can be one of: + `top`, `bottom`, or `after:` to place after the specified + card.' + type: string + pattern: "^(?:top|bottom|after:\\d+)$" + examples: + - bottom + column_id: + description: The unique identifier of the column the card should + be moved to + type: integer + examples: + - 42 + required: + - position + type: object + examples: + default: + summary: Move the card to the bottom of the column + value: + column_id: 42 + position: bottom + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + default: + value: + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + resource: + type: string + field: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '503': + description: Response + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/{column_id}": + get: + summary: Get a project column + description: Gets information about a project column. + tags: + - projects + operationId: projects/get-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/columns#get-a-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + patch: + summary: Update an existing project column + description: '' + tags: + - projects + operationId: projects/update-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/columns#update-an-existing-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + required: + - name + type: object + examples: + default: + summary: Rename the project column + value: + name: To Do + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column" + '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: columns + delete: + summary: Delete a project column + description: Deletes a project column. + tags: + - projects + operationId: projects/delete-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/columns#delete-a-project-column + parameters: + - "$ref": "#/components/parameters/column-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: true + category: projects + subcategory: columns + "/projects/columns/{column_id}/cards": + get: + summary: List project cards + description: Lists the project cards in a project. + tags: + - projects + operationId: projects/list-cards + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/cards#list-project-cards + parameters: + - "$ref": "#/components/parameters/column-id" + - name: archived_state + description: Filters the project cards that are returned by the card's state. + in: query + required: false + schema: + type: string + enum: + - all + - archived + - not_archived + default: not_archived + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card-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: cards + post: + summary: Create a project card + description: '' + tags: + - projects + operationId: projects/create-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/cards#create-a-project-card + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + note: + description: The project card's note + type: + - string + - 'null' + examples: + - Update all gems + required: + - note + - type: object + properties: + content_id: + description: The unique identifier of the content associated with + the card + type: integer + examples: + - 42 + content_type: + description: The piece of content associated with the card + type: string + examples: + - PullRequest + required: + - content_id + - content_type + examples: + default: + summary: Create a new card + value: + note: Add payload for delete Project column + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + description: Validation failed + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/validation-error" + - "$ref": "#/components/schemas/validation-error-simple" + '503': + description: Response + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/{column_id}/moves": + post: + summary: Move a project column + description: '' + tags: + - projects + operationId: projects/move-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/columns#move-a-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + position: + description: 'The position of the column in a project. Can be one + of: `first`, `last`, or `after:` to place after the + specified column.' + type: string + pattern: "^(?:first|last|after:\\d+)$" + examples: + - last + required: + - position + type: object + examples: + default: + summary: Move the column to the end of the board + value: + position: last + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + default: + value: + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + "/projects/{project_id}": + get: + summary: Get a project + description: 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. + tags: + - projects + operationId: projects/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#get-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '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 + patch: + summary: Update a project + description: 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. + operationId: projects/update + tags: + - projects + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#update-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + properties: + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + state: + description: State of the project; either 'open' or 'closed' + type: string + examples: + - open + organization_permission: + description: The baseline permission that all organization members + have on this project + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. + type: boolean + type: object + examples: + default: + summary: Change the name, state, and permissions for a project + value: + name: Week One Sprint + state: open + organization_permission: write + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '404': + description: Not Found if the authenticated user does not have access to + the project + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + delete: + summary: Delete a project + description: Deletes a project board. Returns a `404 Not Found` status if projects + are disabled. + operationId: projects/delete + tags: + - projects + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#delete-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Delete Success + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/projects/{project_id}/collaborators": + get: + summary: List project collaborators + description: 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. + tags: + - projects + operationId: projects/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#list-project-collaborators + parameters: + - "$ref": "#/components/parameters/project-id" + - name: affiliation + description: Filters the collaborators by their affiliation. `outside` means + outside collaborators of a project that are not a member of the project's + organization. `direct` means collaborators with permissions to a project, + 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 + - "$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" + '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: projects + subcategory: collaborators + "/projects/{project_id}/collaborators/{username}": + put: + summary: Add project collaborator + description: 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. + tags: + - projects + operationId: projects/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#add-project-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + permission: + description: The permission to grant the collaborator. + enum: + - read + - write + - admin + default: write + type: string + examples: + - write + examples: + default: + summary: Applying write permissions for the new collaborator + value: + permission: write + 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: true + category: projects + subcategory: collaborators + delete: + summary: Remove user as a collaborator + description: Removes a collaborator from an organization project. You must be + an organization owner or a project `admin` to remove a collaborator. + tags: + - projects + operationId: projects/remove-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#remove-user-as-a-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$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" + '422': + "$ref": "#/components/responses/validation_failed" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: collaborators + "/projects/{project_id}/collaborators/{username}/permission": + get: + summary: Get project permission for a user + description: '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.' + tags: + - projects + operationId: projects/get-permission-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/collaborators#get-project-permission-for-a-user + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-collaborator-permission" + examples: + default: + "$ref": "#/components/examples/project-collaborator-permission" + '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: true + category: projects + subcategory: collaborators + "/projects/{project_id}/columns": + get: + summary: List project columns + description: Lists the project columns in a project. + tags: + - projects + operationId: projects/list-columns + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/columns#list-project-columns + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column-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: columns + post: + summary: Create a project column + description: Creates a new project column. + tags: + - projects + operationId: projects/create-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/columns#create-a-project-column + parameters: + - "$ref": "#/components/parameters/project-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + required: + - name + type: object + examples: + default: + value: + name: Remaining tasks + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + tags: + - repos + operationId: repos/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/rest/repos/repos#replace-all-repository-topics) + endpoint." + tags: + - repos + operationId: repos/update + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - internal + security_and_analysis: + type: + - object + - 'null' + 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/enterprise-server@3.14/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. + 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)." + 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`. + 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 + 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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + previews: + - required: false + name: nebula + note: |- + You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.14/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - required: false + name: baptiste + note: |- + The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.14/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + + ```shell + application/vnd.github.baptiste-preview+json + ``` + 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/repos/repos#delete-a-repository + '307': + "$ref": "#/components/responses/temporary_redirect" + '404': + "$ref": "#/components/responses/not_found" + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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/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/enterprise-server@3.14/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/cache/usage-policy": + get: + summary: Get GitHub Actions cache usage policy for a repository + description: |- + Gets GitHub Actions cache usage policy 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-usage-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#get-github-actions-cache-usage-policy-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-policy-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-usage-policy" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + patch: + summary: Set GitHub Actions cache usage policy for a repository + description: |- + Sets GitHub Actions cache usage policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-usage-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-usage-policy" + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + '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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 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. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 in the repository. + + If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for 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/enterprise-server@3.14/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" + required: + - enabled + examples: + default: + value: + enabled: true + allowed_actions: selected + 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 internal and private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/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)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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/enterprise-server@3.14/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. + This endpoint only applies to internal and private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.14/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)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.14/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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/enterprise-server@3.14/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/selected-actions": + get: + summary: Get allowed actions for a repository + description: |- + Gets the settings for selected actions 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. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 for a repository + description: |- + Sets the actions 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)." + + If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + + 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/enterprise-server@3.14/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, + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 + can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 or enterprise + 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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-airgap" + 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/enterprise-server@3.14/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" + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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" + 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. + + 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/enterprise-server@3.14/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 + about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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`. + + 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/enterprise-server@3.14/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: + '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/enterprise-server@3.14/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/enterprise-server@3.14/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. + 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/enterprise-server@3.14/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: + '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 + about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + `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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + items: + type: integer + examples: + - 161171787 + examples: + - 161171787 + - 161171795 + state: + type: string + description: Whether to approve or reject deployment to the specified + environments. + enum: + - approved + - rejected + examples: + - approved + comment: + type: string + description: A comment to accompany the deployment review + examples: + - 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`. + + 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/enterprise-server@3.14/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + 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/enterprise-server@3.14/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + 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: + '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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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`. + + 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/enterprise-server@3.14/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`. + + 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/enterprise-server@3.14/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: 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 10. Any default properties + configured in the workflow file will be used when `inputs` are + omitted. + additionalProperties: true + maxProperties: 10 + 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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/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/enterprise-server@3.14/repositories/viewing-activity-and-data-for-your-repository)." + tags: + - repos + operationId: repos/list-activities + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + "/repos/{owner}/{repo}/assignees": + get: + summary: List assignees + description: Lists the [available assignees](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 automated security fixes are enabled for a repository + description: 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/enterprise-server@3.14/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/check-automated-security-fixes + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#check-if-automated-security-fixes-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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + description: Require status checks to pass before merging. Set to + `null` to disable. + 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 + - 'null' + description: Enforce all configured restrictions for administrators. + Set to `true` to enforce required status checks for repository + administrators. Set to `null` to disable. + required_pull_request_reviews: + type: + - object + - 'null' + description: Require at least one approving review on a pull request, + before merging. Set to `null` to disable. + 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/enterprise-server@3.14/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 + - 'null' + 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. + 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/enterprise-server@3.14/github/administering-a-repository/requiring-a-linear-commit-history)" + in the GitHub Help documentation.' + allow_force_pushes: + type: + - boolean + - 'null' + 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/enterprise-server@3.14/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + in the GitHub Help documentation."' + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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`. + + > [!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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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`. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.14/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/rerequest-run + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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: + '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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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`. + + > [!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/enterprise-server@3.14/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`. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/rerequest-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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: + 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/enterprise-server@3.14/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/direction" + - 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" + 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. + + 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/enterprise-server@3.14/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. + 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/enterprise-server@3.14/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" + required: + - state + 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. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-alert" + examples: + default: + "$ref": "#/components/examples/code-scanning-alert-dismissed" + '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}/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/enterprise-server@3.14/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" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-scanning-alert-instance" + 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, + 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/enterprise-server@3.14/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" + - 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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/json+sarif: + 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" + '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. + + 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/enterprise-server@3.14/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 + - 'null' + 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/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + '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" + '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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + type: string + format: uri + examples: + - file:///github/workspace/ + 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 + 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)." + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/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. + 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. + + 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/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: |- + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." + + **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. + tags: + - repos + operationId: repos/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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.** + default: push + examples: + new-invitation-is-created: + summary: Add a collaborator with triage permissions + value: + permission: triage + responses: + '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': + "$ref": "#/components/responses/validation_failed" + '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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 of a collaborator. The possible repository + permissions are `admin`, `write`, `read`, and `none`. + + *Note*: 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`. To determine the role assigned to the + collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + tags: + - repos + operationId: repos/get-collaborator-permission-level + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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** + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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`. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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, will only return 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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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" + '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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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. + + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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" + '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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + responses: + '200': + description: Response + content: + application/vnd.github.object: + schema: + "$ref": "#/components/schemas/content-tree" + 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-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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - '"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 + examples: + - '"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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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-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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - name: page + description: "**Closing down notice**. Page number of the results to fetch. + Use cursor-based pagination with `before` or `after` instead." + deprecated: true + 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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + deprecated: true + in: query + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + required: + - state + 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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: + '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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + default: none + - "$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. + + The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + description: Short description of the deployment. + default: '' + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + "/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/enterprise-server@3.14/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 Enterprise Server 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + type: integer + examples: + - 5 + 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] + > 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/enterprise-server@3.14/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)." + + > [!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/enterprise-server@3.14/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 + - 'null' + properties: + wait_timer: + "$ref": "#/components/schemas/wait-timer" + prevent_self_review: + "$ref": "#/components/schemas/prevent-self-review" + reviewers: + type: + - array + - 'null' + 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 + examples: + - 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + examples: + - 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - 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. + + 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/enterprise-server@3.14/rest/apps/apps#get-an-app). + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: + '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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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 Enterprise Server 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/enterprise-server@3.14/rest/repos/forks#create-a-fork + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + 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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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). + + **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/enterprise-server@3.14/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 + '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). + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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': + "$ref": "#/components/responses/validation_failed" + '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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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** + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + 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." + 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: + "$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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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 + - 'null' + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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)." + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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" + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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/enterprise-server@3.14/articles/disabling-issues/), the API returns a `410 Gone` status. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + 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.**_' + 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._' + type: + - 'null' + - string + - integer + 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 + - 'null' + color: + type: + - string + - 'null' + 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 + 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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/reactions": + get: + summary: List reactions for an issue comment + description: List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + [transferred](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: + "$ref": "#/components/examples/issue" + '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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + type: + - 'null' + - string + - integer + body: + type: + - string + - 'null' + description: The contents of the issue. + assignee: + type: + - string + - 'null' + 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 + - 'null' + enum: + - completed + - not_planned + - reopened + - + description: The reason for the state change. Ignored unless `state` + is changed. + examples: + - 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. + type: + - 'null' + - string + - integer + 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 + - 'null' + color: + type: + - string + - 'null' + 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 + 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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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. If you provide an empty array of labels, + all labels are removed from the issue. ' + tags: + - issues + operationId: issues/add-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 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 replace all of the labels for an issue. For + more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.14/rest/issues/labels#set-labels-for-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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + 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/enterprise-server@3.14/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}/reactions": + get: + summary: List reactions for an issue + description: List the reactions to an [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/list-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: false + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/delete-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/articles/repository-permission-levels-for-an-organization/)\" + and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/lfs": + put: + summary: Enable Git LFS for a repository + description: |- + Enables Git LFS for a repository. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: repos/enable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#enable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '202': + "$ref": "#/components/responses/accepted" + '403': + description: |- + We will return a 403 with one of the following messages: + + - Git LFS support not enabled because Git LFS is globally disabled. + - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + - Git LFS support not enabled because Git LFS is disabled for . + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: repos + subcategory: lfs + delete: + summary: Disable Git LFS for a repository + description: |- + Disables Git LFS for a repository. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: repos/disable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/lfs#disable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: repos + subcategory: lfs + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server Pages site + description: |- + Gets information about a GitHub Enterprise Server 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/enterprise-server@3.14/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 Enterprise Server Pages site + description: |- + Configures a GitHub Enterprise Server 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/enterprise-server@3.14/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 + - 'null' + description: The source branch and directory used to publish your Pages + site. + 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 Enterprise Server Pages site + description: |- + Updates information for a GitHub Enterprise Server 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/enterprise-server@3.14/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 + - 'null' + 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/enterprise-server@3.14/pages/configuring-a-custom-domain-for-your-github-pages-site)." + 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 Enterprise Server Pages site + description: |- + Deletes a GitHub Enterprise Server 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/enterprise-server@3.14/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 Enterprise Server Pages builds + description: |- + Lists builts of a GitHub Enterprise Server 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/enterprise-server@3.14/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 Enterprise Server 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/enterprise-server@3.14/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 Enterprise Server 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/enterprise-server@3.14/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 Enterprise Server Pages build + description: |- + Gets information about a GitHub Enterprise Server 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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_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. + 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: + - artifact_url + - 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 + preview: false + 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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}/pre-receive-hooks": + get: + summary: List pre-receive hooks for a repository + description: List all pre-receive hooks that are enabled or testing for this + repository as well as any disabled hooks that are allowed to be enabled at + the repository level. Pre-receive hooks that are disabled at a higher level + and are not configurable will not be listed. + operationId: enterprise-admin/list-pre-receive-hooks-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook for a repository + description: '' + operationId: enterprise-admin/get-pre-receive-hook-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + patch: + summary: Update pre-receive hook enforcement for a repository + description: For pre-receive hooks which are allowed to be configured at the + repo level, you can set `enforcement` + operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + enforcement: + description: The state of enforcement for the hook on this repository. + type: string + enum: + - enabled + - disabled + - testing + examples: + default: + value: + enforcement: enabled + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + delete: + summary: Remove pre-receive hook enforcement for a repository + description: |- + Deletes any overridden enforcement on this repository for the specified hook. + + Responds with effective values inherited from owner and/or global level. + operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Responds with effective values inherited from owner and/or + global level. + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + "/repos/{owner}/{repo}/projects": + get: + summary: List repository projects + description: 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. + tags: + - projects + operationId: projects/list-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#list-repository-projects + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items-2" + headers: + Link: + "$ref": "#/components/headers/link" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + post: + summary: Create a repository project + description: 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. + tags: + - projects + operationId: projects/create-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#create-a-repository-project + 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 project. + body: + type: string + description: The description of the project. + required: + - name + examples: + default: + value: + name: Projects Documentation + body: Developer documentation project for the developer site. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/get-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + 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/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - 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/enterprise-server@3.14/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/enterprise-server@3.14/articles/about-pull-requests#draft-pull-requests)" + in the GitHub Help documentation to learn more. + issue: + type: integer + format: int64 + 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. + examples: + - 1 + 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, + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.14/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.14/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 Enterprise Server 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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. + examples: + - 2 + 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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.14/rest/commits/commits#list-commits) + endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + - 'null' + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - 28 + side: + type: string + examples: + - RIGHT + start_line: + type: integer + examples: + - 26 + start_side: + type: string + examples: + - 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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + > [!NOTE] + > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + enum: + - DISMISS + examples: + - '"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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + 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/enterprise-server@3.14/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 + - 'null' + 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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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 + '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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - '"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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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" + 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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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" + 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/enterprise-server@3.14/rest/releases/releases#delete-a-release + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/release-id" + responses: + '204': + description: Response + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, + non-alphanumeric characters, and leading or trailing periods. The \"[List + release assets](https://docs.github.com/enterprise-server@3.14/rest/releases/assets#list-release-assets)\"\nendpoint + lists the renamed filenames. For more information and help, contact [GitHub + Enterprise Server 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/releases/assets#upload-a-release-asset + servers: + - url: https://HOSTNAME/api/uploads + 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/enterprise-server@3.14/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/list-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/delete-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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}/replicas/caches": + get: + summary: List repository cache replication status + description: Lists the status of each repository cache replica. + tags: + - repos + operationId: repos/list-cache-info + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/repos#list-repository-cache-replication-status + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Status information for cache replicas + content: + application/json: + schema: + type: array + items: + description: Status for a cache replica + type: object + properties: + host: + type: string + location: + type: string + git: + type: object + properties: + sync_status: + type: string + enum: + - offline + - inactive + - in_sync + - not_in_sync + last_sync: + type: string + format: date-time + required: + - sync_status + - last_sync + required: + - host + - location + - git + examples: + default: + value: + - host: host-1 + location: berlin + git: + - sync_status: in_sync + - last_sync: '2022-01-10T19:33:52Z' + - host: host-2 + location: chicago + git: + - sync_status: offline + - last_sync: '2022-01-10T19:34:12Z' + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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" + '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. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + **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/enterprise-server@3.14/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/enterprise-server@3.14/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" + '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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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-resolution" + - "$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" + 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. + + 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/enterprise-server@3.14/rest/secret-scanning/secret-scanning#get-a-secret-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/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. + + 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/enterprise-server@3.14/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" + required: + - state + examples: + default: + value: + state: resolved + resolution: false_positive + 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 + '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. + + 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/enterprise-server@3.14/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}/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + tags: + - repos + operationId: repos/get-code-frequency-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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" + 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/enterprise-server@3.14/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: |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 + tags: + - repos + operationId: repos/get-contributors-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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`. + + 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/enterprise-server@3.14/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: + + * `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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/activity/watching#set-a-repository-subscription). + tags: + - activity + operationId: activity/delete-repo-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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}/tags/protection": + get: + summary: Closing down - List tag protection states for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + + This returns the tag protection states of a repository. + + This information is only available to repository administrators. + tags: + - repos + operationId: repos/list-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---list-tag-protection-states-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/tag-protection" + examples: + default: + "$ref": "#/components/examples/tag-protection-items" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + post: + summary: Closing down - Create a tag protection state for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + + This creates a tag protection state for a repository. + This endpoint is only available to repository administrators. + tags: + - repos + operationId: repos/create-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern: + type: string + description: An optional glob pattern to match against when enforcing + tag protection. + required: + - pattern + examples: + default: + value: + pattern: v1.* + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/tag-protection" + examples: + default: + "$ref": "#/components/examples/tag-protection" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": + delete: + summary: Closing down - Delete a tag protection state for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.14/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + + This deletes a tag protection state for a repository. + This endpoint is only available to repository administrators. + tags: + - repos + operationId: repos/delete-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/tag-protection-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + "/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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` cannot contain uppercase letters. + 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}/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/enterprise-server@3.14/articles/about-repository-transfers/). + tags: + - repos + operationId: repos/transfer + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/check-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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: false + 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/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/enable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 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/enterprise-server@3.14/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/disable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + `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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + previews: + - required: true + name: baptiste + note: |- + Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + + ```shell + application/vnd.github.baptiste-preview+json + ``` + "/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/repos/repos#list-public-repositories + parameters: + - "$ref": "#/components/parameters/since-repo" + - name: visibility + description: Specifies the types of repositories to return. This endpoint + will only list repositories available to all users on the enterprise. + in: query + required: false + schema: + type: string + default: public + enum: + - all + - public + examples: + - all + 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 + "/scim/v2/enterprises/{enterprise}/Groups": + get: + summary: List provisioned SCIM groups for an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Lists provisioned SCIM groups in an enterprise. + + You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + operationId: enterprise-admin/list-provisioned-groups-enterprise + tags: + - enterprise-admin + - scim + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise + parameters: + - name: filter + description: If specified, only results that match the specified filter will + be returned. Multiple filters are not supported. Possible filters are `externalId`, + `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. + in: query + required: false + schema: + type: string + examples: + displayName: + value: Engineering + externalId: + value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + - "$ref": "#/components/parameters/excluded-attributes" + - "$ref": "#/components/parameters/start-index" + - "$ref": "#/components/parameters/count" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, either groups were found or not found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-list" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group-list" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Creates a SCIM group for an enterprise. + + If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. + operationId: enterprise-admin/provision-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#provision-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/group" + examples: + group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + responses: + '201': + description: Group has been created + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + group: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": + get: + summary: Get SCIM provisioning information for an enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Gets information about a SCIM group. + operationId: enterprise-admin/get-provisioning-information-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/excluded-attributes" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, a group was found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Replaces an existing provisioned group’s information. + + You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/group" + examples: + group: + summary: Group + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + groupWithMembers: + summary: Group with member + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + responses: + '200': + description: Group was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + group: + "$ref": "#/components/examples/scim-enterprise-group" + groupWithMembers: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Update a provisioned group’s individual attributes. + + To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. + + Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/patch-schema" + examples: + updateGroup: + summary: Update Group + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: displayName + value: Employees + addMembers: + summary: Add Members + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: members + value: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + responses: + '204': + description: Response + '200': + description: Success, group was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + updateGroup: + "$ref": "#/components/examples/scim-enterprise-group" + addMembers: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM group from an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Deletes a SCIM group from an enterprise. + operationId: enterprise-admin/delete-scim-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Group was deleted, no content + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users": + get: + summary: List SCIM provisioned identities for an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Lists provisioned SCIM enterprise members. + + When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. + operationId: enterprise-admin/list-provisioned-identities-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise + parameters: + - name: filter + description: If specified, only results that match the specified filter will + be returned. Multiple filters are not supported. Possible filters are `userName`, + `externalId`, `id`, and `displayName`. For example, `?filter="externalId + eq '9138790-10932-109120392-12321'"`. + in: query + required: false + schema: + type: string + examples: + userName: + value: userName eq 'E012345' + externalId: + value: externalId eq 'E012345' + - "$ref": "#/components/parameters/start-index" + - "$ref": "#/components/parameters/count" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, either users were found or not found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-list" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-user-list" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Creates an external identity for a new SCIM enterprise user. + + SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. + + When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. + operationId: enterprise-admin/provision-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#provision-a-scim-enterprise-user + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/user" + examples: + user: + "$ref": "#/components/examples/in-user" + enterpriseOwner: + "$ref": "#/components/examples/in-user-owner" + responses: + '201': + description: User has been created + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + user: + "$ref": "#/components/examples/scim-enterprise-user" + enterpriseOwner: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": + get: + summary: Get SCIM provisioning information for an enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Gets information about a SCIM user. + operationId: enterprise-admin/get-provisioning-information-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, a user was found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Replaces an existing provisioned user's information. + + You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. + + > [!WARNING] + > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/user" + examples: + user: + "$ref": "#/components/examples/in-user" + responses: + '200': + description: User was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + user: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Update a provisioned user's individual attributes. + + To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + + > [!NOTE] + > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + + > [!WARNING] + > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + > ``` + > { + > "Operations":[{ + > "op":"replace", + > "value":{ + > "active":false + > } + > }] + > } + > ``` + operationId: enterprise-admin/update-attribute-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/patch-schema" + examples: + userMultiValuedProperties: + summary: Multi Valued Property + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: emails[type eq 'work'].value + value: updatedEmail@microsoft.com + - op: replace + path: name.familyName + value: updatedFamilyName + userSingleValuedProperties: + summary: Single Valued Property + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: userName + value: 5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com + - op: replace + path: displayName + value: Monalisa Octocat + disableUser: + summary: Disable User + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: active + value: false + responses: + '200': + description: Success, user was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + userMultiValuedProperties: + "$ref": "#/components/examples/scim-enterprise-user" + userSingleValuedProperties: + "$ref": "#/components/examples/scim-enterprise-user" + disableUser: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM user from an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. + operationId: enterprise-admin/delete-user-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: User was deleted, no content + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + tags: + - search + operationId: search/code + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). + See "[Searching code](https://docs.github.com/enterprise-server@3.14/search-github/searching-on-github/searching-code)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query. Can only be `indexed`, which + indicates how recently a file has been indexed by the GitHub Enterprise + Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.14/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - indexed + - 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 + - "$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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). + See "[Searching commits](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). + See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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" + 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/issue-search-result-item" + examples: + default: + "$ref": "#/components/examples/issue-search-result-item-paginated" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/queries#search)." + tags: + - search + operationId: search/users + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.14/rest/search/search#constructing-a-search-query). + See "[Searching users](https://docs.github.com/enterprise-server@3.14/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 Enterprise Server. Default: + [best match](https://docs.github.com/enterprise-server@3.14/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 + "/setup/api/configcheck": + get: + summary: Get the configuration status + description: |- + This endpoint allows you to check the status of the most recent configuration process: + + Note that you may need to wait several seconds after you start a process before you can check its status. + + The different statuses are: + + | Status | Description | + | ------------- | --------------------------------- | + | `PENDING` | The job has not started yet | + | `CONFIGURING` | The job is running | + | `DONE` | The job has finished correctly | + | `FAILED` | The job has finished unexpectedly | + operationId: enterprise-admin/get-configuration-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-the-configuration-status + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/configuration-status" + examples: + default: + "$ref": "#/components/examples/configuration-status" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/configure": + post: + summary: Start a configuration process + description: 'This endpoint allows you to start a configuration process at any + time for your updated settings to take effect:' + operationId: enterprise-admin/start-configuration-process + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '202': + description: Response + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/maintenance": + get: + summary: Get the maintenance status + description: 'Check your installation''s maintenance status:' + operationId: enterprise-admin/get-maintenance-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-the-maintenance-status + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/maintenance-status" + examples: + default: + "$ref": "#/components/examples/maintenance-status" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + post: + summary: Enable or disable maintenance mode + description: |- + > [!NOTE] + > The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + operationId: enterprise-admin/enable-or-disable-maintenance-mode + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#enable-or-disable-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/maintenance-status" + examples: + default: + "$ref": "#/components/examples/maintenance-status" + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + maintenance: + type: string + description: |- + A JSON string with the attributes `enabled` and `when`. + + The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled. + + The possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic). + required: + - maintenance + examples: + default: + value: + maintenance: '{"enabled":true, "when":"now"}' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/settings": + get: + summary: Get settings + description: |- + Gets the settings for your instance. To change settings, see the [Set settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings). + + > [!NOTE] + > You cannot retrieve the management console password with the Enterprise administration API. + operationId: enterprise-admin/get-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-settings" + examples: + default: + "$ref": "#/components/examples/enterprise-settings" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + put: + summary: Set settings + description: |- + Applies settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). + + **Notes:** + + - The request body for this operation must be submitted as `application/x-www-form-urlencoded` data. You can submit a parameter value as a string, or you can use a tool such as `curl` to submit a parameter value as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode). + - You cannot set the management console password with the Enterprise administration API. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.14/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + operationId: enterprise-admin/set-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#set-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '204': + description: Response + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + settings: + type: string + description: A JSON string with the new settings. Note that you + only need to pass the specific settings you want to modify. For + a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). + required: + - settings + examples: + '204': + value: + settings: '{ "enterprise": { "public_pages": true }}' + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/settings/authorized-keys": + get: + summary: Get all authorized SSH keys + description: '' + operationId: enterprise-admin/get-all-authorized-ssh-keys + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-all-authorized-ssh-keys + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-key" + examples: + default: + "$ref": "#/components/examples/ssh-key-items" + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + post: + summary: Add an authorized SSH key + description: "**Note:** The request body for this operation must be submitted + as `application/x-www-form-urlencoded` data. You can submit a parameter value + as a string, or you can use a tool such as `curl` to submit a parameter value + as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." + operationId: enterprise-admin/add-authorized-ssh-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#add-an-authorized-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '201': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-key" + examples: + default: + "$ref": "#/components/examples/ssh-key-items" + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + authorized_key: + type: string + description: The public SSH key. + required: + - authorized_key + examples: + default: + value: + authorized_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw== + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + delete: + summary: Remove an authorized SSH key + description: "**Note:** The request body for this operation must be submitted + as `application/x-www-form-urlencoded` data. You can submit a parameter value + as a string, or you can use a tool such as `curl` to submit a parameter value + as the contents of a text file. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#--data-urlencode)." + operationId: enterprise-admin/remove-authorized-ssh-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#remove-an-authorized-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-key" + examples: + default: + "$ref": "#/components/examples/ssh-key-items" + '401': + description: Unauthorized + requestBody: + required: true + content: + application/x-www-form-urlencoded: + schema: + type: object + properties: + authorized_key: + type: string + description: The public SSH key. + required: + - authorized_key + examples: + default: + value: + authorized_key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCssTL/Vtu/ODLTj0VtZoRAbvf7uiv5997GyDq0MoAZUjb5jmA5wYe2/wF6sFuhiZTnZoF1ZtCHunPp0hM/GHrn6VySBhNncx14YO8FPt1CIhEeRMSEjUK9cY3xAbS365oXY8vnUHJsS9+1tr/2bx/+4NJfcUt/Ezf1OR/0LStQXw== + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/start": + post: + summary: Create a GitHub license + description: |- + When you boot a GitHub instance for the first time, you can use the following endpoint to upload a license. + + Note that you need to `POST` to [`/setup/api/configure`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#start-a-configuration-process) to start the actual configuration process. + + When using this endpoint, your GitHub instance must have a password set. This can be accomplished two ways: + + 1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password. + 2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/create-enterprise-server-license + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#create-a-github-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '202': + description: Response + '401': + description: Unauthorized + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + password: + type: string + description: You **must** provide a password _only if_ you are uploading + your license for the first time. If you previously set a password + through the web interface, you don't need this parameter. + settings: + type: string + description: An optional JSON string containing the installation + settings. For a list of the available settings, see the [Get settings + endpoint](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#get-settings). + required: + - license + examples: + default: + value: + license: "@enterprise.ghl" + password: secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/setup/api/upgrade": + post: + summary: Upgrade a license + description: |- + This API upgrades your license and also triggers the configuration process. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/upgrade-license + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/management-console#upgrade-a-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '202': + description: Response + '401': + description: Unauthorized + requestBody: + required: false + content: + multipart/form-data: + schema: + type: object + properties: + license: + type: string + description: The content of your new _.ghl_ license file. + examples: + default: + value: + license: "@enterprise.ghl" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: management-console + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - 'null' + description: The ID of a team to set as the parent team. + 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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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}/discussions": + get: + summary: List discussions (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 discussions`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions) endpoint. + + List all discussions on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#list-discussions-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$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/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + post: + summary: Create a discussion (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 [`Create a discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion) endpoint. + + Creates a new discussion post on a team's page. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#create-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + private: + type: boolean + description: Private posts are only visible to team members, organization + owners, and team maintainers. Public posts are visible to all + members of the organization. Set to `true` to create a private + post. + default: false + required: + - title + - body + examples: + default: + value: + title: Our first team post + body: Hi! This is an area for us to collaborate as a team. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}": + get: + summary: Get a discussion (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 a discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion) endpoint. + + Get a specific discussion on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + patch: + summary: Update a discussion (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 discussion](https://docs.github.com/enterprise-server@3.14/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 app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#update-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + examples: + default: + value: + title: Welcome to our first team post + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + delete: + summary: Delete a discussion (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 discussion`](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion) endpoint. + + Delete a discussion from a team's page. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#delete-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments": + get: + summary: List discussion comments (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 discussion comments](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments) endpoint. + + List all comments on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussion-comments-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#list-discussion-comments-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$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/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + post: + summary: Create a discussion comment (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 [Create a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + + Creates a new comment on a team discussion. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/guides/best-practices-for-using-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#create-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like apples? + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": + get: + summary: Get a discussion comment (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 a discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + + Get a specific comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + patch: + summary: Update a discussion comment (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 discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + + Edits the body text of a discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#update-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like pineapples? + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + delete: + summary: Delete a discussion comment (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 discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + + Deletes a comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#delete-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": + get: + summary: List reactions for a team discussion comment (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 reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + + List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + post: + summary: Create reaction for a team discussion comment (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 "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + + Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.14/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) + to add to the team discussion comment. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/reaction" + examples: + default: + "$ref": "#/components/examples/reaction" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/reactions": + get: + summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + + List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + post: + summary: Create reaction for a team discussion (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 [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + + Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.14/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.14/rest/reactions/reactions#about-reactions) + to add to the team discussion. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/reaction" + examples: + default: + "$ref": "#/components/examples/reaction" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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. + + We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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}/projects": + get: + summary: List team projects (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 projects`](https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects) endpoint. + + Lists the organization projects for a team. + tags: + - teams + operationId: teams/list-projects-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#list-team-projects-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/team-project" + examples: + default: + "$ref": "#/components/examples/team-project-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}/projects/{project_id}": + get: + summary: Check team permissions for a project (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 project](https://docs.github.com/enterprise-server@3.14/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. + tags: + - teams + operationId: teams/check-permissions-for-project-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#check-team-permissions-for-a-project-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-project" + examples: + default: + "$ref": "#/components/examples/team-project" + '404': + description: Not Found if project 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 project 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 project permissions](https://docs.github.com/enterprise-server@3.14/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. + tags: + - teams + operationId: teams/add-or-update-project-permissions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: 'The permission to grant to the team for this project. + Default: the team''s `permission` attribute will be used to determine + what permission to grant the team on this project. Note that, + if you choose not to pass any parameters, you''ll need to set + `Content-Length` to zero when calling this endpoint. For more + information, see "[HTTP method](https://docs.github.com/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)."' + enum: + - read + - write + - admin + examples: + default: + summary: Example of setting permission to read + value: + permission: read + responses: + '204': + description: Response + '403': + description: Forbidden if the project is not owned by the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-the-project-is-not-owned-by-the-organization: + value: + message: Must have admin rights to Repository. + documentation_url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#add-or-update-team-project-permissions + '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 + delete: + summary: Remove a project 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 project from a team](https://docs.github.com/enterprise-server@3.14/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. + tags: + - teams + operationId: teams/remove-project-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/teams/teams#remove-a-project-from-a-team-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-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}/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/enterprise-server@3.14/rest/teams/teams#list-team-repositories) endpoint. + tags: + - teams + operationId: teams/list-repos-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/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/enterprise-server@3.14/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] + > **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/enterprise-server@3.14/rest/teams/teams#list-child-teams) endpoint. + tags: + - teams + operationId: teams/list-child-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - Omar Jahandar + email: + description: The publicly visible email address of the user. + type: string + examples: + - omar@example.com + blog: + description: The new blog URL of the user. + type: string + examples: + - blog.example.com + twitter_username: + description: The new Twitter username of the user. + type: + - string + - 'null' + examples: + - therealomarj + company: + description: The new company of the user. + type: string + examples: + - Acme corporation + location: + description: The new location of the user. + type: string + examples: + - 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/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/enterprise-server@3.14/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/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + examples: + - username@example.com + minItems: 1 + examples: [] + required: + - emails + example: + emails: + - octocat@github.com + - mona@github.com + - type: array + items: + type: string + examples: + - 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/enterprise-server@3.14/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 + examples: + - username@example.com + minItems: 1 + example: + emails: + - octocat@github.com + - mona@github.com + required: + - emails + - type: array + items: + type: string + examples: + - 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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" + '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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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: + "$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/enterprise-server@3.14/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/enterprise-server@3.14/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/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_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/enterprise-server@3.14/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 + examples: + - 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + readOnly: false + type: boolean + examples: + - true + exclude_metadata: + description: Indicates whether metadata should be excluded and only + git source should be included for the migration. + readOnly: false + type: boolean + examples: + - true + exclude_git_data: + description: Indicates whether the repository git data should be + excluded from the migration. + readOnly: false + type: boolean + examples: + - true + exclude_attachments: + description: Do not include attachments in the migration + readOnly: false + type: boolean + examples: + - true + exclude_releases: + description: Do not include releases in the migration + readOnly: false + type: boolean + examples: + - true + exclude_owner_projects: + description: Indicates whether projects owned by the organization + or users should be excluded. + readOnly: false + type: boolean + examples: + - true + org_metadata_only: + type: boolean + description: Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore other + flags). + default: false + examples: + - true + exclude: + description: Exclude attributes from the API response to improve + performance + readOnly: false + type: array + items: + description: Allowed values that can be passed to the exclude + param. + enum: + - repositories + type: string + examples: + - repositories + examples: + - repositories + repositories: + type: array + items: + description: Repository path, owner and name + type: string + examples: + - acme/widgets + 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}/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/enterprise-server@3.14/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 + "/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/enterprise-server@3.14/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 + "/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/projects": + post: + summary: Create a user project + description: 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. + tags: + - projects + operationId: projects/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#create-a-user-project + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + required: + - name + type: object + examples: + default: + summary: Create a new project + value: + name: My Projects + body: A board to manage my personal projects. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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" + '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. + + 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/enterprise-server@3.14/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 + examples: + - 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 + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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. + type: string + examples: + - Haskell + license_template: + description: The license keyword of the open source license for + this repository. + type: string + examples: + - mit + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + examples: + - 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 + examples: + - true + is_template: + description: Whether this repository acts as a template that can + be used to generate new repositories. + default: false + type: boolean + examples: + - 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 + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + examples: + - https://twitter.com/github + examples: [] + 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. + + 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/enterprise-server@3.14/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 + examples: + - https://twitter.com/github + examples: [] + 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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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 + examples: + - 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/rest/users/emails)". + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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 + "/users": + get: + summary: List users + description: |- + Lists all users, in the order that they signed up on GitHub Enterprise Server. 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/enterprise-server@3.14/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/enterprise-server@3.14/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/{username}": + get: + summary: Get a user + description: |- + Provides publicly available information about someone with a GitHub account. + + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/rest/users/emails)". + tags: + - users + operationId: users/get-by-username + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/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}/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/enterprise-server@3.14/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). + + > [!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/enterprise-server@3.14/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. + + > [!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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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}/projects": + get: + summary: List user projects + description: Lists projects for a user. + tags: + - projects + operationId: projects/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/projects/projects#list-user-projects + parameters: + - "$ref": "#/components/parameters/username" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items-3" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: projects + "/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/enterprise-server@3.14/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] + > 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/enterprise-server@3.14/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/enterprise-server@3.14/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}/site_admin": + put: + summary: Promote a user to be a site administrator + 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/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." + operationId: enterprise-admin/promote-user-to-be-site-administrator + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Demote a site administrator + description: You can demote any user account except your own. + operationId: enterprise-admin/demote-site-administrator + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#demote-a-site-administrator + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.14/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/enterprise-server@3.14/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + "/users/{username}/suspended": + put: + summary: Suspend a user + description: |- + If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + + You can suspend any user account except your own. + + 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/enterprise-server@3.14/rest/guides/getting-started-with-the-rest-api#http-method)." + operationId: enterprise-admin/suspend-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#suspend-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + reason: + type: string + description: The reason the user is being suspended. This message + will be logged in the [audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). + If you don't provide a `reason`, it will default to "Suspended + via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ + is the person who performed the action. + examples: + reason: + value: + reason: Suspended during leave of absence. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Unsuspend a user + description: If your GitHub instance uses [LDAP Sync with Active Directory LDAP + servers](https://docs.github.com/enterprise-server@3.14/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), + this API is disabled and will return a `403` response. Active Directory LDAP-authenticated + users cannot be unsuspended using the API. + operationId: enterprise-admin/unsuspend-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/users#unsuspend-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + requestBody: + content: + application/json: + schema: + type: + - object + - 'null' + properties: + reason: + type: string + description: The reason the user is being unsuspended. This message + will be logged in the [audit log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). + If you don't provide a `reason`, it will default to "Unsuspended + via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ + is the person who performed the action. + examples: + reason: + value: + reason: Unsuspended after leave of absence. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.14/rest/meta/meta#get-the-zen-of-github + responses: + '200': + description: Response + content: + application/json: + schema: + type: string + examples: + default: + summary: Example response + value: Responsive is better than fast + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta +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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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-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. + For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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-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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-response-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + cache-sync: + post: + summary: This event occurs when a Git ref has been successfully synced to a + cache replica. For more information, see "[About repository caching](https://docs.github.com/enterprise-server@3.14/admin/enterprise-management/caching-repositories/about-repository-caching)." + operationId: cache-sync + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#cache_sync + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-cache-sync" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: cache_sync + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/developers/apps/guides/creating-ci-tests-with-the-checks-api)." + operationId: check-run/requested-action + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-server@3.14/rest/checks/runs#create-a-check-run)" + in the REST API documentation. + operationId: check-suite/requested + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-server@3.14/rest/checks/suites#create-a-check-suite)" + in the REST API documentation. + operationId: check-suite/rerequested + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.14/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.14/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.9.0 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.9.0 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + enterprise-anonymous-access-disabled: + post: + summary: This event occurs when there is activity relating to anonymous Git + read access in an enterprise. For more information, see "[Enforcing repository + management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." + description: Anonymous Git read access was disabled. + operationId: enterprise/anonymous-access-disabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#enterprise + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: enterprise + supported-webhook-types: + - business + enterprise-anonymous-access-enabled: + post: + summary: This event occurs when there is activity relating to anonymous Git + read access in an enterprise. For more information, see "[Enforcing repository + management policies in your enterprise](https://docs.github.com/enterprise-server@3.14/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." + description: Anonymous Git read access was enabled. + operationId: enterprise/anonymous-access-enabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#enterprise + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: enterprise + supported-webhook-types: + - business + fork: + post: + summary: |- + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-server@3.14/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + label-created: + post: + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.14/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. + description: A package was published to a registry. + operationId: package/published + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + - app + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.14/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. + description: A previously published package was updated. + operationId: package/updated + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + - app + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was approved. + operationId: personal-access-token-request/approved + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + 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/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was created. + operationId: personal-access-token-request/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was denied. + operationId: personal-access-token-request/denied + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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 + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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, + 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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-anonymous-access-disabled: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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: Someone disabled anonymous Git read access to the repository. For + more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." + operationId: repository/anonymous-access-disabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" + 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: + - app + - business + - organization + - repository + repository-anonymous-access-enabled: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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: Someone enabled anonymous Git read access to the repository. For + more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." + operationId: repository/anonymous-access-enabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" + 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: + - app + - business + - organization + - repository + repository-archived: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-privatized: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.14/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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-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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.14/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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-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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.14/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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-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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.14/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + user-created: + post: + summary: This event occurs when there is activity relating to user accounts + in an enterprise. + description: A user account was added to the enterprise. + operationId: user/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#user + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-user-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: user + supported-webhook-types: + - business + user-deleted: + post: + summary: This event occurs when there is activity relating to user accounts + in an enterprise. + description: A user account was removed from the enterprise. + operationId: user/deleted + externalDocs: + url: https://docs.github.com/enterprise-server@3.14/webhooks/webhook-events-and-payloads#user + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-user-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: user + supported-webhook-types: + - business + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.14/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.14/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + global-hook: + type: object + properties: + type: + type: string + id: + type: integer + name: + type: string + active: + type: boolean + events: + type: array + items: + type: string + config: + type: object + properties: + url: + type: string + content_type: + type: string + insecure_ssl: + type: string + secret: + type: string + updated_at: + type: string + created_at: + type: string + url: + type: string + ping_url: + type: string + global-hook-2: + type: object + properties: + type: + type: string + id: + type: integer + name: + type: string + active: + type: boolean + events: + type: array + items: + type: string + config: + type: object + properties: + url: + type: string + content_type: + type: string + insecure_ssl: + type: string + updated_at: + type: string + created_at: + type: string + url: + type: string + ping_url: + type: string + public-key-full: + type: object + properties: + id: + type: integer + format: int64 + key: + type: string + user_id: + type: + - integer + - 'null' + repository_id: + type: + - integer + - 'null' + format: int64 + url: + type: string + title: + type: string + read_only: + type: boolean + verified: + type: boolean + created_at: + type: string + format: date-time + added_by: + type: + - string + - 'null' + last_used: + type: + - string + - 'null' + format: date-time + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + - last_used + - user_id + - repository_id + ldap-mapping-team: + type: object + properties: + ldap_dn: + type: string + id: + type: integer + node_id: + type: string + url: + type: string + html_url: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + members_url: + type: string + repositories_url: + type: string + parent: + type: + - 'null' + ldap-mapping-user: + title: Ldap Private User + description: Ldap Private User + type: object + properties: + ldap_dn: + type: string + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + suspended_at: + type: string + format: date-time + business_plus: + type: boolean + user_view_type: + type: string + examples: + - 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 + - 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 + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + pre-receive-environment: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + image_url: + type: string + url: + type: string + html_url: + type: string + default_environment: + type: boolean + created_at: + type: string + hooks_count: + type: integer + download: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + pre-receive-environment-download-status: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + script: + type: string + script_repository: + type: object + properties: + id: + type: integer + full_name: + type: string + url: + type: string + html_url: + type: string + environment: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + image_url: + type: string + url: + type: string + html_url: + type: string + default_environment: + type: boolean + created_at: + type: string + hooks_count: + type: integer + download: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + allow_downstream_configuration: + type: boolean + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + type: + - string + - 'null' + email: + type: + - string + - 'null' + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + starred_at: + type: string + examples: + - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - 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 + 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 + 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 leve 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 + 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 + 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 + 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 custom + property management. + 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_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 + team_discussions: + type: string + description: The level of permission to grant the access token to manage + team discussions and related comments. + 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 + example: + contents: read + issues: read + deployments: write + single_file: read + 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 + - 'null' + examples: + - config.yaml + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + account: + "$ref": "#/components/schemas/simple-user" + required: + - permissions + - repository_selection + - single_file_name + - repositories_url + - account + 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 + - 'null' + items: + type: string + token: + type: string + token_last_eight: + type: + - string + - 'null' + hashed_token: + type: + - string + - 'null' + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + note: + type: + - string + - 'null' + note_url: + type: + - string + - 'null' + format: uri + updated_at: + type: string + format: date-time + created_at: + type: string + format: date-time + fingerprint: + type: + - string + - 'null' + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + installation: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/scoped-installation" + expires_at: + type: + - string + - 'null' + format: date-time + required: + - app + - id + - note + - note_url + - scopes + - token + - hashed_token + - token_last_eight + - fingerprint + - url + - created_at + - updated_at + - expires_at + 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 + - 'null' + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: + - string + - 'null' + description: The unique package name within its ecosystem. + required: + - ecosystem + - name + vulnerable_version_range: + type: + - string + - 'null' + description: The range of the package versions affected by the vulnerability. + first_patched_version: + type: + - string + - 'null' + description: The package version that resolves the vulnerability. + vulnerable_functions: + type: + - array + - 'null' + description: The functions in the package that are affected by the vulnerability. + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions + cvss-severities: + type: + - object + - 'null' + properties: + cvss_v3: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 3 vector string. + score: + type: + - number + - 'null' + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 4 vector string. + score: + type: + - number + - 'null' + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + 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 + - 'null' + description: The Common Vulnerabilities and Exposures (CVE) ID. + 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 + - 'null' + format: uri + description: The API URL for the repository advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: + - string + - 'null' + description: A detailed description of what the advisory entails. + maxLength: 65535 + 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 + - 'null' + format: uri + description: The URL of the advisory's source code. + identifiers: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + description: The date and time of when the advisory was reviewed by GitHub, + in ISO 8601 format. + readOnly: true + nvd_published_at: + type: + - string + - 'null' + 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 + withdrawn_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO + 8601 format. + readOnly: true + vulnerabilities: + type: + - array + - 'null' + description: The products and respective version ranges affected by the + advisory. + items: + "$ref": "#/components/schemas/vulnerability" + cvss: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS vector. + score: + type: + - number + - 'null' + description: The CVSS score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + cwes: + type: + - array + - 'null' + 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 + epss: + type: + - object + - 'null' + properties: + percentage: + type: number + percentile: + type: number + credits: + type: + - array + - 'null' + description: In GitHub Enterprise Server, this field will always be empty + because the user metadata of credited users will not be available. + 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 + 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 + 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 + - 'null' + properties: + id: + description: Unique identifier of the GitHub app + type: integer + examples: + - 37 + slug: + description: The slug name of the GitHub app + type: string + examples: + - probot-owners + node_id: + type: string + examples: + - MDExOkludGVncmF0aW9uMQ== + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + name: + description: The name of the GitHub app + type: string + examples: + - Probot Owners + description: + type: + - string + - 'null' + examples: + - The description of the app. + external_url: + type: string + format: uri + examples: + - https://example.com + html_url: + type: string + format: uri + examples: + - https://github.com/apps/super-ci + created_at: + type: string + format: date-time + examples: + - '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + examples: + - '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 + type: array + items: + type: string + examples: + - label + - deployment + installations_count: + description: The number of installations associated with the GitHub app + type: integer + examples: + - 5 + client_secret: + type: string + examples: + - '"1d4b2097ac622ba702d19de498f005747a8b21d3"' + webhook_secret: + type: + - string + - 'null' + examples: + - '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' + pem: + type: string + examples: + - '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END + RSA PRIVATE KEY-----\n"' + 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. + format: uri + examples: + - https://example.com/webhook + 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`. + examples: + - '"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/enterprise-server@3.14/webhooks/event-payloads/#delivery-headers). + examples: + - '"********"' + 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.** + examples: + - '"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 + examples: + - 42 + guid: + description: Unique identifier for the event (shared with all deliveries + for all webhooks that subscribe to this event). + type: string + examples: + - 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + examples: + - '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + examples: + - false + duration: + description: Time spent delivering. + type: number + examples: + - 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + examples: + - failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + examples: + - 502 + event: + description: The event that triggered the delivery. + type: string + examples: + - issues + action: + description: The type of activity for the event that triggered the delivery. + type: + - string + - 'null' + examples: + - opened + installation_id: + description: The id of the GitHub App installation associated with this + event. + type: + - integer + - 'null' + examples: + - 123 + repository_id: + description: The id of the repository associated with this event. + type: + - integer + - 'null' + examples: + - 123 + throttled_at: + description: Time when the webhook delivery was throttled. + type: + - string + - 'null' + format: date-time + examples: + - '2021-05-12T20:33:44Z' + 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 + - 'null' + documentation_url: + type: + - string + - 'null' + detail: + type: + - string + - 'null' + status: + type: integer + scimType: + type: + - string + - 'null' + 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 + - 'null' + - type: + - integer + - 'null' + - type: + - array + - 'null' + 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 + examples: + - 42 + guid: + description: Unique identifier for the event (shared with all deliveries + for all webhooks that subscribe to this event). + type: string + examples: + - 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + examples: + - '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + examples: + - false + duration: + description: Time spent delivering. + type: number + examples: + - 0.03 + status: + description: Description of the status of the attempted delivery + type: string + examples: + - failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + examples: + - 502 + event: + description: The event that triggered the delivery. + type: string + examples: + - issues + action: + description: The type of activity for the event that triggered the delivery. + type: + - string + - 'null' + examples: + - opened + installation_id: + description: The id of the GitHub App installation associated with this + event. + type: + - integer + - 'null' + examples: + - 123 + repository_id: + description: The id of the repository associated with this event. + type: + - integer + - 'null' + examples: + - 123 + throttled_at: + description: Time when the webhook delivery was throttled. + type: + - string + - 'null' + format: date-time + examples: + - '2021-05-12T20:33:44Z' + url: + description: The URL target of the delivery. + type: string + examples: + - https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: + - object + - 'null' + additionalProperties: true + payload: + description: The webhook payload. + type: + - object + - 'null' + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: + - object + - 'null' + additionalProperties: true + payload: + description: The response payload received. + type: + - string + - 'null' + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '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-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 + examples: + - 42 + node_id: + type: string + examples: + - 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 + examples: + - '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 + examples: + - 1 + account: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" + type: + - 'null' + - object + 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 + examples: + - https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/installation/repositories + html_url: + type: string + format: uri + examples: + - https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + examples: + - 1 + target_id: + description: The ID of the user or organization this token is being scoped + to. + type: integer + target_type: + type: string + examples: + - 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 + - 'null' + examples: + - config.yaml + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + app_slug: + type: string + examples: + - github-actions + suspended_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + suspended_at: + type: + - string + - 'null' + format: date-time + contact_email: + type: + - string + - 'null' + examples: + - '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + 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 + license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + examples: + - mit + name: + type: string + examples: + - MIT License + url: + type: + - string + - 'null' + format: uri + examples: + - https://api.github.com/licenses/mit + spdx_id: + type: + - string + - 'null' + examples: + - MIT + node_id: + type: string + examples: + - MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + deprecated: true + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - '"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 + 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 + examples: + - README.md + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + required: + - token + - expires_at + application-grant: + title: Application Grant + description: The authorization associated with an OAuth Access. + type: object + properties: + id: + type: integer + format: int64 + examples: + - 1 + url: + type: string + format: uri + examples: + - https://api.github.com/applications/grants/1 + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + scopes: + type: array + items: + type: string + examples: + - public_repo + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - app + - id + - scopes + - url + - created_at + - updated_at + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + examples: + - contributor_covenant + name: + type: string + examples: + - Contributor Covenant + url: + type: string + format: uri + examples: + - https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + examples: + - | + # 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 + - 'null' + format: uri + required: + - url + - html_url + - key + - name + announcement-message: + type: + - string + - 'null' + description: The announcement text in GitHub Flavored Markdown. For more information + about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.14/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + examples: + - Very **important** announcement about _something_. + announcement-expiration: + type: + - string + - 'null' + format: date-time + description: 'The time at which the announcement expires. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + To set an announcement that never expires, omit this parameter, set it to + `null`, or set it to an empty string.' + examples: + - '"2021-01-01T00:00:00.000-07:00"' + announcement: + title: Enterprise Announcement + description: Enterprise global announcement + type: object + properties: + announcement: + "$ref": "#/components/schemas/announcement-message" + expires_at: + "$ref": "#/components/schemas/announcement-expiration" + required: + - announcement + license-info: + type: object + properties: + seats: + oneOf: + - type: string + - type: integer + seats_used: + type: integer + seats_available: + oneOf: + - type: string + - type: integer + kind: + type: string + days_until_expiration: + type: integer + expire_at: + type: string + enterprise-repository-overview: + title: Repository Enterprise Stats + type: object + properties: + total_repos: + type: integer + root_repos: + type: integer + fork_repos: + type: integer + org_repos: + type: integer + total_pushes: + type: integer + total_wikis: + type: integer + required: + - total_repos + - root_repos + - fork_repos + - org_repos + - total_pushes + - total_wikis + enterprise-hook-overview: + title: Hooks Enterprise Stats + type: object + properties: + total_hooks: + type: integer + active_hooks: + type: integer + inactive_hooks: + type: integer + required: + - total_hooks + - active_hooks + - inactive_hooks + enterprise-page-overview: + title: Enterprise Pages Stats + type: object + properties: + total_pages: + type: integer + required: + - total_pages + enterprise-organization-overview: + title: Enterprise Organization Stats + type: object + properties: + total_orgs: + type: integer + disabled_orgs: + type: integer + total_teams: + type: integer + total_team_members: + type: integer + required: + - total_orgs + - disabled_orgs + - total_teams + - total_team_members + enterprise-user-overview: + title: Enterprise User Stats + type: object + properties: + total_users: + type: integer + admin_users: + type: integer + suspended_users: + type: integer + required: + - total_users + - admin_users + - suspended_users + enterprise-pull-request-overview: + title: Enterprise Pull Request Stats + type: object + properties: + total_pulls: + type: integer + merged_pulls: + type: integer + mergeable_pulls: + type: integer + unmergeable_pulls: + type: integer + required: + - total_pulls + - merged_pulls + - mergeable_pulls + - unmergeable_pulls + enterprise-issue-overview: + title: Enterprise Issue Stats + type: object + properties: + total_issues: + type: integer + open_issues: + type: integer + closed_issues: + type: integer + required: + - total_issues + - open_issues + - closed_issues + enterprise-milestone-overview: + title: Enterprise Milestone Stats + type: object + properties: + total_milestones: + type: integer + open_milestones: + type: integer + closed_milestones: + type: integer + required: + - total_milestones + - open_milestones + - closed_milestones + enterprise-gist-overview: + title: Enterprise Gist Stats + type: object + properties: + total_gists: + type: integer + private_gists: + type: integer + public_gists: + type: integer + required: + - total_gists + - private_gists + - public_gists + enterprise-comment-overview: + title: Enterprise Comment Stats + type: object + properties: + total_commit_comments: + type: integer + total_gist_comments: + type: integer + total_issue_comments: + type: integer + total_pull_request_comments: + type: integer + required: + - total_commit_comments + - total_gist_comments + - total_issue_comments + - total_pull_request_comments + enterprise-overview: + type: object + properties: + repos: + "$ref": "#/components/schemas/enterprise-repository-overview" + hooks: + "$ref": "#/components/schemas/enterprise-hook-overview" + pages: + "$ref": "#/components/schemas/enterprise-page-overview" + orgs: + "$ref": "#/components/schemas/enterprise-organization-overview" + users: + "$ref": "#/components/schemas/enterprise-user-overview" + pulls: + "$ref": "#/components/schemas/enterprise-pull-request-overview" + issues: + "$ref": "#/components/schemas/enterprise-issue-overview" + milestones: + "$ref": "#/components/schemas/enterprise-milestone-overview" + gists: + "$ref": "#/components/schemas/enterprise-gist-overview" + comments: + "$ref": "#/components/schemas/enterprise-comment-overview" + enterprise-security-products-overview: + title: Enterprise Security Products Stats + type: object + properties: + total_repos: + type: integer + nonarchived_repos: + type: integer + secret_scanning_enabled_repos: + type: integer + secret_scanning_push_protection_enabled_repos: + type: integer + code_scanning_enabled_repos: + type: integer + code_scanning_pr_reviews_enabled_repos: + type: integer + code_scanning_default_setup_enabled_repos: + type: integer + code_scanning_default_setup_eligible_repos: + type: integer + dependabot_alerts_enabled_repos: + type: integer + dependabot_security_updates_enabled_repos: + type: integer + dependabot_version_updates_enabled_repos: + type: integer + advanced_security_enabled_repos: + type: integer + active_committers: + type: integer + purchased_committers: + type: integer + maximum_committers: + type: integer + 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-policy-enterprise: + title: Actions cache usage policy for an enterprise + description: GitHub Actions cache usage policy for an enterprise. + type: object + properties: + repo_cache_size_limit_in_gb: + description: For repositories in an enterprise, the default size limit for + the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 + max_repo_cache_size_limit_in_gb: + description: For repositories in an enterprise, the maximum value that can + be set as the limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 15 + enabled-organizations: + type: string + description: The policy that controls the organizations in the enterprise that + are allowed to run GitHub Actions. + enum: + - all + - none + - selected + allowed-actions: + type: string + description: The permissions policy that controls the actions 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 that are allowed to + run, when `allowed_actions` is set to `selected`. + actions-enterprise-permissions: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + selected_organizations_url: + type: string + description: The API URL to use to get or set the selected organizations + that are allowed to run GitHub Actions, when `enabled_organizations` is + set to `selected`. + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" + required: + - enabled_organizations + 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. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow specific + action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, + `monalisa/octocat@v2`, `monalisa/*`. + items: + type: string + required: + - github_owned_allowed + - patterns_allowed + 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-enterprise: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - allows_public_repositories + - default + - runners_url + 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 + examples: + - 5 + runner_group_id: + description: The id of the runner group. + type: integer + examples: + - 1 + name: + description: The name of the runner. + type: string + examples: + - iMac + os: + description: The Operating System of the runner. + type: string + examples: + - macos + status: + description: The status of the runner. + type: string + examples: + - online + busy: + type: boolean + labels: + type: array + items: + "$ref": "#/components/schemas/runner-label" + 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 + examples: + - v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + examples: + - '2016-07-11T22:14:10Z' + permissions: + type: object + examples: + - issues: read + deployments: write + repositories: + description: The repositories this token has access to + type: array + items: + "$ref": "#/components/schemas/repository" + single_file: + type: + - string + - 'null' + examples: + - config.yaml + 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 + audit-log-event: + type: object + properties: + "@timestamp": + type: integer + description: The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + action: + type: string + description: The name of the action that was performed, for example `user.login` + or `repo.create`. + active: + type: boolean + active_was: + type: boolean + actor: + type: string + description: The actor who performed the action. + actor_id: + type: integer + description: The id of the actor who performed the action. + actor_location: + type: object + properties: + country_name: + type: string + data: + type: object + additionalProperties: true + org_id: + type: integer + user_id: + type: integer + business_id: + type: integer + blocked_user: + type: string + description: The username of the account being blocked. + business: + type: string + config: + type: array + items: + type: object + config_was: + type: array + items: + type: object + content_type: + type: string + operation_type: + type: string + created_at: + type: integer + description: The time the audit log event was recorded, given as a [Unix + timestamp](http://en.wikipedia.org/wiki/Unix_time). + deploy_key_fingerprint: + type: string + _document_id: + type: string + description: A unique identifier for an audit event. + emoji: + type: string + events: + type: array + items: + type: object + events_were: + type: array + items: + type: object + explanation: + type: string + fingerprint: + type: string + hook_id: + type: integer + limited_availability: + type: boolean + message: + type: string + name: + type: string + old_user: + type: string + openssh_public_key: + type: string + org: + type: string + previous_visibility: + type: string + read_only: + type: boolean + repo: + type: string + description: The name of the repository. + repository: + type: string + description: The name of the repository. + repository_public: + type: boolean + target_login: + type: string + team: + type: string + transport_protocol: + type: integer + description: The type of protocol (for example, HTTP or SSH) used to transfer + Git data. + transport_protocol_name: + type: string + description: A human readable name for the protocol (for example, HTTP or + SSH) used to transfer Git data. + user: + type: string + description: The user that was affected by the action performed (if available). + visibility: + type: string + description: The repository visibility, for example `public` or `private`. + 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: + type: + - string + - 'null' + 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 + 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 + - 'null' + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + - + alert-fixed-at: + type: + - string + - 'null' + 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 + alert-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-alert-dismissed-reason: + type: + - string + - 'null' + description: "**Required when the state is dismissed.** The reason for dismissing + or closing the alert." + enum: + - false positive + - won't fix + - used in tests + - + code-scanning-alert-dismissed-comment: + type: + - string + - 'null' + description: The dismissal comment associated with the dismissal of the alert. + maxLength: 280 + code-scanning-alert-rule-summary: + type: object + properties: + id: + type: + - string + - 'null' + 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: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + 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. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + code-scanning-analysis-tool-version: + type: + - string + - 'null' + 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`, + `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 + - 'null' + description: A classification of the file. For example to identify it as generated. + 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 + 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 + description: A unique identifier of the repository. + examples: + - 1296269 + node_id: + type: string + description: The GraphQL identifier of the repository. + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + description: The name of the repository. + examples: + - Hello-World + full_name: + type: string + description: The full, globally unique, name of the repository. + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + description: The URL to view the repository on GitHub.com. + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + description: The repository description. + examples: + - This your first repo! + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + description: The URL to get more information about the repository from the + GitHub API. + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + description: A template for the API URL to download the repository as an + archive. + examples: + - https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + description: A template for the API URL to list the available assignees + for issues in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + description: A template for the API URL to get information about branches + in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + description: A template for the API URL to get information about collaborators + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + description: A template for the API URL to get information about comments + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + description: A template for the API URL to get information about commits + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + description: A template for the API URL to compare two commits or refs. + examples: + - https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + description: A template for the API URL to get the contents of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + description: A template for the API URL to list the contributors to the + repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + description: The API URL to list the deployments of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + description: The API URL to list the downloads on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + description: The API URL to list the events of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + description: The API URL to list the forks of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + description: A template for the API URL to get information about Git commits + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + description: A template for the API URL to get information about Git refs + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + description: A template for the API URL to get information about Git tags + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: + type: string + description: A template for the API URL to get information about issue comments + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + description: A template for the API URL to get information about issue events + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + description: A template for the API URL to get information about issues + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + description: A template for the API URL to get information about deploy + keys on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + description: A template for the API URL to get information about labels + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + description: The API URL to get information about the languages of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + description: The API URL to merge branches in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + description: A template for the API URL to get information about milestones + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + description: A template for the API URL to get information about notifications + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + description: A template for the API URL to get information about pull requests + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + description: A template for the API URL to get information about releases + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: + type: string + format: uri + description: The API URL to list the stargazers on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + description: A template for the API URL to get information about statuses + of a commit. + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + description: The API URL to list the subscribers on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + description: The API URL to subscribe to notifications for this repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + description: The API URL to get information about tags on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + description: The API URL to list the teams on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: + type: string + format: uri + description: The API URL to list the hooks on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks + 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-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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + - repository + enterprise-security-analysis-settings: + title: Enterprise Security Analysis Settings + type: object + properties: + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to + this enterprise. + examples: + - false + advanced_security_enabled_for_new_user_namespace_repositories: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled for + new user namespace repositories. + examples: + - false + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this + enterprise. + examples: + - false + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this + enterprise. + examples: + - false + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: |- + Whether secret scanning push protection is automatically enabled for new repositories and repositories + transferred to this enterprise. + examples: + - false + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: An optional URL string to display to contributors who are blocked + from pushing a secret. + examples: + - https://github.com/test-org/test-repo/blob/main/README.md + required: + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + 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 + - 'null' + description: Details pertaining to the package version that patches this + vulnerability. + readOnly: 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 + - 'null' + description: The unique CVE ID assigned to the advisory. + readOnly: 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 + 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 + - 'null' + description: The full CVSS vector string for the advisory. + readOnly: true + required: + - score + - vector_string + additionalProperties: false + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + 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 + - 'null' + description: 'The time that the advisory was withdrawn in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cvss + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + additionalProperties: false + alert-auto-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was auto-dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + 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 + - 'null' + description: The execution scope of the vulnerable dependency. + readOnly: true + enum: + - development + - runtime + - + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + dismissed_reason: + type: + - string + - 'null' + description: The reason that the alert was dismissed. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + - + dismissed_comment: + type: + - string + - 'null' + description: An optional comment associated with the alert's dismissal. + maxLength: 280 + fixed_at: + "$ref": "#/components/schemas/alert-fixed-at" + auto_dismissed_at: + "$ref": "#/components/schemas/alert-auto-dismissed-at" + 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 + 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 + - 'null' + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + advanced-security-active-committers-user: + type: object + properties: + user_login: + type: string + last_pushed_date: + type: string + examples: + - '2021-11-03' + last_pushed_email: + type: string + examples: + - monalisa@github.com + required: + - user_login + - last_pushed_date + - last_pushed_email + advanced-security-active-committers-repository: + type: object + properties: + name: + type: string + examples: + - octocat/Hello-World + advanced_security_committers: + type: integer + examples: + - 25 + advanced_security_committers_breakdown: + type: array + items: + "$ref": "#/components/schemas/advanced-security-active-committers-user" + required: + - name + - advanced_security_committers + - advanced_security_committers_breakdown + advanced-security-active-committers: + type: object + properties: + total_advanced_security_committers: + type: integer + examples: + - 25 + total_count: + type: integer + examples: + - 2 + maximum_advanced_security_committers: + type: integer + description: The total number of GitHub Advanced Security licences required + if all repositories were to enable GitHub Advanced Security + examples: + - 4 + purchased_advanced_security_committers: + type: integer + description: The total number of GitHub Advanced Security licences purchased + examples: + - 4 + repositories: + type: array + items: + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + required: + - repositories + actor: + title: Actor + description: Actor + type: object + properties: + id: + type: integer + login: + type: string + display_login: + type: string + gravatar_id: + type: + - string + - 'null' + url: + type: string + format: uri + avatar_url: + type: string + format: uri + required: + - id + - login + - gravatar_id + - url + - avatar_url + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + examples: + - 1002604 + node_id: + type: string + examples: + - MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + examples: + - 42 + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + default: open + examples: + - open + title: + description: The title of the milestone. + type: string + examples: + - v1.0 + description: + type: + - string + - 'null' + examples: + - Tracking milestone for version 1.0 + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + open_issues: + type: integer + examples: + - 4 + closed_issues: + type: integer + examples: + - 8 + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2013-02-12T13:22:01Z' + due_on: + type: + - string + - 'null' + format: date-time + examples: + - '2012-10-09T23:39:01Z' + 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 + author-association: + title: author_association + type: string + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + examples: + - 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 + 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 + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/1 + 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 + type: integer + examples: + - 42 + state: + description: State of the issue; either 'open' or 'closed' + type: string + examples: + - open + state_reason: + description: The reason for the current state + type: + - string + - 'null' + enum: + - completed + - reopened + - not_planned + - + examples: + - not_planned + title: + description: Title of the issue + type: string + examples: + - Widget creation fails in Safari on OS X 10.8 + body: + description: Contents of the issue + type: + - string + - 'null' + examples: + - 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? + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + - 'null' + color: + type: + - string + - 'null' + default: + type: boolean + examples: + - bug + - registration + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + locked: + type: boolean + active_lock_reason: + type: + - string + - 'null' + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: + - string + - 'null' + format: date-time + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + repository: + "$ref": "#/components/schemas/repository" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + author_association: + "$ref": "#/components/schemas/author-association" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + 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 + 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 + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - id + - node_id + - html_url + - issue_url + - author_association + - user + - url + - created_at + - updated_at + event: + title: Event + description: Event + type: object + properties: + id: + type: string + type: + type: + - string + - 'null' + 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: + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + pages: + type: array + items: + type: object + properties: + page_name: + type: string + title: + type: string + summary: + type: + - string + - 'null' + action: + type: string + sha: + type: string + html_url: + type: string + public: + type: boolean + created_at: + type: + - string + - 'null' + format: date-time + 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 + examples: + - https://github.com/timeline + user_url: + type: string + examples: + - https://github.com/{user} + current_user_public_url: + type: string + examples: + - https://github.com/octocat + current_user_url: + type: string + examples: + - https://github.com/octocat.private?token=abc123 + current_user_actor_url: + type: string + examples: + - https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: + type: string + examples: + - https://github.com/octocat-org + current_user_organization_urls: + type: array + items: + type: string + format: uri + examples: + - https://github.com/organizations/github/octocat.private.atom?token=abc123 + security_advisories_url: + type: string + examples: + - https://github.com/security-advisories + repository_discussions_url: + type: string + description: A feed of discussions for a given repository. + examples: + - https://github.com/{user}/{repo}/discussions + repository_discussions_category_url: + type: string + description: A feed of discussions for a given repository and category. + examples: + - https://github.com/{user}/{repo}/discussions/categories/{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 + - 'null' + comments: + type: integer + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + - 'null' + 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 + - 'null' + company: + type: + - string + - 'null' + blog: + type: + - string + - 'null' + location: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + notification_email: + type: + - string + - 'null' + format: email + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + twitter_username: + type: + - string + - 'null' + 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 + examples: + - 1 + total_private_repos: + type: integer + examples: + - 2 + owned_private_repos: + type: integer + examples: + - 2 + disk_usage: + type: integer + examples: + - 1 + collaborators: + type: integer + examples: + - 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + type: + - array + - 'null' + 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 + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/gist-history" + fork_of: + title: Gist + description: Gist + type: + - object + - 'null' + 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 + - 'null' + comments: + type: integer + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments_url: + type: string + format: uri + owner: + anyOf: + - type: 'null' + - "$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 + 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: + type: + - object + - 'null' + 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 + - 'null' + comments: + type: integer + user: + type: + - string + - 'null' + comments_url: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + truncated: + type: boolean + gist-comment: + title: Gist Comment + description: A comment made to a gist. + type: object + properties: + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDExOkdpc3RDb21tZW50MQ== + url: + type: string + format: uri + examples: + - https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: + description: The comment text. + type: string + maxLength: 65535 + examples: + - Body of the attachment + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-18T23:23:56Z' + updated_at: + type: string + format: date-time + examples: + - '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 + examples: + - https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: + type: string + examples: + - 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + committed_at: + type: string + format: date-time + examples: + - '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 + examples: + - C + source: + type: string + examples: + - | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + required: + - name + - source + license: + title: License + description: License + type: object + properties: + key: + type: string + examples: + - mit + name: + type: string + examples: + - MIT License + spdx_id: + type: + - string + - 'null' + examples: + - MIT + url: + type: + - string + - 'null' + format: uri + examples: + - https://api.github.com/licenses/mit + node_id: + type: string + examples: + - MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + examples: + - http://choosealicense.com/licenses/mit/ + description: + type: string + examples: + - 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 + examples: + - 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 + items: + type: string + examples: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + conditions: + type: array + items: + type: string + examples: + - include-copyright + limitations: + type: array + items: + type: string + examples: + - no-liability + body: + type: string + examples: + - |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 + examples: + - true + required: + - key + - name + - url + - spdx_id + - node_id + - html_url + - description + - implementation + - permissions + - conditions + - limitations + - body + - featured + ghes-get-ssh: + type: array + items: + type: object + properties: + key: + type: string + format: ssh-key + description: The full public key + fingerprint: + type: string + format: ssh-key fingerprint + description: The fingerprint of the key + ghes-set-ssh-request: + title: Set SSH key + type: object + properties: + key: + description: The public SSH key to add to the `authorized_keys` file. + type: string + required: + - key + ghes-set-ssh-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + description: Hostname of the node where the SSH key was added. + uuid: + type: string + format: uuid + description: UUID of the SSH key that was added. + message: + type: string + description: Message indicating the result of the SSH key addition. + error: + type: string + description: Error message indicating the reason for the SSH key addition + failure. This field is only present if the SSH key addition failed. + modified: + type: boolean + description: Whether the SSH key was already present on the `authorized_keys` + file. + ghes-delete-ssh-request: + title: Set SSH key + type: object + properties: + key: + description: The public SSH key to remove from the `authorized_keys` file. + type: string + required: + - key + ghes-delete-ssh-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + description: Hostname of the node where the SSH key was removed. + uuid: + type: string + format: uuid + description: UUID of the SSH key that was removed. + message: + type: string + description: Message indicating the result of the SSH key removal. + error: + type: string + description: Error message indicating the reason for the SSH key removal + failure. This field is only present if the SSH key removal failed. + ghes-checks-result-indicator: + type: string + enum: + - OK + - FAILED + ghes-checks-system-requirements: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + roles_status: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + role: + type: string + ghes-cluster-status-indicator: + type: string + enum: + - UNKNOWN + - OK + - WARNING + - CRITICAL + ghes-cluster-status: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + services: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + name: + type: string + details: + type: string + ghes-config-init-request: + title: Initialize configuration with license upload + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + password: + type: string + description: The root site administrator password. + required: + - license + - password + ghes-license-info: + type: object + properties: + advancedSecurityEnabled: + description: Whether the GitHub Advanced Security feature is enabled. + type: boolean + advancedSecuritySeats: + description: If the GitHub Advanced Security feature is enabled, the seat + count. + type: integer + clusterSupport: + description: Whether the cluster support feature is enabled. + type: boolean + company: + description: The company under which the license is issued. + type: string + croquetSupport: + description: Whether the Github Connect feature is enabled. + type: boolean + customTerms: + description: Whether this license is issued under custom terms. + type: boolean + evaluation: + description: Wheter this license is issued as an evaluation license. + type: boolean + expireAt: + description: The expiration date of the license. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + insightsEnabled: + description: Whether the insights feature is enabled. + type: boolean + insightsExpireAt: + description: If the insights feature is enabled, the expiration date. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + learningLabEvaluationExpires: + description: If the learning lab feature is enabled, the expiration date. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + learningLabSeats: + description: If the learning lab feature is enabled, the seat count. + type: integer + perpetual: + description: Whether the perpetual feature is enabled. + type: boolean + referenceNumber: + description: The unique reference number of the license. + type: string + seats: + description: If the license is issued with limited seating, the seat count. + type: integer + sshAllowed: + description: Whether the SSH feature is enabled. + type: boolean + supportKey: + description: The support key of the license. + type: string + unlimitedSeating: + description: Whether the license is issued with unlimited seat count. + type: boolean + ghes-upload-license-request: + title: License upload form + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + required: + - license + ghes-license-check: + type: object + properties: + status: + description: The license status of the currently active enterprise license. + type: string + enum: + - valid + - invalid + - expired + - cluster mode not supported + ghes-cluster-topology: + type: string + enum: + - SingleNode + - Ha + - Cluster + ghes-cluster-roles: + type: string + enum: + - Blank + - ActionsServer + - ConsulServer + - ElasticsearchServer + - GitServer + - JobServer + - LaunchServer + - MemcacheServer + - MetricsServer + - MssqlServer + - MysqlServer + - PagesServer + - RedisServer + - StorageServer + - WebServer + ghes-config-nodes: + type: object + properties: + topology: + "$ref": "#/components/schemas/ghes-cluster-topology" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + uuid: + type: string + replica: + type: boolean + cluster_roles: + type: array + items: + "$ref": "#/components/schemas/ghes-cluster-roles" + ghes-get-settings: + type: object + properties: + private_mode: + type: boolean + public_pages: + type: boolean + subdomain_isolation: + type: boolean + signup_enabled: + type: boolean + github_hostname: + type: string + identicons_host: + type: string + http_proxy: + type: + - string + - 'null' + auth_mode: + type: string + expire_sessions: + type: boolean + admin_password: + type: + - string + - 'null' + configuration_id: + type: integer + configuration_run_count: + type: integer + avatar: + type: object + properties: + enabled: + type: boolean + uri: + type: string + customer: + type: object + properties: + name: + type: string + email: + type: string + uuid: + type: string + secret_key_data: + type: string + public_key_data: + type: string + license: + type: object + properties: + seats: + type: integer + evaluation: + type: boolean + perpetual: + type: boolean + unlimited_seating: + type: boolean + support_key: + type: string + ssh_allowed: + type: boolean + cluster_support: + type: boolean + expire_at: + type: string + github_ssl: + type: object + properties: + enabled: + type: boolean + cert: + type: + - string + - 'null' + key: + type: + - string + - 'null' + ldap: + type: object + properties: + host: + type: + - string + - 'null' + port: + type: integer + base: + type: array + items: + type: string + uid: + type: + - string + - 'null' + bind_dn: + type: + - string + - 'null' + password: + type: + - string + - 'null' + method: + type: string + search_strategy: + type: string + user_groups: + type: array + items: + type: string + admin_group: + type: + - string + - 'null' + virtual_attribute_enabled: + type: boolean + recursive_group_search: + type: boolean + posix_support: + type: boolean + user_sync_emails: + type: boolean + user_sync_keys: + type: boolean + user_sync_interval: + type: integer + team_sync_interval: + type: integer + sync_enabled: + type: boolean + reconciliation: + type: object + properties: + user: + type: + - string + - 'null' + org: + type: + - string + - 'null' + profile: + type: object + properties: + uid: + type: string + name: + type: + - string + - 'null' + mail: + type: + - string + - 'null' + key: + type: + - string + - 'null' + cas: + type: object + properties: + url: + type: + - string + - 'null' + saml: + type: object + properties: + sso_url: + type: + - string + - 'null' + certificate: + type: + - string + - 'null' + certificate_path: + type: + - string + - 'null' + issuer: + type: + - string + - 'null' + idp_initiated_sso: + type: boolean + disable_admin_demote: + type: boolean + github_oauth: + type: object + properties: + client_id: + type: string + client_secret: + type: string + organization_name: + type: string + organization_team: + type: string + smtp: + type: object + properties: + enabled: + type: boolean + address: + type: string + authentication: + type: string + port: + type: string + domain: + type: string + username: + type: string + user_name: + type: string + enable_starttls_auto: + type: boolean + password: + type: string + discard-to-noreply-address: + type: boolean + support_address: + type: string + support_address_type: + type: string + noreply_address: + type: string + ntp: + type: object + properties: + primary_server: + type: string + secondary_server: + type: string + timezone: + type: + - string + - 'null' + snmp: + type: object + properties: + enabled: + type: boolean + community: + type: string + syslog: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + protocol_name: + type: string + assets: + type: + - string + - 'null' + pages: + type: object + properties: + enabled: + type: boolean + collectd: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + port: + type: integer + encryption: + type: + - string + - 'null' + username: + type: + - string + - 'null' + password: + type: + - string + - 'null' + mapping: + type: object + properties: + enabled: + type: boolean + tileserver: + type: + - string + - 'null' + basemap: + type: string + token: + type: + - string + - 'null' + load_balancer: + type: + - string + - 'null' + ghes-get-maintenance: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + uuid: + type: string + format: uuid + status: + type: string + enum: + - 'on' + - 'off' + - scheduled + scheduled_time: + type: string + format: date + connection_services: + type: array + items: + type: object + properties: + name: + type: string + number: + type: integer + can_unset_maintenance: + type: boolean + ip_exception_list: + type: array + items: + type: string + format: ip/cidr + maintenance_mode_message: + type: string + ghes-set-maintenance-request: + title: Set Maintenance mode + type: object + properties: + enabled: + description: Whether to enable maintenance mode. + type: boolean + uuid: + description: The UUID of the node to target. This parameter is incompatible + with maintenance mode scheduling. Only use `uuid` if the value of `when` + is empty or `now`. + type: string + format: uuid + when: + description: The time to enable maintenance mode. If this parameter is empty + or set to `now`, maintenance mode is enabled immediately. Otherwise, maintenance + mode is enabled at the specified time. The format is ISO 8601. + type: string + format: date-time + examples: + - '2006-01-02T15:04:05+00:00' + ip_exception_list: + description: The list of IP addresses to exclude from maintenance mode. + IPv4, IPv6, and CIDR addresses are supported. + type: array + items: + type: string + format: ip/cidr + examples: + - '["1.1.1.1","192.168.1.0/24"]' + maintenance_mode_message: + description: The message to display to users when maintenance mode is enabled. + type: string + required: + - enabled + ghes-set-maintenance-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + uuid: + type: string + format: uuid + message: + type: string + error: + type: string + ghes-replication-status-indicator: + type: string + enum: + - UNKNOWN + - OK + - WARNING + - CRITICAL + ghes-replication-status: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + services: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + name: + type: string + details: + type: string + ghes-version: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + version: + type: object + properties: + version: + type: string + pattern: "[0-9]\\.[0-9]{2}\\.[0-9]" + platform: + type: string + enum: + - ami + - azure + - esx + - gce + - hyperv + - kvm + build_id: + type: string + pattern: "[0-9a-f]{8}" + build_date: + type: string + format: date + api-overview: + title: Api Overview + description: Api Overview + type: object + properties: + verifiable_password_authentication: + type: boolean + examples: + - true + packages: + type: array + items: + type: string + examples: + - 192.0.2.1 + domains: + type: object + properties: + website: + type: array + items: + type: string + examples: + - example.com + codespaces: + type: array + items: + type: string + examples: + - example.com + copilot: + type: array + items: + type: string + examples: + - example.com + packages: + type: array + items: + type: string + examples: + - example.com + actions: + type: array + items: + type: string + examples: + - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + examples: + - example + services: + type: array + items: + type: string + examples: + - example.com + installed_version: + type: string + examples: + - 3.14.0 + required: + - verifiable_password_authentication + security-and-analysis: + type: + - object + - 'null' + properties: + advanced_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 + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: + - string + - 'null' + language: + type: + - string + - 'null' + 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 + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + examples: + - 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 + - 'null' + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + node_id: + type: string + forks: + type: integer + examples: + - 0 + open_issues: + type: integer + examples: + - 0 + watchers: + type: integer + examples: + - 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + examples: + - false + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + 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 + 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 + - 'null' + url: + type: string + subscription_url: + type: string + examples: + - 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 + examples: + - true + ignored: + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/notifications/threads/1/subscription + thread_url: + type: string + format: uri + examples: + - https://api.github.com/notifications/threads/1 + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/1 + required: + - created_at + - ignored + - reason + - url + - subscribed + organization-custom-repository-role: + title: Organization Custom Repository Role + description: Custom repository roles created by organization owners + type: object + properties: + id: + description: The unique identifier of the custom role. + type: integer + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + organization: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - name + - base_role + - permissions + - organization + - created_at + - updated_at + organization-full: + title: Organization Full + description: Organization Full + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + name: + type: string + examples: + - github + company: + type: string + examples: + - GitHub + blog: + type: string + format: uri + examples: + - https://github.com/blog + location: + type: string + examples: + - San Francisco + email: + type: string + format: email + examples: + - octocat@github.com + twitter_username: + type: + - string + - 'null' + examples: + - github + is_verified: + type: boolean + examples: + - true + has_organization_projects: + type: boolean + examples: + - true + has_repository_projects: + type: boolean + examples: + - true + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + type: + type: string + examples: + - Organization + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + private_gists: + type: + - integer + - 'null' + examples: + - 81 + disk_usage: + type: + - integer + - 'null' + examples: + - 10000 + collaborators: + type: + - integer + - 'null' + description: |- + The number of collaborators on private repositories. + + This field may be null if the number of private repositories is over 50,000. + examples: + - 8 + billing_email: + type: + - string + - 'null' + format: email + examples: + - org@example.com + 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 + - 'null' + members_can_create_repositories: + type: + - boolean + - 'null' + examples: + - true + two_factor_requirement_enabled: + type: + - boolean + - 'null' + examples: + - true + members_allowed_repository_creation_type: + type: string + examples: + - all + members_can_create_public_repositories: + type: boolean + examples: + - true + members_can_create_private_repositories: + type: boolean + examples: + - true + members_can_create_internal_repositories: + type: boolean + examples: + - true + members_can_create_pages: + type: boolean + examples: + - true + members_can_create_public_pages: + type: boolean + examples: + - true + members_can_create_private_pages: + type: boolean + examples: + - true + members_can_fork_private_repositories: + type: + - boolean + - 'null' + examples: + - false + web_commit_signoff_required: + type: boolean + examples: + - false + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/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. + examples: + - false + deprecated: true + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/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. + examples: + - false + 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/enterprise-server@3.14/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. + examples: + - false + deprecated: true + dependency_graph_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/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. + examples: + - false + deprecated: true + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.14/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. + examples: + - false + 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/enterprise-server@3.14/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. + examples: + - false + 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. + examples: + - false + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: An optional URL string to display to contributors who are blocked + from pushing a secret. + examples: + - https://github.com/test-org/test-repo/blob/main/README.md + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + archived_at: + type: + - string + - 'null' + format: date-time + 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 + 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 + examples: + - 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 + examples: + - 2322142 + active_caches_count: + description: The number of active caches in the repository. + type: integer + examples: + - 3 + required: + - full_name + - active_caches_size_in_bytes + - active_caches_count + 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 + 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" + required: + - enabled_repositories + 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 + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories + 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. + type: string + examples: + - SECRET_TOKEN + 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 + examples: + - 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 + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + examples: + - 2 + url: + type: string + examples: + - https://api.github.com/user/keys/2 + title: + type: string + examples: + - ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + examples: + - '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. + type: string + examples: + - USERNAME + value: + description: The value of the variable. + type: string + examples: + - octocat + 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 + examples: + - '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 + examples: + - '2019-01-24T22:45:36.000Z' + visibility: + description: Visibility of a variable + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/org/variables/USERNAME/repositories + required: + - name + - value + - created_at + - updated_at + - visibility + announcement-user-dismissible: + type: + - boolean + - 'null' + description: Whether an announcement can be dismissed by the user. + default: false + examples: + - false + announcement-banner: + title: Announcement Banner + description: Announcement at either the repository, organization, or enterprise + level + type: object + properties: + announcement: + "$ref": "#/components/schemas/announcement-message" + expires_at: + "$ref": "#/components/schemas/announcement-expiration" + user_dismissible: + "$ref": "#/components/schemas/announcement-user-dismissible" + required: + - announcement + - expires_at + - user_dismissible + code-scanning-alert-severity: + type: string + description: Severity of a code scanning alert. + enum: + - critical + - high + - medium + - low + - warning + - note + - error + organization-custom-repository-role-create-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + required: + - name + - base_role + - permissions + organization-custom-repository-role-update-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + 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. + type: string + examples: + - SECRET_TOKEN + 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 + examples: + - 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 + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + package: + title: Package + description: A software package + type: object + properties: + id: + description: Unique identifier of the package. + type: integer + examples: + - 1 + name: + description: The name of the package. + type: string + examples: + - super-linter + package_type: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + examples: + - docker + url: + type: string + examples: + - https://api.github.com/orgs/github/packages/container/super-linter + html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/package/super-linter + version_count: + description: The number of versions of the package. + type: integer + examples: + - 1 + visibility: + type: string + enum: + - private + - public + examples: + - private + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + external-group: + title: ExternalGroup + description: Information about an external group's usage and its members + type: object + required: + - group_id + - group_name + - teams + - members + properties: + group_id: + description: The internal ID of the group + type: integer + examples: + - 1 + group_name: + description: The display name for the group + type: string + examples: + - group-azuread-test + updated_at: + description: The date when the group was last updated_at + type: string + examples: + - 2021-01-03 22:27:15:000 -700 + teams: + description: An array of teams linked to this group + type: array + items: + type: object + required: + - team_id + - team_name + properties: + team_id: + description: The id for a team + type: integer + examples: + - 1 + team_name: + description: The name of the team + type: string + examples: + - team-test + examples: + - team_id: 1 + team_name: team-test + - team_id: 2 + team_name: team-test2 + members: + description: An array of external members linked to this group + type: array + items: + type: object + required: + - member_id + - member_login + - member_name + - member_email + properties: + member_id: + description: The internal user ID of the identity + type: integer + examples: + - 1 + member_login: + description: The handle/login for the user + type: string + examples: + - mona-lisa_eocsaxrs + member_name: + description: The user display name/profile name + type: string + examples: + - Mona Lisa + member_email: + description: An email attached to a user + type: string + examples: + - mona_lisa@github.com + examples: + - member_id: 1 + member_login: mona-lisa_eocsaxrs + member_name: Mona Lisa + member_email: mona_lisa@github.com + - member_id: 2 + member_login: octo-lisa_eocsaxrs + member_name: Octo Lisa + member_email: octo_lisa@github.com + external-groups: + title: ExternalGroups + description: A list of external groups available to be connected to a team + type: object + properties: + groups: + description: An array of external groups available to be mapped to a team + type: array + items: + type: object + required: + - group_id + - group_name + - updated_at + properties: + group_id: + description: The internal ID of the group + type: integer + examples: + - 1 + group_name: + description: The display name of the group + type: string + examples: + - group-azuread-test + updated_at: + description: The time of the last update for this group + type: string + examples: + - 2019-06-03 22:27:15:000 -700 + examples: + - group_id: 1 + group_name: group-azuread-test + updated_at: 2021-01-03 22:27:15:000 -700 + - group_id: 2 + group_name: group-azuread-test2 + updated_at: 2021-06-03 22:27:15:000 -700 + org-hook: + title: Org Hook + description: Org Hook + type: object + properties: + id: + type: integer + examples: + - 1 + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1 + ping_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1/deliveries + name: + type: string + examples: + - web + events: + type: array + items: + type: string + examples: + - push + - pull_request + active: + type: boolean + examples: + - true + config: + type: object + properties: + url: + type: string + examples: + - '"http://example.com/2"' + insecure_ssl: + type: string + examples: + - '"0"' + content_type: + type: string + examples: + - '"form"' + secret: + type: string + examples: + - '"********"' + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + type: + type: string + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + org-membership: + title: Org Membership + description: Org Membership + type: object + properties: + url: + type: string + format: uri + examples: + - 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. + enum: + - active + - pending + examples: + - active + role: + type: string + description: The user's membership type in the organization. + enum: + - admin + - member + - billing_manager + examples: + - admin + organization_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat + organization: + "$ref": "#/components/schemas/organization-simple" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 79 + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + guid: + type: string + examples: + - 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: + type: string + examples: + - pending + lock_repositories: + type: boolean + examples: + - 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 + examples: + - https://api.github.com/orgs/octo-org/migrations/79 + created_at: + type: string + format: date-time + examples: + - '2015-07-06T15:33:38-07:00' + updated_at: + type: string + format: date-time + examples: + - '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 + organization-fine-grained-permission: + title: Organization Fine-Grained Permission + description: A fine-grained permission that protects organization resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + 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 + - 'null' + base_role: + type: + - string + - 'null' + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + - admin + - + source: + type: + - string + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + organization-custom-organization-role-create-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about the intended usage of this role or + what permissions it grants. + type: string + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + required: + - name + - permissions + organization-custom-organization-role-update-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about the intended use of this role or + the permissions it grants. + type: string + permissions: + description: A list of additional permissions included in this role. + type: array + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + 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 + examples: + - direct + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + 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 + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - 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 + examples: + - direct + inherited_from: + description: Team the user has gotten the role through + type: array + items: + "$ref": "#/components/schemas/team-simple" + name: + type: + - string + - 'null' + email: + type: + - string + - 'null' + login: + type: string + examples: + - octocat + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + starred_at: + type: string + examples: + - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - 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 + examples: + - 1 + name: + description: The name of the package version. + type: string + examples: + - latest + url: + type: string + examples: + - https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 + package_html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/package/super-linter + html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/super-linter/786068 + license: + type: string + examples: + - MIT + description: + type: string + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + deleted_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + metadata: + type: object + title: Package Version Metadata + properties: + package_type: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + examples: + - docker + 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 + - 'null' + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + 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-pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + configuration_url: + type: string + allow_downstream_configuration: + type: boolean + project: + title: Project + description: Projects are a way to organize columns and cards of work. + type: object + properties: + owner_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test + url: + type: string + format: uri + examples: + - https://api.github.com/projects/1002604 + html_url: + type: string + format: uri + examples: + - https://github.com/api-playground/projects-test/projects/12 + columns_url: + type: string + format: uri + examples: + - https://api.github.com/projects/1002604/columns + id: + type: integer + examples: + - 1002604 + node_id: + type: string + examples: + - MDc6UHJvamVjdDEwMDI2MDQ= + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + number: + type: integer + examples: + - 1 + state: + description: State of the project; either 'open' or 'closed' + type: string + examples: + - open + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + organization_permission: + description: The baseline permission that all organization members have + on this project. Only present if owner is an organization. + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. Only present + if owner is an organization. + type: boolean + required: + - id + - node_id + - number + - name + - body + - state + - url + - html_url + - owner_url + - creator + - columns_url + - created_at + - updated_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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - org_actors + - org_and_repo_actors + - + description: Who can edit the values of the property + examples: + - org_actors + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + 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 + type: + - 'null' + - string + - array + 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 + examples: + - 1296269 + repository_name: + type: string + examples: + - Hello-World + repository_full_name: + type: string + examples: + - 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 + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + examples: + - citizen_code_of_conduct + name: + type: string + examples: + - Citizen Code of Conduct + html_url: + type: + - string + - 'null' + format: uri + examples: + - 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 + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + type: boolean + examples: + - true + topics: + type: array + items: + type: string + examples: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + examples: + - true + has_projects: + type: boolean + examples: + - true + has_wiki: + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + type: boolean + examples: + - true + has_discussions: + type: boolean + examples: + - true + 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 + examples: + - public + pushed_at: + type: string + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '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 + examples: + - true + template_repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository" + temp_clone_token: + type: + - string + - 'null' + allow_squash_merge: + type: boolean + examples: + - true + allow_auto_merge: + type: boolean + examples: + - false + delete_branch_on_merge: + type: boolean + examples: + - false + allow_merge_commit: + type: boolean + examples: + - true + allow_update_branch: + type: boolean + examples: + - true + use_squash_pr_title_as_default: + type: boolean + examples: + - false + 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). + examples: + - PR_TITLE + 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. + examples: + - PR_BODY + 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). + examples: + - PR_TITLE + 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. + examples: + - PR_BODY + allow_forking: + type: boolean + examples: + - true + web_commit_signoff_required: + type: boolean + examples: + - false + subscribers_count: + type: integer + examples: + - 42 + network_count: + type: integer + examples: + - 0 + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + repository-fine-grained-permission: + title: Repository Fine-Grained Permission + description: A fine-grained permission that protects repository resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + 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 not available for the `repository` target. + 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 + - 'null' + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. 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. + enum: + - always + - pull_request + 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. + 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. + 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-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-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 the same + syntax as `.gitignore` files. + 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_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id + 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: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string + 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: + - 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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-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/enterprise-server@3.14/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/enterprise-server@3.14/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: + 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-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + 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 + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + 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 + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + type: + - 'null' + - object + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + 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 + examples: + - '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 + 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 + - 'null' + description: The number that identifies the user. + actor_name: + type: + - string + - 'null' + 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 + examples: + - '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 + - 'null' + enum: + - pass + - fail + 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 + - 'null' + description: The ID of the rule source. + name: + type: + - string + - 'null' + 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 + - 'null' + description: The detailed failure message for the rule. Null if the + rule passed. + 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 + - 'null' + 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 + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + team-organization: + title: Team Organization + description: Team Organization + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + name: + type: string + examples: + - github + company: + type: string + examples: + - GitHub + blog: + type: string + format: uri + examples: + - https://github.com/blog + location: + type: string + examples: + - San Francisco + email: + type: string + format: email + examples: + - octocat@github.com + twitter_username: + type: + - string + - 'null' + examples: + - github + is_verified: + type: boolean + examples: + - true + has_organization_projects: + type: boolean + examples: + - true + has_repository_projects: + type: boolean + examples: + - true + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + type: + type: string + examples: + - Organization + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + private_gists: + type: + - integer + - 'null' + examples: + - 81 + disk_usage: + type: + - integer + - 'null' + examples: + - 10000 + collaborators: + type: + - integer + - 'null' + examples: + - 8 + billing_email: + type: + - string + - 'null' + format: email + examples: + - org@example.com + 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 + - 'null' + members_can_create_repositories: + type: + - boolean + - 'null' + examples: + - true + two_factor_requirement_enabled: + type: + - boolean + - 'null' + examples: + - true + members_allowed_repository_creation_type: + type: string + examples: + - all + members_can_create_public_repositories: + type: boolean + examples: + - true + members_can_create_private_repositories: + type: boolean + examples: + - true + members_can_create_internal_repositories: + type: boolean + examples: + - true + members_can_create_pages: + type: boolean + examples: + - true + members_can_create_public_pages: + type: boolean + examples: + - true + members_can_create_private_pages: + type: boolean + examples: + - true + members_can_fork_private_repositories: + type: + - boolean + - 'null' + examples: + - false + web_commit_signoff_required: + type: boolean + examples: + - false + updated_at: + type: string + format: date-time + archived_at: + type: + - string + - 'null' + format: date-time + 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 + 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 + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + name: + description: Name of the team + type: string + examples: + - Developers + slug: + type: string + examples: + - justice-league + description: + type: + - string + - 'null' + examples: + - A great team. + privacy: + description: The level of privacy this team should have + type: string + enum: + - closed + - secret + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + enum: + - notifications_enabled + - notifications_disabled + examples: + - notifications_enabled + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - push + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + members_count: + type: integer + examples: + - 3 + repos_count: + type: integer + examples: + - 10 + created_at: + type: string + format: date-time + examples: + - '2017-07-14T16:53:42Z' + updated_at: + type: string + format: date-time + examples: + - '2017-08-17T12:37:15Z' + organization: + "$ref": "#/components/schemas/team-organization" + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - created_at + - updated_at + - members_count + - repos_count + - organization + team-discussion: + title: Team Discussion + description: A team discussion is a persistent record of a free-form conversation + within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the discussion. + type: string + examples: + - Please suggest improvements to our workflow in comments. + body_html: + type: string + examples: + - "

Hi! This is an area for us to collaborate as a team

" + body_version: + description: 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. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + comments_count: + type: integer + examples: + - 0 + comments_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1/comments + created_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: + type: string + examples: + - MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: + description: The unique sequence number of a team discussion. + type: integer + examples: + - 42 + pinned: + description: Whether or not this discussion should be pinned for easy retrieval. + type: boolean + examples: + - true + private: + description: Whether or not this discussion should be restricted to team + members and organization owners. + type: boolean + examples: + - true + team_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027 + title: + description: The title of the discussion. + type: string + examples: + - How can we improve our workflow? + updated_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - comments_count + - comments_url + - created_at + - last_edited_at + - html_url + - pinned + - private + - node_id + - number + - team_url + - title + - updated_at + - url + team-discussion-comment: + title: Team Discussion Comment + description: A reply to a discussion within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the comment. + type: string + examples: + - I agree with this suggestion. + body_html: + type: string + examples: + - "

Do you like apples?

" + body_version: + description: 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. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + created_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + discussion_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: + type: string + examples: + - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: + description: The unique sequence number of a team discussion comment. + type: integer + examples: + - 42 + updated_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - created_at + - last_edited_at + - discussion_url + - html_url + - node_id + - number + - updated_at + - url + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + 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 + type: string + examples: + - member + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + team-project: + title: Team Project + description: A team's access to a project. + type: object + properties: + owner_url: + type: string + url: + type: string + html_url: + type: string + columns_url: + type: string + id: + type: integer + node_id: + type: string + name: + type: string + body: + type: + - string + - 'null' + number: + type: integer + state: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + updated_at: + type: string + organization_permission: + description: The organization permission for this project. Only present + when owner is an organization. + type: string + private: + description: Whether the project is private or not. Only present when owner + is an organization. + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + - permissions + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - admin + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 80 + size: + type: integer + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + examples: + - false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + examples: + - 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 + project-card: + title: Project Card + description: Project cards represent a scope of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/cards/1478 + id: + description: The project card's ID + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDExOlByb2plY3RDYXJkMTQ3OA== + note: + type: + - string + - 'null' + examples: + - Add payload for delete Project column + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:21:06Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:20:22Z' + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + column_name: + type: string + project_id: + type: string + column_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + content_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + required: + - id + - node_id + - note + - url + - column_url + - project_url + - creator + - created_at + - updated_at + project-column: + title: Project Column + description: Project columns contain cards of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + cards_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367/cards + id: + description: The unique identifier of the project column + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEzOlByb2plY3RDb2x1bW4zNjc= + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:18:44Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:22:28Z' + required: + - id + - node_id + - url + - project_url + - cards_url + - name + - created_at + - updated_at + project-collaborator-permission: + title: Project Collaborator Permission + description: Project Collaborator Permission + type: object + properties: + permission: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - permission + - user + 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" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + examples: + - AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + examples: + - 12345 + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + examples: + - 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 + - 'null' + format: date-time + expires_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + workflow_run: + type: + - object + - 'null' + properties: + id: + type: integer + examples: + - 10 + repository_id: + type: integer + examples: + - 42 + head_repository_id: + type: integer + examples: + - 42 + head_branch: + type: string + examples: + - main + head_sha: + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-usage-policy-for-repository: + title: Actions cache usage policy for repository + description: GitHub Actions cache usage policy for repository. + type: object + properties: + repo_cache_size_limit_in_gb: + description: The size limit for the sum of all caches, in gigabytes. + type: integer + examples: + - 14 + required: + - repo_cache_size_limit_in_gb + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + examples: + - 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + examples: + - 2 + ref: + type: string + examples: + - refs/heads/main + key: + type: string + examples: + - Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + examples: + - 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + examples: + - 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. + type: integer + examples: + - 21 + run_id: + description: The id of the associated workflow run. + type: integer + examples: + - 5 + run_url: + type: string + examples: + - 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. + examples: + - 1 + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + status: + description: The phase of the lifecycle that the job is currently in. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - success + created_at: + description: The time that the job created, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + started_at: + description: The time that the job started, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + name: + description: The name of the job. + type: string + examples: + - test-coverage + 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. + type: string + enum: + - queued + - in_progress + - completed + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + examples: + - success + name: + description: The name of the job. + type: string + examples: + - test-coverage + number: + type: integer + examples: + - 1 + started_at: + description: The time that the step started, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + check_run_url: + type: string + examples: + - 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. + examples: + - self-hosted + - foo + - bar + runner_id: + type: + - integer + - 'null' + 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.) + examples: + - 1 + runner_name: + type: + - string + - 'null' + 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.) + examples: + - my runner + runner_group_id: + type: + - integer + - 'null' + 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.) + examples: + - 2 + runner_group_name: + type: + - string + - 'null' + 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.) + examples: + - my runner group + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + examples: + - Build + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + examples: + - 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. + type: string + examples: + - SECRET_TOKEN + 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. + type: string + examples: + - USERNAME + value: + description: The value of the variable. + type: string + examples: + - octocat + 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 + examples: + - '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 + examples: + - '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" + 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 + 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. `enterprise` level access allows sharing across the enterprise. + enum: + - none + - user + - organization + - enterprise + 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 + 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 + simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + timestamp: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + author: + type: + - object + - 'null' + description: Information about the Git author + properties: + name: + description: Name of the commit's author + type: string + examples: + - Monalisa Octocat + email: + description: Git email address of the commit's author + type: string + format: email + examples: + - monalisa.octocat@example.com + required: + - name + - email + committer: + type: + - object + - 'null' + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + type: string + examples: + - Monalisa Octocat + email: + description: Git email address of the commit's committer + type: string + format: email + examples: + - monalisa.octocat@example.com + required: + - name + - email + required: + - id + - tree_id + - message + - timestamp + - author + - committer + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + examples: + - 5 + name: + type: + - string + - 'null' + description: The name of the workflow run. + examples: + - Build + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + examples: + - 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + examples: + - MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that points to the version of the + workflow being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + path: + description: The full path of the workflow + type: string + examples: + - octocat/octo-repo/.github/workflows/ci.yml@main + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + examples: + - 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was re-run. + examples: + - 1 + referenced_workflows: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/referenced-workflow" + event: + type: string + examples: + - push + status: + type: + - string + - 'null' + examples: + - completed + conclusion: + type: + - string + - 'null' + examples: + - neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + examples: + - 5 + url: + type: string + description: The URL to the workflow run. + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + examples: + - 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 + - 'null' + 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + description: The URL to the previous attempted run of this workflow, if + one exists. + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-commit" + repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository_id: + type: integer + examples: + - 5 + display_title: + type: string + 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. + examples: + - Simple 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. + type: integer + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - 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. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO + 8601 format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + state: + description: Whether deployment to the environment(s) was approved or rejected + or pending (with comments) + enum: + - approved + - rejected + - pending + type: string + examples: + - approved + user: + "$ref": "#/components/schemas/simple-user" + comment: + type: string + description: The comment submitted with the deployment review + examples: + - 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 + examples: + - 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 + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + examples: + - 30 + wait_timer_started_at: + description: The time that the wait timer began. + format: date-time + type: + - string + - 'null' + examples: + - '2020-11-23T22:00:40Z' + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + sha: + type: string + examples: + - a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + type: string + examples: + - topic-branch + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + payload: + oneOf: + - type: object + additionalProperties: true + - type: string + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - 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.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDg6V29ya2Zsb3cxMg== + name: + type: string + examples: + - CI + path: + type: string + examples: + - ruby.yaml + state: + type: string + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + examples: + - active + created_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + url: + type: string + examples: + - https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + examples: + - https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + examples: + - https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + activity: + title: Activity + description: Activity + type: object + properties: + id: + type: integer + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: + type: string + description: The SHA of the commit before the activity. + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + after: + type: string + description: The SHA of the commit after the activity. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + ref: + type: string + description: The full Git reference, formatted as `refs/heads/`. + examples: + - refs/heads/main + timestamp: + type: string + format: date-time + description: The time when the activity occurred. + examples: + - '2011-01-26T19:06:43Z' + activity_type: + type: string + enum: + - push + - force_push + - branch_deletion + - branch_creation + - pr_merge + - merge_queue_merge + description: The type of the activity that was performed. + examples: + - force_push + actor: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 3 + key_prefix: + description: The prefix of a key that is linkified. + type: string + examples: + - TICKET- + url_template: + description: A template for the target URL that is generated if a key was + found. + type: string + examples: + - https://example.com/TICKET?query= + is_alphanumeric: + description: Whether this autolink reference matches alphanumeric characters. + If false, this autolink reference only matches numeric characters. + type: boolean + examples: + - true + required: + - id + - key_prefix + - url_template + - is_alphanumeric + check-automated-security-fixes: + title: Check Automated Security Fixes + description: Check Automated Security Fixes + type: object + properties: + enabled: + type: boolean + description: Whether automated security fixes are enabled for the repository. + examples: + - true + paused: + type: boolean + description: Whether automated security fixes are paused for the repository. + examples: + - false + 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 + - 'null' + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"' + users_url: + type: string + examples: + - '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"' + teams_url: + type: string + examples: + - '"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 + examples: + - true + require_code_owner_reviews: + type: boolean + examples: + - true + required_approving_review_count: + type: integer + minimum: 0 + maximum: 6 + examples: + - 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 + default: false + examples: + - true + 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: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + html_url: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + members_url: + type: string + repositories_url: + type: string + parent: + type: + - string + - 'null' + 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 + examples: + - '""' + html_url: + type: string + examples: + - '"https://github.com/testorg-ea8ec76d71c3af4b"' + followers_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"' + following_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"' + gists_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"' + starred_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"' + subscriptions_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"' + organizations_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"' + received_events_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"' + type: + type: string + examples: + - '"Organization"' + site_admin: + type: boolean + examples: + - false + user_view_type: + type: string + examples: + - 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 + examples: + - '"branch/with/protection"' + protection_url: + type: string + examples: + - '"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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + examples: + - 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 + git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + examples: + - '"Chris Wanstrath"' + email: + type: string + examples: + - '"chris@ozmm.org"' + date: + type: string + examples: + - '"2007-10-29T02:42:39.000-07:00"' + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: + - string + - 'null' + signature: + type: + - string + - 'null' + required: + - verified + - reason + - payload + - signature + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + examples: + - bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + examples: + - file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + examples: + - added + additions: + type: integer + examples: + - 103 + deletions: + type: integer + examples: + - 21 + changes: + type: integer + examples: + - 124 + blob_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + examples: + - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + previous_filename: + type: string + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + examples: + - MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + message: + type: string + examples: + - Fix all the bugs + comment_count: + type: integer + examples: + - 0 + tree: + type: object + properties: + sha: + type: string + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + examples: + - 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: + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object + committer: + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object + parents: + type: array + items: + type: object + properties: + sha: + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + examples: + - 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 + examples: + - '"mas*"' + required_approving_review_count: + type: integer + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: + type: boolean + examples: + - true + contexts: + type: array + items: + type: string + examples: + - continuous-integration/travis-ci + checks: + type: array + items: + type: object + properties: + context: + type: string + examples: + - continuous-integration/travis-ci + app_id: + type: + - integer + - 'null' + required: + - context + - app_id + contexts_url: + type: string + format: uri + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - 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.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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. + type: integer + format: int64 + examples: + - 21 + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + external_id: + type: + - string + - 'null' + examples: + - '42' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + details_url: + type: + - string + - 'null' + examples: + - https://example.com + 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. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + examples: + - queued + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + started_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + output: + type: object + properties: + title: + type: + - string + - 'null' + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + 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. + type: string + examples: + - test-coverage + check_suite: + type: + - object + - 'null' + properties: + id: + type: integer + required: + - id + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - README.md + start_line: + type: integer + examples: + - 2 + end_line: + type: integer + examples: + - 2 + start_column: + type: + - integer + - 'null' + examples: + - 5 + end_column: + type: + - integer + - 'null' + examples: + - 10 + annotation_level: + type: + - string + - 'null' + examples: + - warning + title: + type: + - string + - 'null' + examples: + - Spell Checker + message: + type: + - string + - 'null' + examples: + - Check your spelling for 'banaas'. + raw_details: + type: + - string + - 'null' + examples: + - Do you mean 'bananas' or 'banana'? + blob_href: + type: string + required: + - path + - blob_href + - start_line + - end_line + - start_column + - end_column + - annotation_level + - title + - message + - raw_details + check-suite: + title: CheckSuite + description: A suite of checks performed on the code of a given code change + type: object + properties: + id: + type: integer + format: int64 + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + status: + type: + - string + - 'null' + 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. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + - + examples: + - completed + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - startup_failure + - stale + - + examples: + - neutral + url: + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/pull-request-minimal" + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + repository: + "$ref": "#/components/schemas/minimal-repository" + created_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + 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: + type: + - string + - 'null' + 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: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + 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: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + help: + type: + - string + - 'null' + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + type: + - string + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + 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-analysis-sarif-id: + type: string + description: An identifier for the upload. + examples: + - 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 + examples: + - 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 + examples: + - 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 + - 'null' + description: Next deletable analysis in chain, without last analysis deletion + confirmation + format: uri + readOnly: true + confirm_delete_url: + type: + - string + - 'null' + description: Next deletable analysis in chain, with last analysis deletion + confirmation + format: uri + readOnly: true + required: + - next_analysis_url + - confirm_delete_url + 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: + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - javascript + - python + - ruby + - typescript + - swift + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + updated_at: + description: Timestamp of latest configuration update. + type: + - string + - 'null' + format: date-time + examples: + - '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + type: + - string + - 'null' + enum: + - weekly + - + 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 + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + languages: + description: CodeQL languages to be analyzed. + type: array + items: + type: string + enum: + - 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. + 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-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)/.*$" + examples: + - 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/enterprise-server@3.14/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 + - 'null' + description: The REST API URL for getting the analyses associated with the + upload. + format: uri + readOnly: true + errors: + type: + - array + - 'null' + items: + type: string + description: Any errors that ocurred during processing of the delivery. + readOnly: true + 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 + examples: + - 7 + column: + description: The column number where this errors occurs. + type: integer + examples: + - 3 + source: + description: The contents of the line where the error occurs. + type: string + examples: + - "* user" + kind: + description: The type of error. + type: string + examples: + - Invalid owner + suggestion: + description: Suggested action to fix the error. This will usually + be `null`, but is provided for some common errors. + type: + - string + - 'null' + examples: + - 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 + examples: + - |- + Invalid owner on line 7: + + * user + ^ + path: + description: The path of the file where the error occured. + type: string + examples: + - ".github/CODEOWNERS" + required: + - line + - column + - kind + - message + - path + required: + - errors + collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + email: + type: + - string + - 'null' + name: + type: + - string + - 'null' + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - 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 + examples: + - admin + user_view_type: + type: string + examples: + - 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 + repository-collaborator-permission: + title: Repository Collaborator Permission + description: Repository Collaborator Permission + type: object + properties: + permission: + type: string + role_name: + type: string + examples: + - admin + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + position: + type: + - integer + - 'null' + line: + type: + - integer + - 'null' + commit_id: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + 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 + - 'null' + 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 + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + examples: + - 1347 + state: + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + type: string + examples: + - new-feature + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/team" + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + anyOf: + - type: 'null' + - "$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: + anyOf: + - type: 'null' + - "$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. + type: boolean + examples: + - false + 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 + simple-commit-status: + title: Simple Commit Status + type: object + properties: + description: + type: + - string + - 'null' + id: + type: integer + node_id: + type: string + state: + type: string + context: + type: string + target_url: + type: + - string + - 'null' + format: uri + required: + type: + - boolean + - 'null' + avatar_url: + type: + - string + - 'null' + 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 + - 'null' + id: + type: integer + node_id: + type: string + state: + type: string + description: + type: + - string + - 'null' + target_url: + type: + - string + - 'null' + context: + type: string + created_at: + type: string + updated_at: + type: string + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - url + - avatar_url + - id + - node_id + - state + - description + - target_url + - context + - created_at + - updated_at + - creator + commit-comparison: + title: Commit Comparison + description: Commit Comparison + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: + type: string + format: uri + examples: + - 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 + examples: + - ahead + ahead_by: + type: integer + examples: + - 4 + behind_by: + type: integer + examples: + - 5 + total_commits: + type: integer + examples: + - 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + examples: + - '"actual/actual.md"' + submodule_git_url: + type: string + examples: + - '"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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + 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 + 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 + - 'null' + payload: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The execution scope of the vulnerable dependency. + readOnly: true + enum: + - development + - runtime + - + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + dismissed_reason: + type: + - string + - 'null' + description: The reason that the alert was dismissed. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + - + dismissed_comment: + type: + - string + - 'null' + description: An optional comment associated with the alert's dismissal. + maxLength: 280 + fixed_at: + "$ref": "#/components/schemas/alert-fixed-at" + auto_dismissed_at: + "$ref": "#/components/schemas/alert-auto-dismissed-at" + 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. + type: string + examples: + - MY_ARTIFACTORY_PASSWORD + 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 + examples: + - path/to/package-lock.json + ecosystem: + type: string + examples: + - npm + name: + type: string + examples: + - "@actions/core" + version: + type: string + examples: + - 1.0.0 + package_url: + type: + - string + - 'null' + examples: + - pkg:/npm/%40actions/core@1.1.0 + license: + type: + - string + - 'null' + examples: + - MIT + source_repository_url: + type: + - string + - 'null' + examples: + - https://github.com/github/actions + vulnerabilities: + type: array + items: + type: object + properties: + severity: + type: string + examples: + - critical + advisory_ghsa_id: + type: string + examples: + - GHSA-rf4j-j272-fj86 + advisory_summary: + type: string + examples: + - A summary of the advisory. + advisory_url: + type: string + examples: + - 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 + description: The SPDX identifier for the SPDX document. + examples: + - SPDXRef-DOCUMENT + spdxVersion: + type: string + description: The version of the SPDX specification that this document + conforms to. + examples: + - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - '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/' + creationInfo: + type: object + properties: + created: + type: string + description: The date and time the SPDX document was created. + examples: + - '2021-11-03T00:00:00Z' + creators: + type: array + items: + type: string + examples: + - GitHub + description: The tools that were used to generate the SPDX document. + required: + - created + - creators + name: + type: string + description: The name of the SPDX document. + examples: + - github/github + dataLicense: + type: string + description: The license under which the SPDX document is licensed. + examples: + - CC0-1.0 + documentNamespace: + type: string + description: The namespace for the SPDX document. + examples: + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + packages: + type: array + items: + type: object + properties: + SPDXID: + type: string + description: A unique SPDX identifier for the package. + examples: + - SPDXRef-Package + name: + type: string + description: The name of the package. + examples: + - github/github + versionInfo: + type: string + description: |- + The version of the package. If the package does not have an exact version specified, + a version range is given. + examples: + - 1.0.0 + downloadLocation: + type: string + description: |- + The location where the package can be downloaded, + or NOASSERTION if this has not been determined. + examples: + - NOASSERTION + filesAnalyzed: + type: boolean + description: |- + Whether the package's file content has been subjected to + analysis during the creation of the SPDX document. + examples: + - false + licenseConcluded: + type: string + description: The license of the package as determined while creating + the SPDX document. + examples: + - MIT + licenseDeclared: + type: string + 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. + examples: + - NOASSERTION + supplier: + type: string + description: The distribution source of this package, or NOASSERTION + if this was not determined. + examples: + - NOASSERTION + copyrightText: + type: string + description: The copyright holders of the package, and any dates + present with those notices, if available. + examples: + - Copyright (c) 1985 GitHub.com + externalRefs: + type: array + items: + type: object + properties: + referenceCategory: + type: string + description: The category of reference to an external resource + this reference refers to. + examples: + - PACKAGE-MANAGER + referenceLocator: + type: string + description: A locator for the particular external resource + this reference refers to. + examples: + - pkg:gem/rails@6.0.1 + referenceType: + type: string + description: The category of reference to an external resource + this reference refers to. + examples: + - purl + required: + - referenceCategory + - referenceLocator + - referenceType + required: + - SPDXID + - name + - versionInfo + - downloadLocation + - filesAnalyzed + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + 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: + anyOf: + - type: string + - type: number + - type: boolean + type: + - 'null' + - string + - number + - 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. + pattern: "^pkg" + examples: + - pkg:/npm/%40actions/http-client@1.0.11 + 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. + enum: + - direct + - indirect + examples: + - direct + 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. + enum: + - runtime + - development + examples: + - runtime + dependencies: + type: array + description: Array of package-url (PURLs) of direct child dependencies. + items: + type: string + examples: + - "@actions/http-client" + additionalProperties: false + manifest: + type: object + properties: + name: + type: string + description: The name of the manifest. + examples: + - 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. + examples: + - "/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. + examples: + - 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. + examples: + - yourworkflowname_yourjobname + html_url: + type: string + description: The url for the job. + examples: + - 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 + minLength: 40 + maxLength: 40 + examples: + - ddc951f4b1293222421f2c8df679786153acf689 + ref: + description: The repository branch that triggered this snapshot. + type: string + pattern: "^refs/" + examples: + - refs/heads/main + detector: + type: object + description: A description of the detector used. + properties: + name: + type: string + description: The name of the detector used. + examples: + - docker buildtime detector + version: + type: string + description: The version of the detector used. + examples: + - 1.0.0 + url: + type: string + description: The url of the detector used. + examples: + - 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. + examples: + - '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 + examples: + - https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: + description: The state of the status. + enum: + - error + - failure + - inactive + - pending + - success + - queued + - in_progress + type: string + examples: + - success + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + description: + description: A short description of the status. + default: '' + type: string + maxLength: 140 + examples: + - Deployment finished successfully. + environment: + description: The environment of the deployment that the status is for. + default: '' + type: string + examples: + - production + target_url: + description: 'Closing down notice: the URL to associate with this status.' + default: '' + type: string + format: uri + examples: + - https://example.com/deployment/42/output + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + deployment_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/42 + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example + environment_url: + description: The URL for accessing your environment. + default: '' + type: string + format: uri + examples: + - https://staging.example.com/ + log_url: + description: The URL to associate with this status. + default: '' + type: string + format: uri + examples: + - https://example.com/deployment/42/output + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - state + - creator + - description + - deployment_url + - target_url + - repository_url + - url + - created_at + - updated_at + wait-timer: + type: integer + 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). + examples: + - 30 + deployment-branch-policy-settings: + type: + - object + - 'null' + 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`. + 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. + type: integer + format: int64 + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - 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. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO 8601 + format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + protection_rules: + type: array + description: Built-in deployment protection rules for the environment. + items: + anyOf: + - type: object + properties: + id: + type: integer + examples: + - 3515 + node_id: + type: string + examples: + - MDQ6R2F0ZTM1MTU= + type: + type: string + examples: + - wait_timer + wait_timer: + "$ref": "#/components/schemas/wait-timer" + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + examples: + - 3755 + node_id: + type: string + examples: + - MDQ6R2F0ZTM3NTU= + prevent_self_review: + type: boolean + description: Whether deployments to this environment can be approved + by the user who created the deployment. + examples: + - false + type: + type: string + examples: + - 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 + examples: + - 3515 + node_id: + type: string + examples: + - MDQ6R2F0ZTM1MTU= + type: + type: string + examples: + - 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 + description: Whether or not a user who created the job is prevented from approving + their own job. + examples: + - false + 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 + examples: + - 361471 + node_id: + type: string + examples: + - MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: + description: The name pattern that branches or tags must match in order + to deploy to the environment. + type: string + examples: + - release/* + type: + description: Whether this rule targets a branch or tag. + type: string + enum: + - branch + - tag + examples: + - branch + 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 + examples: + - release/* + type: + description: Whether this rule targets a branch or tag + type: string + enum: + - branch + - tag + examples: + - branch + 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 + examples: + - 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 + description: The unique identifier of the deployment protection rule integration. + examples: + - 3515 + slug: + type: string + description: The slugified name of the deployment protection rule integration. + examples: + - my-custom-app + integration_url: + type: string + description: The URL for the endpoint to get details about the app. + examples: + - https://api.github.com/apps/custom-app-slug + node_id: + type: string + description: The node ID for the deployment protection rule integration. + examples: + - MDQ6R2F0ZTM1MTU= + required: + - id + - slug + - integration_url + - node_id + deployment-protection-rule: + title: Deployment protection rule + description: Deployment protection rule + type: object + properties: + id: + type: integer + description: The unique identifier for the deployment protection rule. + examples: + - 3515 + node_id: + type: string + description: The node ID for the deployment protection rule. + examples: + - MDQ6R2F0ZTM1MTU= + enabled: + type: boolean + description: Whether the deployment protection rule is enabled for the environment. + examples: + - true + 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 + - 'null' + 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 + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + tree: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + - 'null' + payload: + type: + - string + - 'null' + required: + - verified + - reason + - signature + - payload + 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 + type: string + minLength: 40 + maxLength: 40 + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + examples: + - MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: + description: Name of the tag + type: string + examples: + - v0.0.1 + sha: + type: string + examples: + - 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: + description: URL for the tag + type: string + format: uri + examples: + - https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + message: + description: Message describing the purpose of the tag + type: string + examples: + - Initial public release + 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 + properties: + path: + type: string + examples: + - test/file.rb + mode: + type: string + examples: + - '040000' + type: + type: string + examples: + - tree + sha: + type: string + examples: + - 23f6827669e43831def8a7ad935069c8bd418261 + size: + type: integer + examples: + - 12 + url: + type: string + examples: + - https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 + examples: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + properties: + path: + type: string + mode: + type: string + type: + type: string + size: + type: integer + sha: + type: string + url: + type: string + required: + - path + - mode + - type + - sha + - url + - size + required: + - sha + - url + - tree + - truncated + hook-response: + title: Hook Response + type: object + properties: + code: + type: + - integer + - 'null' + status: + type: + - string + - 'null' + message: + type: + - string + - 'null' + required: + - code + - status + - message + hook: + title: Webhook + description: Webhooks for repositories. + type: object + properties: + type: + type: string + id: + description: Unique identifier of the webhook. + type: integer + examples: + - 42 + name: + description: The name of a valid service, use 'web' for a webhook. + type: string + examples: + - web + active: + description: Determines whether the hook is actually triggered on pushes. + type: boolean + examples: + - true + events: + description: 'Determines what events the hook is triggered for. Default: + [''push''].' + type: array + items: + type: string + examples: + - push + - pull_request + config: + "$ref": "#/components/schemas/webhook-config" + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1 + test_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1/test + ping_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + deliveries_url: + type: string + format: uri + examples: + - 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 + 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. + type: integer + format: int64 + examples: + - 42 + repository: + "$ref": "#/components/schemas/minimal-repository" + invitee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + inviter: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + permissions: + description: The permission associated with the invitation. + type: string + enum: + - read + - write + - admin + - triage + - maintain + examples: + - read + created_at: + type: string + format: date-time + examples: + - '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 + type: string + examples: + - https://api.github.com/user/repository-invitations/1 + html_url: + type: string + examples: + - https://github.com/octocat/Hello-World/invitations + node_id: + type: string + required: + - id + - node_id + - permissions + - inviter + - invitee + - repository + - url + - html_url + - created_at + issue-event-label: + title: Issue Event Label + description: Issue Event Label + type: object + properties: + name: + type: + - string + - 'null' + color: + type: + - string + - 'null' + 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 + - 'null' + dismissal_commit_id: + type: + - string + - 'null' + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDEwOklzc3VlRXZlbnQx + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + event: + type: string + examples: + - closed + commit_id: + type: + - string + - 'null' + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: + type: + - string + - 'null' + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue" + label: + "$ref": "#/components/schemas/issue-event-label" + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assigner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + review_requester: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + requested_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + type: + - string + - 'null' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + lock_reason: + type: + - string + - 'null' + examples: + - '"off-topic"' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + 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" + 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 + examples: + - 208045946 + node_id: + type: string + examples: + - MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + type: string + format: uri + examples: + - https://api.github.com/repositories/42/labels/bug + name: + description: The name of the label. + type: string + examples: + - bug + description: + description: Optional description of the label, such as its purpose. + type: + - string + - 'null' + examples: + - Something isn't working + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + examples: + - FFFFFF + default: + description: Whether this label comes by default in a new repository. + type: boolean + examples: + - true + required: + - id + - node_id + - url + - name + - description + - color + - default + 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 + type: integer + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + 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 + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + 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 + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + tree: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + - 'null' + payload: + type: + - string + - 'null' + required: + - verified + - reason + - signature + - payload + 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 + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: + - string + - 'null' + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - 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. + type: string + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + 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 + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + format: int64 + examples: + - 42 + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + examples: + - 1 + node_id: + description: The node ID of the pull request review comment. + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + description: The relative path of the file to which the comment applies. + type: string + examples: + - config/database.yaml + position: + description: The line index in the diff to which the comment applies. This + field is closing down; use `line` instead. + type: integer + examples: + - 1 + 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. + type: integer + examples: + - 4 + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + description: The SHA of the original commit to which the comment applies. + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + description: The comment ID to reply to. + type: integer + examples: + - 8 + user: + "$ref": "#/components/schemas/simple-user" + body: + description: The text of the comment. + type: string + examples: + - We should probably include a check for null values here. + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + examples: + - 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 + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: + - integer + - 'null' + description: The first line of the range for a multi-line comment. + examples: + - 2 + original_start_line: + type: + - integer + - 'null' + description: The first line of the range for a multi-line comment. + examples: + - 2 + start_side: + type: + - string + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + 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 + examples: + - 2 + 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 + examples: + - 2 + 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 + examples: + - '"

comment body

"' + body_text: + type: string + examples: + - '"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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + state_reason: + type: + - string + - 'null' + 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 + - 'null' + last_used: + type: + - string + - 'null' + 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 + - 'null' + format: uri + git_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + examples: + - approved + description: + type: string + examples: + - Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + examples: + - 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 + examples: + - https://api.github.com/repos/github/hello-world/pages + status: + type: + - string + - 'null' + description: The status of the most recent build of the Page. + enum: + - built + - building + - errored + - + examples: + - built + cname: + description: The Pages site's custom domain + type: + - string + - 'null' + examples: + - example.com + protected_domain_state: + type: + - string + - 'null' + description: The state if the domain is verified + enum: + - pending + - verified + - unverified + - + examples: + - pending + pending_domain_unverified_at: + type: + - string + - 'null' + description: The timestamp when a pending domain becomes unverified. + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + default: false + examples: + - false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + examples: + - https://example.com + build_type: + type: + - string + - 'null' + description: The process in which the Page will be built. + enum: + - legacy + - workflow + - + examples: + - legacy + 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. + examples: + - true + https_certificate: + "$ref": "#/components/schemas/pages-https-certificate" + https_enforced: + type: boolean + description: Whether https is enabled on the domain + examples: + - 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 + - 'null' + required: + - message + pusher: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + examples: + - 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 + examples: + - 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 + examples: + - hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + examples: + - 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 + repository-pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + configuration_url: + type: string + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + type: integer + examples: + - 42 + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + description: The title of the pull request. + type: string + examples: + - Amazing new feature + user: + "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + 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 + - 'null' + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + 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. + type: boolean + examples: + - false + merged: + type: boolean + mergeable: + type: + - boolean + - 'null' + examples: + - true + rebaseable: + type: + - boolean + - 'null' + examples: + - true + mergeable_state: + type: string + examples: + - clean + merged_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments: + type: integer + examples: + - 10 + review_comments: + type: integer + examples: + - 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + examples: + - true + commits: + type: integer + examples: + - 3 + additions: + type: integer + examples: + - 100 + deletions: + type: integer + examples: + - 3 + changed_files: + type: integer + examples: + - 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 + 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 + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: string + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - 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`. + type: + - string + - 'null' + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: + - integer + - 'null' + format: int64 + examples: + - 42 + id: + type: integer + format: int64 + examples: + - 10 + node_id: + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + type: string + examples: + - file1.txt + position: + type: + - integer + - 'null' + examples: + - 1 + original_position: + type: integer + examples: + - 4 + commit_id: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + examples: + - 8 + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: string + examples: + - Great stuff + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + examples: + - 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 + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + 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 + examples: + - 2 + 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 + type: integer + examples: + - 2 + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + original_start_line: + description: The original first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + 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-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 + examples: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - 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 + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + created_at: + type: string + format: date-time + published_at: + type: + - string + - 'null' + 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 + 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-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 + examples: + - 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-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-workflows" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + 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/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + secret-scanning-alert-resolution-comment: + description: An optional comment when closing an alert. Cannot be updated or + deleted. Must be `null` when changing `state` to `open`. + type: + - string + - 'null' + 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 + examples: + - "/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 + examples: + - 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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + 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 + examples: + - "/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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + 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. + examples: + - 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" + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + items: + type: integer + examples: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + total: + type: integer + examples: + - 89 + week: + type: integer + examples: + - 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + total: + type: integer + examples: + - 135 + weeks: + type: array + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + examples: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + 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 + examples: + - true + ignored: + description: Determines if all notifications should be blocked from this + repository. + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: string + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + examples: + - 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 + examples: + - v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + tag-protection: + title: Tag protection + description: Tag protection + type: object + properties: + id: + type: integer + examples: + - 2 + created_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + enabled: + type: boolean + examples: + - true + pattern: + type: string + examples: + - v1.* + required: + - pattern + 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 + group-response: + type: object + required: + - schemas + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:Group + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: + type: + - string + - 'null' + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: + type: + - string + - 'null' + description: A human-readable name for a security group. + examples: + - Engineering + members: + type: array + description: The group members. + items: + type: object + required: + - value + - "$ref" + properties: + value: + type: string + description: The local unique identifier for the member + examples: + - 23a35c27-23d3-4c03-b4c5-6443c09e7173 + "$ref": + type: string + display: + type: string + description: The display name associated with the member + examples: + - Monalisa Octocat + meta: + type: object + description: The metadata associated with the creation/updates to the user. + required: + - resourceType + properties: + resourceType: + type: string + description: A type of a resource + enum: + - User + - Group + examples: + - User + created: + type: string + description: A date and time when the user was created. + examples: + - '2022-03-27T19:59:26.000Z' + lastModified: + type: string + description: A data and time when the user was last modified. + examples: + - '2022-03-27T19:59:26.000Z' + location: + type: string + description: A URL location of an object + scim-enterprise-group-response: + allOf: + - "$ref": "#/components/schemas/group-response" + - type: object + properties: + id: + type: string + description: The internally generated id for the group object. + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + description: The security group members. + examples: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + "$ref": "#/components/schemas/meta" + scim-enterprise-group-list: + type: object + required: + - schemas + - totalResults + - Resources + - startIndex + - itemsPerPage + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the list + SCIM schemas. + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: + type: integer + description: Number of results found + examples: + - 1 + Resources: + type: array + description: Information about each provisioned group. + items: + "$ref": "#/components/schemas/scim-enterprise-group-response" + startIndex: + type: integer + description: A starting index for the returned page + examples: + - 1 + itemsPerPage: + type: integer + description: Number of objects per page + examples: + - 20 + group: + type: object + required: + - schemas + - externalId + - displayName + - members + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:Group + examples: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: + type: string + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: + type: string + description: A human-readable name for a security group. + examples: + - Engineering + members: + type: array + description: The group members. + items: + type: object + required: + - value + - displayName + properties: + value: + type: string + description: The local unique identifier for the member + examples: + - 23a35c27-23d3-4c03-b4c5-6443c09e7173 + displayName: + type: string + description: The display name associated with the member + examples: + - Monalisa Octocat + patch-schema: + type: object + required: + - Operations + - schemas + properties: + Operations: + type: array + description: patch operations list + items: + type: object + required: + - op + properties: + op: + type: string + enum: + - add + - replace + - remove + path: + type: string + value: + type: string + description: Corresponding 'value' of that field specified by 'path' + schemas: + type: array + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + user-name-response: + type: object + properties: + formatted: + type: string + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + examples: + - Ms. Mona Lisa Octocat + familyName: + type: string + description: The family name of the user. + examples: + - Octocat + givenName: + type: string + description: The given name of the user. + examples: + - Mona + middleName: + type: string + description: The middle name(s) of the user. + examples: + - Lisa + user-emails-response: + type: array + description: The emails for the user. + items: + type: object + required: + - value + properties: + value: + type: string + description: The email address. + examples: + - mlisa@example.com + type: + type: string + description: The type of email address. + examples: + - work + primary: + type: boolean + description: Whether this email address is the primary address. + examples: + - true + user-role: + type: array + description: The roles assigned to the user. + items: + type: object + required: + - value + properties: + display: + type: string + type: + type: string + value: + type: string + description: The role value representing a user role in GitHub. + enum: + - user + - 27d9891d-2c17-4f45-a262-781a0e55c80a + - guest_collaborator + - 1ebc4a02-e56c-43a6-92a5-02ee09b90824 + - enterprise_owner + - 981df190-8801-4618-a08a-d91f6206c954 + - ba4987ab-a1c3-412a-b58c-360fc407cb10 + - billing_manager + - 0e338b8c-cc7f-498a-928d-ea3470d7e7e3 + - e6be2762-e4ad-4108-b72d-1bbe884a0f91 + examples: + - user + primary: + type: boolean + description: Is the role a primary role for the user. + examples: + - false + user-response: + type: object + required: + - schemas + - active + - emails + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:User + examples: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: + type: + - string + - 'null' + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - E012345 + active: + type: boolean + description: Whether the user active in the IdP. + examples: + - true + userName: + type: string + description: The username for the user. + examples: + - E012345 + name: + "$ref": "#/components/schemas/user-name-response" + displayName: + type: + - string + - 'null' + description: A human-readable name for the user. + examples: + - Mona Lisa + emails: + "$ref": "#/components/schemas/user-emails-response" + roles: + "$ref": "#/components/schemas/user-role" + scim-enterprise-user-response: + allOf: + - "$ref": "#/components/schemas/user-response" + - type: object + required: + - id + - meta + properties: + id: + type: string + description: The internally generated id for the user object. + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + groups: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + description: Provisioned SCIM groups that the user is a member of. + meta: + "$ref": "#/components/schemas/meta" + scim-enterprise-user-list: + type: object + required: + - schemas + - totalResults + - Resources + - startIndex + - itemsPerPage + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the list + SCIM schemas. + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: + type: integer + description: Number of results found + examples: + - 1 + Resources: + type: array + description: Information about each provisioned account. + items: + "$ref": "#/components/schemas/scim-enterprise-user-response" + startIndex: + type: integer + description: A starting index for the returned page + examples: + - 1 + itemsPerPage: + type: integer + description: Number of objects per page + examples: + - 20 + user-name: + type: object + required: + - familyName + - givenName + properties: + formatted: + type: string + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + examples: + - Ms. Mona Lisa Octocat + familyName: + type: string + description: The family name of the user. + examples: + - Octocat + givenName: + type: string + description: The given name of the user. + examples: + - Mona + middleName: + type: string + description: The middle name(s) of the user. + examples: + - Lisa + user-emails: + type: array + description: The emails for the user. + items: + type: object + required: + - value + - type + - primary + properties: + value: + type: string + description: The email address. + examples: + - mlisa@example.com + type: + type: string + description: The type of email address. + examples: + - work + primary: + type: boolean + description: Whether this email address is the primary address. + examples: + - true + user: + type: object + required: + - schemas + - externalId + - userName + - active + - displayName + - emails + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:User + examples: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: + type: string + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - E012345 + active: + type: boolean + description: Whether the user active in the IdP. + examples: + - true + userName: + type: string + description: The username for the user. + examples: + - E012345 + name: + "$ref": "#/components/schemas/user-name" + displayName: + type: string + description: A human-readable name for the user. + examples: + - Mona Lisa + emails: + "$ref": "#/components/schemas/user-emails" + roles: + "$ref": "#/components/schemas/user-role" + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + type: + - string + - 'null' + 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 + - 'null' + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + examples: + - 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + 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 + state: + type: string + state_reason: + type: + - string + - 'null' + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: + - string + - 'null' + format: date-time + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + 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 + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + 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 + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: + - string + - 'null' + 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 + - 'null' + format: uri + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 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 + - 'null' + short_description: + type: + - string + - 'null' + description: + type: + - string + - 'null' + created_by: + type: + - string + - 'null' + released: + type: + - string + - 'null' + 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 + - 'null' + logo_url: + type: + - string + - 'null' + format: uri + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + related: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + bio: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + location: + type: + - string + - 'null' + site_admin: + type: boolean + hireable: + type: + - boolean + - 'null' + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + blog: + type: + - string + - 'null' + company: + type: + - string + - 'null' + suspended_at: + type: + - string + - 'null' + format: date-time + 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 + configuration-status: + type: object + properties: + status: + type: string + progress: + type: array + items: + type: object + properties: + status: + type: string + key: + type: string + required: + - status + - key + maintenance-status: + type: object + properties: + status: + type: string + scheduled_time: + type: string + connection_services: + type: array + items: + type: object + properties: + name: + type: string + number: + type: integer + required: + - name + - number + enterprise-settings: + type: object + properties: + enterprise: + type: object + properties: + private_mode: + type: boolean + public_pages: + type: boolean + subdomain_isolation: + type: boolean + signup_enabled: + type: boolean + github_hostname: + type: string + identicons_host: + type: string + http_proxy: + type: + - string + - 'null' + auth_mode: + type: string + expire_sessions: + type: boolean + admin_password: + type: + - string + - 'null' + configuration_id: + type: integer + configuration_run_count: + type: integer + avatar: + type: object + properties: + enabled: + type: boolean + uri: + type: string + customer: + type: object + properties: + name: + type: string + email: + type: string + uuid: + type: string + secret_key_data: + type: string + public_key_data: + type: string + license: + type: object + properties: + seats: + type: integer + evaluation: + type: boolean + perpetual: + type: boolean + unlimited_seating: + type: boolean + support_key: + type: string + ssh_allowed: + type: boolean + cluster_support: + type: boolean + expire_at: + type: string + github_ssl: + type: object + properties: + enabled: + type: boolean + cert: + type: + - string + - 'null' + key: + type: + - string + - 'null' + ldap: + type: object + properties: + host: + type: + - string + - 'null' + port: + type: integer + base: + type: array + items: {} + uid: + type: + - string + - 'null' + bind_dn: + type: + - string + - 'null' + password: + type: + - string + - 'null' + method: + type: string + search_strategy: + type: string + user_groups: + type: array + items: {} + admin_group: + type: + - string + - 'null' + virtual_attribute_enabled: + type: boolean + recursive_group_search: + type: boolean + posix_support: + type: boolean + user_sync_emails: + type: boolean + user_sync_keys: + type: boolean + user_sync_interval: + type: integer + team_sync_interval: + type: integer + sync_enabled: + type: boolean + reconciliation: + type: object + properties: + user: + type: + - string + - 'null' + org: + type: + - string + - 'null' + profile: + type: object + properties: + uid: + type: string + name: + type: + - string + - 'null' + mail: + type: + - string + - 'null' + key: + type: + - string + - 'null' + cas: + type: object + properties: + url: + type: + - string + - 'null' + saml: + type: object + properties: + sso_url: + type: + - string + - 'null' + certificate: + type: + - string + - 'null' + certificate_path: + type: + - string + - 'null' + issuer: + type: + - string + - 'null' + idp_initiated_sso: + type: boolean + disable_admin_demote: + type: boolean + github_oauth: + type: object + properties: + client_id: + type: string + client_secret: + type: string + organization_name: + type: string + organization_team: + type: string + smtp: + type: object + properties: + enabled: + type: boolean + address: + type: string + authentication: + type: string + port: + type: string + domain: + type: string + username: + type: string + user_name: + type: string + enable_starttls_auto: + type: boolean + password: + type: string + discard-to-noreply-address: + type: boolean + support_address: + type: string + support_address_type: + type: string + noreply_address: + type: string + ntp: + type: object + properties: + primary_server: + type: string + secondary_server: + type: string + timezone: + type: + - string + - 'null' + snmp: + type: object + properties: + enabled: + type: boolean + community: + type: string + syslog: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + protocol_name: + type: string + assets: + type: + - string + - 'null' + pages: + type: object + properties: + enabled: + type: boolean + collectd: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + port: + type: integer + encryption: + type: + - string + - 'null' + username: + type: + - string + - 'null' + password: + type: + - string + - 'null' + mapping: + type: object + properties: + enabled: + type: boolean + tileserver: + type: + - string + - 'null' + basemap: + type: string + token: + type: + - string + - 'null' + load_balancer: + type: + - string + - 'null' + run_list: + type: array + items: + type: string + ssh-key: + type: object + properties: + key: + type: string + pretty-print: + type: string + private-user: + title: Private User + description: Private User + type: object + properties: + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + user_view_type: + type: string + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + notification_email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - 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 + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + examples: + - octocat@github.com + primary: + type: boolean + examples: + - true + verified: + type: boolean + examples: + - true + visibility: + type: + - string + - 'null' + examples: + - public + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + format: int64 + examples: + - 3 + name: + type: + - string + - 'null' + examples: + - Octocat's GPG Key + primary_key_id: + type: + - integer + - 'null' + key_id: + type: string + examples: + - 3262EFF25BA0D270 + public_key: + type: string + examples: + - xsBNBFayYZ... + emails: + type: array + items: + type: object + properties: + email: + type: string + verified: + type: boolean + examples: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + type: array + 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 + - 'null' + raw_key: + type: + - string + - 'null' + revoked: + type: boolean + examples: + - 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 + can_sign: + type: boolean + examples: + - true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + examples: + - true + created_at: + type: string + format: date-time + examples: + - '2016-03-24T11:31:04-06:00' + expires_at: + type: + - string + - 'null' + format: date-time + revoked: + type: boolean + examples: + - true + raw_key: + type: + - string + - 'null' + 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 + 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 + examples: + - linkedin + url: + type: string + examples: + - 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 + required: + - key + - id + enterprise-webhooks: + 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/enterprise-server@3.14/admin/overview/about-enterprise-accounts)." + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '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 + for and sent to a GitHub App. For more information, + see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.14/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 + examples: + - 1 + node_id: + description: The global node ID of the installation. + type: string + examples: + - 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 + organization, or when the event occurs from activity in a repository owned by an organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + 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 + when the event occurs from activity in a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - 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 + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + template_repository: + type: + - object + - 'null' + 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 + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - '"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 + webhooks_rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/enterprise-server@3.14/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 + 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 + exemption-request-push-ruleset-bypass: + title: Push ruleset bypass exemption request data + description: Push rules that are being requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - push_ruleset_bypass + data: + type: array + description: The data pertaining to the push rules that are being requested + to be bypassed. + items: + type: object + properties: + ruleset_id: + type: integer + description: The ID of the ruleset for the rules that were violated + ruleset_name: + type: string + description: The name of the ruleset for the rules that were violated + total_violations: + type: integer + description: The number of violations + rule_type: + type: string + description: The type of rule that was violated + exemption-request-secret-scanning: + title: Secret scanning push protection exemption request data + description: Secret scanning push protections that are being requested to be + bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - secret_scanning + data: + type: array + description: The data pertaining to the secret scanning push protections + that are being requested to be bypassed. + items: + type: object + properties: + secret_type: + type: string + description: The type of secret that was detected + locations: + type: array + description: The location data of the secret that was detected + items: + type: object + properties: + commit: + type: string + description: The commit SHA where the secret was detected + branch: + type: string + description: The branch where the secret was detected + path: + type: string + description: The path of the file where the secret was detected + exemption-request-secret-scanning-metadata: + title: Secret Scanning Push Protection Exemption Request Metadata + description: Metadata for a secret scanning push protection exemption request. + type: object + properties: + label: + type: string + description: The label for the secret type + reason: + type: string + description: The reason for the exemption request + enum: + - fixed_later + - false_positive + - tests + exemption-response: + title: Exemption response + description: A response to an exemption request by a delegated bypasser. + type: object + properties: + id: + type: integer + description: The ID of the exemption response. + reviewer_id: + type: integer + description: The ID of the user who reviewed the exemption request. + reviewer_login: + type: string + description: The login of the user who reviewed the exemption request. + status: + type: string + description: The status of the exemption response. + enum: + - approved + - rejected + - dismissed + reviewer_comment: + type: + - string + - 'null' + description: The comment the reviewer provided when responding to the exemption + request. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + exemption-request: + title: Exemption Request + description: A request from a user to be exempted from a set of rules. + type: object + properties: + id: + type: integer + description: The ID of the exemption request. + number: + type: integer + description: The number uniquely identifying the exemption request within + it's repository. + repository_id: + type: integer + description: The ID of the repository the exemption request is for. + requester_id: + type: integer + description: The ID of the user who requested the exemption. + requester_login: + type: string + description: The login of the user who requested the exemption. + request_type: + type: string + description: The type of request. + enum: + - push_ruleset_bypass + - secret_scanning + exemption_request_data: + oneOf: + - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + - "$ref": "#/components/schemas/exemption-request-secret-scanning" + resource_identifier: + type: string + description: The unique identifier for the request type of the exemption + request. For example, a commit SHA. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + status: + type: string + description: The status of the exemption request. + enum: + - pending + - rejected + - cancelled + - completed + requester_comment: + type: + - string + - 'null' + description: The comment the requester provided when creating the exemption + request. + metadata: + type: + - object + - 'null' + description: Metadata about the exemption request. + oneOf: + - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + expires_at: + type: string + format: date-time + description: The date and time the exemption request will expire. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + responses: + type: + - array + - 'null' + description: The responses to the exemption request. + items: + "$ref": "#/components/schemas/exemption-response" + html_url: + type: string + description: The URL to view the exemption request in a browser. + format: uri + examples: + - https://github.com/monalisa/smile/exemptions/1 + simple-check-suite: + description: A suite of checks performed on the code of a given code change + type: object + properties: + after: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + app: + "$ref": "#/components/schemas/integration" + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - stale + - startup_failure + - + examples: + - neutral + created_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + repository: + "$ref": "#/components/schemas/minimal-repository" + status: + type: string + enum: + - queued + - in_progress + - completed + - pending + - waiting + examples: + - completed + updated_at: + type: string + format: date-time + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + check-run-with-simple-check-suite: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + check_suite: + "$ref": "#/components/schemas/simple-check-suite" + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + conclusion: + type: + - string + - 'null' + enum: + - waiting + - pending + - startup_failure + - stale + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + deployment: + "$ref": "#/components/schemas/deployment-simple" + details_url: + type: string + examples: + - https://example.com + external_id: + type: string + examples: + - '42' + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + html_url: + type: string + examples: + - https://github.com/github/hello-world/runs/4 + id: + description: The id of the check. + type: integer + examples: + - 21 + name: + description: The name of the check. + type: string + examples: + - test-coverage + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + output: + type: object + properties: + annotations_count: + type: integer + annotations_url: + type: string + format: uri + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + title: + type: + - string + - 'null' + required: + - title + - summary + - text + - annotations_count + - annotations_url + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + started_at: + type: string + format: date-time + examples: + - '2018-05-04T01:14:52Z' + status: + description: The phase of the lifecycle that the check is currently in. + type: string + enum: + - queued + - in_progress + - completed + - pending + examples: + - queued + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + 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/enterprise-server@3.14/rest/git/refs#get-a-reference) + resource. + type: string + webhooks_deploy_key: + description: The [`deploy key`](https://docs.github.com/enterprise-server@3.14/rest/deploy-keys/deploy-keys#get-a-deploy-key) + resource. + type: object + properties: + added_by: + type: + - string + - 'null' + created_at: + type: string + id: + type: integer + key: + type: string + last_used: + type: + - string + - 'null' + read_only: + type: boolean + title: + type: string + url: + type: string + format: uri + verified: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + webhooks_workflow: + title: Workflow + type: + - object + - 'null' + 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 + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: + type: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + answer_chosen_at: + type: + - string + - 'null' + answer_chosen_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + type: + - string + - 'null' + enum: + - resolved + - outdated + - duplicate + - reopened + - + examples: + - resolved + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - author_association + - active_lock_reason + - 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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/enterprise-server@3.14/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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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_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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - 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 + 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 + required: + - name + - id + webhooks_milestone_3: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + state: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + repositories: + type: + - array + - 'null' + 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 + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + description: Date and time when the associated fine-grained personal access + token was last used for authentication. + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + node_id: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: + type: + - string + - 'null' + public: + type: boolean + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + number: + type: integer + short_description: + type: + - string + - 'null' + deleted_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + deleted_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + webhooks_project_changes: + type: object + properties: + archived_at: + type: object + properties: + from: + type: + - string + - 'null' + format: date-time + to: + type: + - string + - 'null' + format: date-time + 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: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + 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 + name: + type: string + color: + type: + - string + - 'null' + description: + type: + - string + - 'null' + 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 + title: + type: string + duration: + type: + - number + - 'null' + start_date: + type: + - string + - 'null' + required: + - id + - title + 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. + - `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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + webhooks_review_comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + webhooks_release: + title: Release + description: The [release](https://docs.github.com/enterprise-server@3.14/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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - content_type + - size + - download_count + - created_at + - updated_at + assets_url: + type: string + format: uri + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: uri + required: + - url + - assets_url + - upload_url + - html_url + - id + - node_id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + - assets + - tarball_url + - zipball_url + - body + webhooks_release_1: + title: Release + description: The [release](https://docs.github.com/enterprise-server@3.14/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 + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + 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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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: + - open + secret-scanning-alert-resolution-webhook: + type: + - string + - 'null' + description: The reason for resolving the alert. + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + 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/enterprise-server@3.14/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - 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 + 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 + 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 + - 'null' + 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 + - 'null' + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + linear_history_requirement_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + 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 + - 'null' + 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-exemption-request-cancelled: + title: Exemption request cancellation 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - sender + webhook-exemption-request-completed: + title: Exemption request 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - sender + webhook-exemption-request-created: + title: Exemption request 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - sender + webhook-exemption-request-response-dismissed: + title: Exemption response dismissed event + type: object + properties: + action: + type: string + enum: + - response_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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - exemption_response + - sender + webhook-exemption-request-response-submitted: + title: Exemption response submitted event + type: object + properties: + action: + type: string + enum: + - response_submitted + 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - exemption_response + - sender + webhook-cache-sync: + type: object + properties: + after: + type: string + before: + type: string + cache_location: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + 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" + required: + - cache_location + - ref + - before + - after + 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" + 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" + 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" + 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" + 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/enterprise-server@3.14/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: The client ID of the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + - 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/enterprise-server@3.14/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: Client ID of the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + 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/enterprise-server@3.14/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: The Client ID for the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + 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: + 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 + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + 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 + - 'null' + 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: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-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 + - 'null' + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + 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: + - 'null' + fixed_at: + type: + - 'null' + 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 + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: + - string + - 'null' + enum: + - open + - dismissed + - + tool: + type: + - object + - 'null' + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + required: + - name + - version + updated_at: + type: + - string + - 'null' + 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-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: + 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 + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + 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 + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + 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 + - 'null' + dismissed_by: + type: + - object + - 'null' + 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 + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + 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: + 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 + - 'null' + 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 + - 'null' + 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: + 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: + - 'null' + dismissed_by: + type: + - 'null' + 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: + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + 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 + - 'null' + 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-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 + - 'null' + 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 + - 'null' + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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-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-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/enterprise-server@3.14/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - 'null' + 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: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + deployment_callback_url: + description: The URL to review the deployment protection rule. + type: string + format: uri + deployment: + "$ref": "#/components/schemas/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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + 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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + completed_at: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - skipped + - + 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/enterprise-server@3.14/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + environment: + type: string + id: + type: integer + node_id: + type: string + original_environment: + type: string + payload: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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/enterprise-server@3.14/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - startup_failure + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - 'null' + 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: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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-enterprise-anonymous-access-disabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_disabled + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + webhook-enterprise-anonymous-access-enabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_enabled + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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: + type: + - 'null' + languages_url: + type: string + license: + type: + - object + - 'null' + merges_url: + type: string + milestones_url: + type: string + mirror_url: + type: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + avatar_url: + type: string + created_at: + type: string + description: + type: + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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/enterprise-server@3.14/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: + anyOf: + - type: 'null' + - "$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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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-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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + type: + - object + - 'null' + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: + - object + - 'null' + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + 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_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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.14/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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-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/enterprise-server@3.14/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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-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-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` + 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: + "$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 + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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-meta-deleted: + title: meta deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + hook: + description: 'The modified 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: + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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-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 + - 'null' + failed_at: + type: + - string + - 'null' + format: date-time + failed_reason: + type: + - string + - 'null' + id: + type: number + invitation_teams_url: + type: string + format: uri + inviter: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + description: + type: + - string + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + namespace: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + labels: + type: + - object + - 'null' + manifest: + type: + - object + - 'null' + 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 + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + type: + - object + - 'null' + bugs: + type: + - object + - 'null' + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + type: + - object + - 'null' + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + namespace: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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/enterprise-server@3.14/rest/pages/pages#list-github-pages-builds) + itself. + type: object + properties: + commit: + type: + - string + - 'null' + created_at: + type: string + duration: + type: integer + error: + type: object + properties: + message: + type: + - string + - 'null' + required: + - message + pusher: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + archived: + description: Whether or not the card is archived + type: boolean + column_id: + type: + - integer + - 'null' + column_url: + type: string + format: uri + content_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + archived: + type: boolean + column_id: + type: integer + column_url: + type: string + created_at: + type: string + creator: + type: + - object + - 'null' + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + to: + type: + - string + - 'null' + public: + type: object + properties: + from: + type: boolean + to: + type: boolean + short_description: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + 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. + 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: + oneOf: + - type: string + - type: integer + - "$ref": "#/components/schemas/projects-v2-single-select-option" + - "$ref": "#/components/schemas/projects-v2-iteration-setting" + type: + - 'null' + - string + - integer + - object + to: + oneOf: + - type: string + - type: integer + - "$ref": "#/components/schemas/projects-v2-single-select-option" + - "$ref": "#/components/schemas/projects-v2-iteration-setting" + type: + - 'null' + - string + - integer + - object + required: + - field_value + - type: object + properties: + body: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + to: + type: + - string + - 'null' + 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-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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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_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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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-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-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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + required: + - action + - thread + - pull_request + - repository + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + required: + - action + - thread + - pull_request + - repository + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + manifest: + type: + - object + - 'null' + 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 + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + bugs: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + 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 + type: + - 'null' + - string + - object + 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 + - 'null' + items: + type: object + properties: + id: + oneOf: + - type: string + - type: object + - type: integer + type: + - 'null' + - string + - object + - integer + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + about_url: + type: string + name: + type: string + type: + type: string + url: + type: string + vendor: + type: string + updated_at: + type: + - string + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + 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 + - 'null' + 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 + 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/enterprise-server@3.14/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 + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + 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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-anonymous-access-disabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_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 + webhook-repository-anonymous-access-enabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_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 + 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 + - 'null' + 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 + - 'null' + required: + - from + homepage: + type: object + properties: + from: + type: + - string + - 'null' + required: + - from + topics: + type: object + properties: + from: + type: + - array + - 'null' + 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-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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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-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-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-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-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 + - 'null' + 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 + - 'null' + 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 + 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 + - 'null' + 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.' + type: + - 'null' + required: + - action + - starred_at + - repository + - sender + webhook-status: + title: status event + type: object + properties: + avatar_url: + type: + - string + - 'null' + 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 + - 'null' + url: + type: + - string + - 'null' + format: uri + required: + - sha + - url + name: + type: string + protected: + type: boolean + required: + - name + - commit + - protected + commit: + type: object + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + verified: + type: boolean + required: + - verified + - reason + - signature + - payload + required: + - author + - committer + - message + - tree + - url + - comment_count + - verification + committer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + updated_at: + type: string + required: + - id + - sha + - name + - target_url + - context + - description + - state + - commit + - branches + - created_at + - updated_at + - repository + - sender + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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-user-created: + 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" + user: + "$ref": "#/components/schemas/webhooks_user" + required: + - action + webhook-user-deleted: + 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" + user: + "$ref": "#/components/schemas/webhooks_user" + required: + - action + 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 + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + format: uri + id: + type: integer + labels: + description: Custom labels for the job. Specified by the [`"runs-on"` + attribute](https://docs.github.com/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + name: + type: string + node_id: + type: string + run_attempt: + type: integer + run_id: + type: integer + run_url: + type: string + runner_group_id: + type: + - number + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - number + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + status: + type: string + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + type: + - object + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - + - 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/enterprise-server@3.14/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - + - cancelled + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - number + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + status: + type: string + enum: + - in_progress + - completed + - queued + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - integer + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + format: date-time + status: + type: string + enum: + - queued + - in_progress + - completed + - waiting + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - integer + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + status: + type: string + enum: + - queued + - in_progress + - completed + - waiting + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: + type: + - object + - 'null' + required: + - url + - id + - number + - head + - base + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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. + examples: + - Simple 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: + type: + - object + - 'null' + required: + - url + - id + - number + - head + - base + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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} + global-hook-items: + value: + - type: Global + id: 1 + name: web + active: true + events: + - organization + - user + config: + url: https://example.com + content_type: json + insecure_ssl: '0' + secret: "********" + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + global-hook: + value: + type: Global + id: 1 + name: web + active: true + events: + - organization + - user + config: + url: https://example.com + content_type: json + insecure_ssl: '0' + secret: "********" + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + global-hook-2: + value: + type: Global + id: 1 + name: web + active: true + events: + - organization + config: + url: https://example.com + content_type: form + insecure_ssl: '0' + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + enterprise-public-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 + last_used: '2020-06-11T22:31:57Z' + user_id: 1 + repository_id: 2 + - key: 9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234 + id: 3 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + last_used: '2020-06-11T22:31:57Z' + user_id: 1 + repository_id: 2 + ldap-mapping-team: + value: + ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com + 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: + ldap-mapping-user: + value: + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: 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 + 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 + pre-receive-environment-items: + value: + - id: 1 + name: Default + image_url: githubenterprise://internal + url: https://github.example.com/api/v3/admin/pre-receive-environments/1 + html_url: https://github.example.com/admin/pre-receive-environments/1 + default_environment: true + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 14 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest + state: not_started + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + - id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-environment: + value: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: not_started + downloaded_at: + message: + pre-receive-environment-default-response: + value: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-environment-download-status-default-response: + value: + url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest + state: not_started + downloaded_at: + message: + pre-receive-environment-download-status: + value: + url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-hook-items: + value: + - id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: false + pre-receive-hook: + value: + id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: false + pre-receive-hook-2: + value: + id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 1 + name: Default + image_url: githubenterprise://internal + url: https://github.example.com/api/v3/admin/pre-receive-environments/1 + html_url: https://github.example.com/admin/pre-receive-environments/1 + default_environment: true + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: true + classic-personal-access-tokens: + value: + - id: 2 + url: https://enterprise.octocat.com/api/v3/authorizations/2 + app: + name: My personal access token + url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens + client_id: '00000000000000000000' + token: ghp_16C7e42F292c6912E7710c838347Ae178B4a + hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 + token_last_eight: Ae178B4a + note: My personal access token + note_url: + created_at: '2019-04-24T21:49:02Z' + updated_at: '2019-04-24T21:49:02Z' + scopes: + - admin:business + - admin:gpg_key + - admin:org + - admin:org_hook + - admin:pre_receive_hook + - admin:public_key + - admin:repo_hook + - delete_repo + - gist + - notifications + - repo + - user + - write:discussion + fingerprint: + 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 + authorization: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + 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: + 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: + 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----- + 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: + 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: + suspended_by: + 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: + suspended_by: + 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: + 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 + application-grant-items: + value: + - id: 1 + url: https://api.github.com/applications/grants/1 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + created_at: '2011-09-06T17:26:27Z' + updated_at: '2011-09-06T20:39:23Z' + scopes: + - public_repo + application-grant: + value: + id: 1 + url: https://api.github.com/applications/grants/1 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + created_at: '2011-09-06T17:26:27Z' + updated_at: '2011-09-06T20:39:23Z' + scopes: + - public_repo + 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: [] + authorization-items: + value: + - id: 2 + url: https://enterprise.octocat.com/api/v3/authorizations/2 + app: + name: My personal access token + url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens + client_id: '00000000000000000000' + token: ghp_16C7e42F292c6912E7710c838347Ae178B4a + hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 + token_last_eight: Ae178B4a + note: My personal access token + note_url: + created_at: '2019-04-24T21:49:02Z' + updated_at: '2019-04-24T21:49:02Z' + scopes: + - admin:business + - admin:gpg_key + - admin:org + - admin:org_hook + - admin:pre_receive_hook + - admin:public_key + - admin:repo_hook + - delete_repo + - gist + - notifications + - repo + - user + - write:discussion + fingerprint: + authorization-response-if-returning-an-existing-token-2: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: '' + authorization-response-if-returning-an-existing-token: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + authorization-3: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2012-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + authorization-2: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + 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/ + 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 + 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 + announcement: + summary: Announcement banner + value: + announcement: Very **important** announcement about _something_. + expires_at: '2021-01-01T00:00:00.000+00:00' + user_dismissible: false + license-info: + value: + seats: 1400 + seats_used: 1316 + seats_available: 84 + kind: standard + days_until_expiration: 365 + expire_at: 2016/02/06 12:41:52 -0600 + enterprise-overview: + value: + repos: + total_repos: 212 + root_repos: 194 + fork_repos: 18 + org_repos: 51 + total_pushes: 3082 + total_wikis: 15 + hooks: + total_hooks: 27 + active_hooks: 23 + inactive_hooks: 4 + pages: + total_pages: 36 + orgs: + total_orgs: 33 + disabled_orgs: 0 + total_teams: 60 + total_team_members: 314 + users: + total_users: 254 + admin_users: 45 + suspended_users: 21 + pulls: + total_pulls: 86 + merged_pulls: 60 + mergeable_pulls: 21 + unmergeable_pulls: 3 + issues: + total_issues: 179 + open_issues: 83 + closed_issues: 96 + milestones: + total_milestones: 7 + open_milestones: 6 + closed_milestones: 1 + gists: + total_gists: 178 + private_gists: 151 + public_gists: 25 + comments: + total_commit_comments: 6 + total_gist_comments: 28 + total_issue_comments: 366 + total_pull_request_comments: 30 + enterprise-security-products-overview: + value: + total_repos: 150 + nonarchived_repos: 130 + secret_scanning_enabled_repos: 150 + secret_scanning_push_protection_enabled_repos: 120 + code_scanning_enabled_repos: 140 + code_scanning_pr_reviews_enabled_repos: 100 + code_scanning_default_setup_enabled_repos: 50 + code_scanning_default_setup_eligible_repos: 30 + dependabot_alerts_enabled_repos: 130 + dependabot_security_updates_enabled_repos: 120 + dependabot_version_updates_enabled_repos: 121 + advanced_security_enabled_repos: 150 + active_committers: 30 + purchased_committers: 90 + maximum_committers: 80 + actions-cache-usage-org-enterprise: + value: + total_active_caches_size_in_bytes: 3344284 + total_active_caches_count: 5 + actions-cache-usage-policy-enterprise: + value: + repo_cache_size_limit_in_gb: 10 + max_repo_cache_size_limit_in_gb: 15 + actions-enterprise-permissions: + value: + enabled_organizations: all + allowed_actions: selected + selected_actions_url: https://api.github.com/enterprises/2/actions/permissions/selected-actions + organization-targets: + value: + total_count: 1 + organizations: + - login: octocat + id: 161335 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + 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-enterprise: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners + allows_public_repositories: false + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners + 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 + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners + 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-enterprise: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + allows_public_repositories: false + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-update-enterprise: + value: + id: 2 + name: Expensive hardware runners + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + 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-paginated: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + 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 + 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-airgap: + value: + - os: osx + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz + filename: actions-runner-osx-x64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b + - os: linux + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz + filename: actions-runner-linux-x64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: 02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98 + - os: linux + architecture: arm + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz + filename: actions-runner-linux-arm-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw + sha256_checksum: 2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85 + - os: win + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip + filename: actions-runner-win-x64-2.277.1.zip + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: 7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30 + - os: linux + architecture: arm64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz + filename: actions-runner-linux-arm64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64 + 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 + 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 + audit-log: + value: + - actor_ip: 88.123.45.123 + from: pull_requests#merge + device_cookie: + actor: mona-admin + actor_id: 7 + repo: octo-org/octo-repo + repo_id: 17 + business: github + business_id: 1 + org: octo-org + org_id: 8 + action: pull_request.merge + "@timestamp": 1635940599755 + created_at: 1635940599755 + operation_type: modify + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: POST + request_id: e4dabc4d-ba16-4bca-1234-649be7ae1188 + server_id: 5d17aab5-fd9f-abcd-a820-16bed246441b + request_category: other + controller_action: merge + url: https://example.com/octo-org/octo-repo/pull/1/merge + client_id: 322299977.1635936 + referrer: https://example.com/octo-org/octo-repo/pull/1 + actor_session: 1 + pull_request_id: 1 + category_type: Resource Management + - actor_ip: 88.123.45.123 + from: pull_request_review_events#create + device_cookie: + actor: mona-admin + actor_id: 7 + business_id: 1 + org_id: 8 + action: pull_request_review.submit + "@timestamp": 1635940593079 + created_at: 1635940593079 + operation_type: modify + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: PUT + request_id: c0f63bb7-17b6-4796-940c-12345c5a581b + server_id: 2abc1234-f651-43e3-9696-e942ad5f8c89 + request_category: other + controller_action: create + url: https://example.com/octo-org/octo-repo/pull/1/reviews + client_id: 322299977.1635936 + referrer: https://example.com/octo-org/octo-repo/pull/1/files + actor_session: 1 + spammy: false + pull_request_id: 1 + body: + allowed: true + id: 1 + state: 40 + issue_id: 1 + review_id: 1 + category_type: Resource Management + - actor_ip: 88.123.45.123 + from: pull_requests#create + device_cookie: + actor: mona + actor_id: 9 + user_id: 9 + repo: octo-org/octo-repo + repo_id: 17 + business: github + business_id: 1 + org: octo-org + org_id: 8 + action: pull_request.create + "@timestamp": 1635940554161 + created_at: 1635940554161 + operation_type: create + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: POST + request_id: 2773abeb-477f-4ebf-a017-f8e8a206c305 + server_id: 796e3115-4ce8-4606-8fd0-99ea57a2e12b + request_category: other + controller_action: create + url: https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1 + client_id: 386351111.163594 + referrer: https://example.com/octo-org/octo-repo/compare/main...mona:patch-1 + actor_session: 2 + pull_request_id: 1 + category_type: Resource Management + 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: + 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 + enterprise-security-analysis-settings: + value: + advanced_security_enabled_for_new_repositories: true + dependabot_alerts_enabled_for_new_repositories: true + secret_scanning_enabled_for_new_repositories: true + secret_scanning_push_protection_enabled_for_new_repositories: true + secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md + 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 + 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: + 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: + 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} + 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 + - number: 1 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 + html_url: https://github.com/owner/repo/security/secret-scanning/1 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations + state: open + resolution: + resolved_at: + resolved_by: + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + 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: + 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 + advanced-security-active-committers: + value: + total_advanced_security_committers: 2 + total_count: 2 + maximum_advanced_security_committers: 4 + purchased_advanced_security_committers: 4 + repositories: + - name: octocat-org/Hello-World + advanced_security_committers: 2 + advanced_security_committers_breakdown: + - user_login: octocat + last_pushed_date: '2021-11-03' + last_pushed_email: octocat@github.com + - user_login: octokitten + last_pushed_date: '2021-10-25' + last_pushed_email: octokitten@github.com + - name: octocat-org/server + advanced_security_committers: 1 + advanced_security_committers_breakdown: + - user_login: octokitten + last_pushed_date: '2021-10-26' + last_pushed_email: octokitten@github.com + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-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 + 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: + 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 + 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 + 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: + 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 + 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: + 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: + 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: + 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 + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + 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: + 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 + 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 + 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 + 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 + 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: |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 + ghes-get-ssh: + value: + - key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ== + fingeprint: bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw== + fingeprint: e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4 + ghes-set-ssh: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: SSH key added successfully + modified: true + ghes-delete-ssh: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: SSH key removed successfully + ghes-checks-system-requirements: + value: + status: OK + nodes: + - hostname: ghe-local-app + status: OK + roles_status: + - status: OK + role: ConsulServer + - status: OK + role: JobServer + - status: OK + role: WebServer + - hostname: ghe-local-app2 + status: OK + roles_status: + - status: OK + role: ConsulServer + - status: OK + role: GitServer + ghes-cluster-status: + value: + status: OK + nodes: + - hostname: ghe-local-app + status: OK + services: + - status: OK + name: es + details: Elasticsearch cluster is in sync (0 shards initializing, 0 shards + unassigned) + - status: OK + name: git-replication + details: Git replication is in sync + - status: OK + name: kafka-lite-admin-healthcheck + details: '' + - status: OK + name: kafka-lite-broker-is-reachable + details: '' + - status: OK + name: memcache + details: '' + - status: OK + name: metrics + details: '' + - status: OK + name: mysql-replication + details: Replication is running + - status: OK + name: mysql-failover + details: '' + - status: OK + name: pages + details: Pages replication is in sync + - status: OK + name: redis + details: Redis is OK + - status: OK + name: storage + details: Storage replication is in sync + - hostname: ghe-local-app2 + status: OK + services: + - status: OK + name: kafka-lite-admin-healthcheck + details: '' + - status: OK + name: kafka-lite-broker-is-reachable + details: '' + ghes-license-info: + value: + - advancedSecurityEnabled: true + advancedSecuritySeats: 0 + clusterSupport: false + company: GitHub + croquetSupport: true + customTerms: true + evaluation: false + expireAt: '2025-01-02T07:59:59Z' + insightsEnabled: true + insightsExpireAt: '2025-01-02T07:59:59.999Z' + learningLabEvaluationExpires: '2023-01-02T07:59:59Z' + learningLabSeats: 100 + perpetual: false + referenceNumber: 32a145 + seats: 0 + sshAllowed: true + supportKey": '' + unlimitedSeating: true + ghes-license-check: + value: + - status: valid + ghes-config-nodes: + value: + topology: Cluster + nodes: + - hostname: data1 + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + cluster_roles: + - ConsulServer + - ElasticsearchServer + - GitServer + - StorageServer + - hostname: data2 + uuid: 228406d4-f97c-11ed-ab01-062281bbcf03 + cluster_roles: + - ElasticsearchServer + - StorageServer + - PagesServer + ghes-get-settings: + value: + private_mode: false + public_pages: false + subdomain_isolation: true + signup_enabled: false + github_hostname: ghe.local + identicons_host: dotcom + http_proxy: + auth_mode: default + expire_sessions: false + admin_password: + configuration_id: 1401777404 + configuration_run_count: 4 + avatar: + enabled: false + uri: '' + customer: + name: GitHub + email: stannis@themannis.biz + uuid: af6cac80-e4e1-012e-d822-1231380e52e9 + secret_key_data: | + -----BEGIN PGP PRIVATE KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + lQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx... + -----END PGP PRIVATE KEY BLOCK----- + public_key_data: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + mI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7.... + -----END PGP PUBLIC KEY BLOCK----- + license: + seats: 0 + evaluation: false + perpetual: false + unlimited_seating: true + support_key: ssh-rsa AAAAB3N.... + ssh_allowed: true + cluster_support: false + expire_at: '2016-04-27T00:00:00-07:00' + github_ssl: + enabled: false + cert: + key: + ldap: + host: + port: 0 + base: [] + uid: + bind_dn: + password: + method: Plain + search_strategy: detect + user_groups: [] + admin_group: + virtual_attribute_enabled: false + recursive_group_search: false + posix_support: true + user_sync_emails: false + user_sync_keys: false + user_sync_interval: 4 + team_sync_interval: 4 + sync_enabled: false + reconciliation: + user: + org: + profile: + uid: uid + name: + mail: + key: + cas: + url: + saml: + sso_url: + certificate: + certificate_path: + issuer: + idp_initiated_sso: false + disable_admin_demote: false + github_oauth: + client_id: '12313412' + client_secret: kj123131132 + organization_name: Homestar Runners + organization_team: homestarrunners/characters + smtp: + enabled: true + address: smtp.example.com + authentication: plain + port: '1234' + domain: blah + username: foo + user_name: mr_foo + enable_starttls_auto: true + password: bar + discard-to-noreply-address: true + support_address: enterprise@github.com + support_address_type: email + noreply_address: noreply@github.com + ntp: + primary_server: 0.pool.ntp.org + secondary_server: 1.pool.ntp.org + timezone: + snmp: + enabled: false + community: '' + syslog: + enabled: false + server: + protocol_name: udp + assets: + pages: + enabled: true + collectd: + enabled: false + server: + port: 0 + encryption: + username: + password: + mapping: + enabled: true + tileserver: + basemap: company.map-qsz2zrvs + token: + load_balancer: + ghes-get-maintenance: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + status: scheduled + scheduled_time: '2006-01-02T15:04:05+00:00' + connection_services: + - name: git operations + number: 15 + - name: mysql queries + number: 6 + - name: resque jobs + number: 10 + - name: aqueduct jobs + number: 0 + can_unset_maintenance: true + ip_exception_list: + - 1.1.1.1 + maintenance_mode_message: Scheduled maintenance for upgrading. + ghes-set-maintenance: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: maintenance mode scheduled with exception list [1.1.1.1] + ghes-replication-status: + value: + status: OK + nodes: + - hostname: ghe-local-primary + status: OK + services: [] + - hostname: ghe-local-replica + status: OK + services: + - status: OK + name: redis + details: replication is in sync + - status: OK + name: elasticsearch + details: cluster is in sync (0 shards initializing, 0 shards unassigned) + - status: OK + name: git + details: replication is in sync + - status: OK + name: pages + details: replication is in sync + - status: OK + name: alambic + details: replication is in sync + - status: OK + name: git-hooks + details: replication is in sync + - status: OK + name: consul + details: replication is in sync + - status: OK + name: mysql + details: replication is in sync + ghes-version: + value: + - hostname: ghe-local-primary + version: + version: 3.9.0 + platform: azure + build_id: fc542058b5 + build_date: '2023-05-02' + api-overview: + value: + verifiable_password_authentication: true + packages: + - 192.0.2.1 + domains: + website: + - "*.example.com" + codespaces: + - "*.example.com" + copilot: + - "*.example.com" + packages: + - "*.example.com" + installed_version: 3.14.0 + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/rrubenich + 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: + 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: |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~~~~ + ~~~~~~==~==~~~==~==~~~~~~ + ~~~~~~==~==~==~==~~~~~~ + :~==~==~==~==~~ + 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-custom-repository-role-example: + value: + id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + 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' + 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 + 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_fork_private_repositories: false + web_commit_signoff_required: false + updated_at: '2014-03-03T18:58:10Z' + 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 + 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 + 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 + 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: + 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 + 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 + 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 + 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: + 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 + 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 + organization-custom-repository-role-list-example: + value: + total_count: 2 + custom_roles: + - id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + 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: Community manager + description: Able to handle all the community interactions without being + able to contribute code + base_role: read + permissions: + - mark_as_duplicate + - manage_settings_pages + - manage_settings_wiki + - set_social_preview + - edit_repo_metadata + - toggle_discussion_comment_minimize + 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-05T12:01:11Z' + updated_at: '2022-07-05T12:20:11Z' + 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' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/oct-repo + payload: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + external-group: + value: + group_id: '123' + group_name: Octocat admins + updated_at: '2021-01-24T11:31:04-06:00' + teams: + - team_id: 1 + team_name: team-test + - team_id: 2 + team_name: team-test2 + members: + - member_id: 1 + member_login: mona-lisa_eocsaxrs + member_name: Mona Lisa + member_email: mona_lisa@github.com + - member_id: 2 + member_login: octo-lisa_eocsaxrs + member_name: Octo Lisa + member_email: octo_lisa@github.com + external-groups: + value: + groups: + - group_id: '123' + group_name: Octocat admins + updated_at: '2021-01-24T11:31:04-06:00' + - group_id: '456' + group_name: Octocat docs members + updated_at: '2021-03-24T11:31:04-06:00' + 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 + 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: + suspended_by: + 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: + suspended_by: + 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 + 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 + 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: + 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= + 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: + 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' + 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: + 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' + 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: + 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 + organization-fine-grained-permission-example: + value: + - name: read_organization_custom_org_role + description: View organization roles + - name: write_organization_custom_org_role + description: Manage custom organization roles + 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' + 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: + 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: + 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: + org-pre-receive-hook-items: + value: + - id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 + allow_downstream_configuration: true + org-pre-receive-hook: + value: + id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 + allow_downstream_configuration: true + org-pre-receive-hook-2: + value: + id: 42 + name: Check Commits + enforcement: enabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + allow_downstream_configuration: false + project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: true + project-2: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + 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 + - 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: + 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 + repository-fine-grained-permission-example: + value: + - name: add_assignee + description: Assign or remove a user + - name: remove_assignee + description: Remove an assigned user + - name: add_label + description: Add or remove a label + 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 + 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 + 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 + 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 + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + team-discussion-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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion: + 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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-2: + 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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 1 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: '2018-01-26T18:22:20Z' + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Welcome to our first team post + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-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 + body: Do you like apples? + body_html: "

Do you like apples?

" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment: + 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 + body: Do you like apples? + body_html: "

Do you like apples?

" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-2: + 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 + body: Do you like pineapples? + body_html: "

Do you like pineapples?

" + body_version: e6907b24d9c93cc0c5024a7af5888116 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: '2018-01-26T18:22:20Z' + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + 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' + 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-project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-project: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + 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: + 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 + project-card: + value: + url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + 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: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-column: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + project-card-items: + value: + - url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + 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: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-3: + value: + owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + project-collaborator-permission: + value: + permission: 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 + project-column-items: + value: + - url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + 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: + 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 + 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' + 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' + 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' + 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-usage-policy: + value: + repo_cache_size_limit_in_gb: 14 + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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 + 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 + 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 + 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: + 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 + 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: + 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: + 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: + 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 + + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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 + fixed_at: + 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 + fixed_at: '2020-02-14T12:29:18Z' + 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: + 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: '' + 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: + version: 2.4.0 + deletable: true + warning: '' + code-scanning-analysis-sarif: + summary: application/json+sarif 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-default-setup: + value: + state: configured + languages: + - ruby + - python + query_suite: default + updated_at: '2023-01-19T11:21:34Z' + schedule: weekly + code-scanning-default-setup-update: + value: + state: configured + 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 + 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: + 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-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: + payload: + 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: + 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 + 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 + 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 @@ + ..... + 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: + 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 + 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 + 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 + 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 + 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: + 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: + _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: + _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: + _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 + 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 + file-commit: + value: + 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 + 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 + 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: + - 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: + 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 + 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: + 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: + 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: + 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: + 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: + - SPDXID: SPDXRef-Package + name: rubygems:rails + versionInfo: 1.0.0 + downloadLocation: NOASSERTION + filesAnalyzed: false + licenseConcluded: NOASSERTION + licenseDeclared: NOASSERTION + 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 + 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: trues + 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 + 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 + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + minimal-repository-items-2: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/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== + 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 + 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 + 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 + 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: + status: unused + message: + 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: + status: unused + message: + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + single_file: 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 + 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: + label: + name: label + color: red + 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: + 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 + deploy-key-items: + value: + enabled: + - 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' + 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' + 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 + 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== + 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: + 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: + 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 + repository-pre-receive-hook-items: + value: + - id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + repository-pre-receive-hook: + value: + id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + repository-pre-receive-hook-2: + value: + id: 42 + name: Check Commits + enforcement: enabled + configuration_url: https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 + project-items-2: + value: + - owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + 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 + 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: + 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: + 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 + 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: + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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' + 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 + - number: 1 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 + html_url: https://github.com/owner/repo/security/secret-scanning/1 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/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 + 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 + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed: false + validity: unknown + 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 + resolution_comment: Example comment + validity: unknown + 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 + 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: + 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: + 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= + tag-protection-items: + value: + - id: 2 + pattern: v1.* + tag-protection: + value: + enabled: true + topic: + value: + names: + - octocat + - atom + - electron + - api + 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: + 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 + 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 + scim-enterprise-group-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + id: 24b28bbb-5fc4-4686-a153-a020debb1155 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + resourceType: Group + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 + startIndex: 1 + itemsPerPage: 20 + scim-enterprise-group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + resourceType: Group + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 + scim-enterprise-user-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + id: 7fce0092-d52e-4f76-b727-3955bd72c939 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + startIndex: 1 + itemsPerPage: 20 + in-user: + summary: User + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + in-user-owner: + summary: Enterprise Owner + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: Enterprise Owner + primary: false + scim-enterprise-user: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 7fce0092-d52e-4f76-b727-3955bd72c939 + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + meta: + resourceType: User + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 + 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: + value: + total_count: 280 + incomplete_results: false + 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 + 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 + configuration-status: + value: + status: running + progress: + - status: DONE + key: Appliance core components + - status: DONE + key: GitHub utilities + - status: DONE + key: GitHub applications + - status: CONFIGURING + key: GitHub services + - status: PENDING + key: Reloading appliance services + maintenance-status: + value: + status: scheduled + scheduled_time: Tuesday, January 22 at 15:34 -0800 + connection_services: + - name: git operations + number: 0 + - name: mysql queries + number: 233 + - name: aqueduct jobs + number: 34 + - name: resque jobs + number: 54 + enterprise-settings: + value: + enterprise: + private_mode: false + public_pages: false + subdomain_isolation: true + signup_enabled: false + github_hostname: ghe.local + identicons_host: dotcom + http_proxy: + auth_mode: default + expire_sessions: false + admin_password: + configuration_id: 1401777404 + configuration_run_count: 4 + avatar: + enabled: false + uri: '' + customer: + name: GitHub + email: stannis@themannis.biz + uuid: af6cac80-e4e1-012e-d822-1231380e52e9 + secret_key_data: | + -----BEGIN PGP PRIVATE KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + + lQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx... + -----END PGP PRIVATE KEY BLOCK----- + public_key_data: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + + mI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7.... + -----END PGP PUBLIC KEY BLOCK----- + license: + seats: 0 + evaluation: false + perpetual: false + unlimited_seating: true + support_key: ssh-rsa AAAAB3N.... + ssh_allowed: true + cluster_support: false + expire_at: '2016-04-27T00:00:00-07:00' + github_ssl: + enabled: false + cert: + key: + ldap: + host: + port: 0 + base: [] + uid: + bind_dn: + password: + method: Plain + search_strategy: detect + user_groups: [] + admin_group: + virtual_attribute_enabled: false + recursive_group_search: false + posix_support: true + user_sync_emails: false + user_sync_keys: false + user_sync_interval: 4 + team_sync_interval: 4 + sync_enabled: false + reconciliation: + user: + org: + profile: + uid: uid + name: + mail: + key: + cas: + url: + saml: + sso_url: + certificate: + certificate_path: + issuer: + idp_initiated_sso: false + disable_admin_demote: false + github_oauth: + client_id: '12313412' + client_secret: kj123131132 + organization_name: Homestar Runners + organization_team: homestarrunners/characters + smtp: + enabled: true + address: smtp.example.com + authentication: plain + port: '1234' + domain: blah + username: foo + user_name: mr_foo + enable_starttls_auto: true + password: bar + discard-to-noreply-address: true + support_address: enterprise@github.com + support_address_type: email + noreply_address: noreply@github.com + ntp: + primary_server: 0.pool.ntp.org + secondary_server: 1.pool.ntp.org + timezone: + snmp: + enabled: false + community: '' + syslog: + enabled: false + server: + protocol_name: udp + assets: + pages: + enabled: true + collectd: + enabled: false + server: + port: 0 + encryption: + username: + password: + mapping: + enabled: true + tileserver: + basemap: company.map-qsz2zrvs + token: + load_balancer: + run_list: + - recipe[enterprise-configure] + ssh-key-items: + value: + - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... + pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... + pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAAB... + pretty-print: ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64 + 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: + 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... + 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... + 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... + 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 + 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-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: + - email: mona@github.com + primary: false + verified: false + visibility: + 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: + 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: + 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 + 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 + 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 + 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 + 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 + 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: + 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= + 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: + 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' + 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 + project: + value: + owner_url: https://api.github.com/users/octocat + url: https://api.github.com/projects/1002603 + html_url: https://github.com/users/octocat/projects/1 + columns_url: https://api.github.com/projects/1002603/columns + id: 1002603 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + name: My Projects + body: A board to manage my personal projects. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + 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 + social-account-items: + value: + - provider: twitter + url: https://twitter.com/github + ssh-signing-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' + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + ssh-signing-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' + 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: + 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 + 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 + 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 + 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 + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: 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: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: false + 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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-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 + project-items-3: + value: + - owner_url: https://api.github.com/users/octocat + url: https://api.github.com/projects/1002603 + html_url: https://github.com/users/octocat/projects/1 + columns_url: https://api.github.com/projects/1002603/columns + id: 1002603 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + name: My Projects + body: A board to manage my personal projects. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + avatar_url: https://avatars.githubusercontent.com/u/9919? + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + avatar_url: https://avatars.githubusercontent.com/u/9919? + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + 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 + secret_type: mailchimp_api_key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + 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 + 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: + 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/enterprise-server@3.14/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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + 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 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + key-ids: + name: key_ids + description: The unique identifier of the key. + 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 + 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 + pre-receive-environment-id: + name: pre_receive_environment_id + description: The unique identifier of the pre-receive environment. + in: path + required: true + schema: + type: integer + pre-receive-hook-id: + name: pre_receive_hook_id + description: The unique identifier of the pre-receive hook. + in: path + required: true + schema: + type: integer + token-id: + name: token_id + description: The unique identifier of the token. + in: path + required: true + schema: + type: integer + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + ghsa_id: + name: ghsa_id + description: The GHSA (GitHub Security Advisory) identifier of the advisory. + in: path + required: true + schema: + type: string + 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 + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + 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 + grant-id: + name: grant_id + description: The unique identifier of the grant. + in: path + required: true + schema: + type: integer + 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 + oauth-client-id: + name: client_id + in: path + required: true + description: The client ID of the OAuth app. + schema: + type: string + examples: + default: + value: abcde12345fghij67890 + authorization-id: + name: authorization_id + description: The unique identifier of the authorization. + in: path + required: true + schema: + type: integer + enterprise: + name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + org-id: + name: org_id + description: The unique identifier of the organization. + in: path + required: true + schema: + type: integer + visible-to-organization: + name: visible_to_organization + description: Only return runner groups that are allowed to be used by this organization. + 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 + audit-log-enterprise-phrase: + name: phrase + description: A search phrase. For more information, see [Searching the audit + log](https://docs.github.com/enterprise-server@3.14/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). + in: query + required: false + schema: + type: string + audit-log-include: + name: include + description: |- + The event types to include: + + - `web` - returns web (non-Git) events. + - `git` - returns Git events. + - `all` - returns both web and Git events. + + The default is `web`. + in: query + required: false + schema: + type: string + enum: + - web + - git + - all + audit-log-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events after this cursor. + in: query + required: false + schema: + type: string + audit-log-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events before this cursor. + in: query + required: false + schema: + type: string + audit-log-order: + name: order + description: |- + The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + + The default is `desc`. + in: query + required: false + schema: + type: string + enum: + - desc + - asc + 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-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-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. + schema: + type: string + enum: + - created + - updated + default: created + pagination-first: + name: first + description: |- + **Deprecated**. The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + Instead, use `per_page` in combination with `after` to fetch the first page of results. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + pagination-last: + name: last + description: |- + **Deprecated**. The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + Instead, use `per_page` in combination with `before` to fetch the last page of results. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + 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. By default all + secret types are returned. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.14/enterprise-cloud@latest/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-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-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-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 + enterprise-security-product: + name: security_product + in: path + description: The security feature to enable or disable. + required: true + schema: + type: string + enum: + - advanced_security + - advanced_security_user_namespace + - dependabot_alerts + - secret_scanning + - secret_scanning_push_protection + enterprise-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 enterprise. + `disable_all` means to disable the specified security feature for all repositories in the enterprise. + required: true + schema: + type: string + enum: + - enable_all + - disable_all + 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 + license-apply: + name: apply + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.14/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. + in: query + required: false + schema: + type: boolean + uuid: + name: uuid + description: The UUID which identifies a node. + in: query + required: false + schema: + type: string + cluster-roles: + name: cluster_roles + description: The cluster roles from the cluster configuration file. + in: query + required: false + 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 + 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/enterprise-server@3.14/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 + 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 + 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/enterprise-server@3.14/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 + audit-log-phrase: + name: phrase + description: A search phrase. For more information, see [Searching the audit + log](https://docs.github.com/enterprise-server@3.14/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). + in: query + required: false + schema: + type: string + role-id: + name: role_id + description: The unique identifier of the role. + in: path + required: true + schema: + type: integer + group-id: + name: group_id + description: The unique identifier of the group. + in: path + required: true + schema: + type: integer + members-per-page: + name: per_page + description: The number of results per page for the "members" array (max 100). + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + members-page: + name: page + description: The page number of the "members" array results to fetch. For more + information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.14/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 + team-slug: + name: team_slug + description: The slug of the team name. + 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/enterprise-server@3.14/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 + examples: + - 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 + examples: + - Hello-World + personal-access-token-permission: + name: permission + description: The permission to use to filter the results. + in: query + required: false + schema: + type: string + examples: + - 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 + 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 + 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 + examples: + - branch,tag,push + ref-in-query: + name: ref + description: The name of the ref. Cannot contain wildcard characters. 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 insights 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 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/enterprise-server@3.14/rest/repos/rule-suites#list-repository-rule-suites) + for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.14/rest/orgs/rule-suites#list-organization-rule-suites) + for organizations. + in: path + required: true + schema: + type: integer + secret-scanning-pagination-before-org-repo: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.14/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/enterprise-server@3.14/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 + discussion-number: + name: discussion_number + description: The number that identifies the discussion. + in: path + required: true + schema: + type: integer + comment-number: + name: comment_number + description: The number that identifies the comment. + in: path + required: true + schema: + type: integer + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer + project-id: + name: project_id + description: The unique identifier of the project. + 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 + card-id: + name: card_id + description: The unique identifier of the card. + in: path + required: true + schema: + type: integer + column-id: + name: column_id + description: The unique identifier of the column. + in: path + required: true + schema: + type: integer + 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/enterprise-server@3.14/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/enterprise-server@3.14/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/enterprise-server@3.14/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" + 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" + 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. + 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" + 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 + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + 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 + 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 + tag-protection-id: + name: tag_protection_id + description: The unique identifier of the tag protection. + in: path + required: true + schema: + type: integer + 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 + excluded-attributes: + name: excludedAttributes + description: Excludes the specified attribute from being returned in the results. + Using this parameter can speed up response time. + in: query + required: false + schema: + type: string + examples: + - members + start-index: + name: startIndex + description: 'Used for pagination: the starting index of the first result to + return when paginating through values.' + in: query + required: false + schema: + type: integer + default: 1 + format: int32 + examples: + - 1 + count: + name: count + description: 'Used for pagination: the number of results to return per page.' + in: query + required: false + schema: + type: integer + default: 30 + format: int32 + examples: + - 1 + scim-group-id: + name: scim_group_id + description: A unique identifier of the SCIM group. + in: path + required: true + schema: + type: string + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + scim-user-id: + name: scim_user_id + description: The unique identifier of the SCIM user. + in: path + required: true + schema: + type: string + 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 + 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 + 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 + 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 + 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: + 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" + gone: + description: Gone + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-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" + 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" + 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 + - 'null' + message: + type: string + documentation_url: + type: string + moved_permanently: + description: Moved permanently + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + conflict: + description: Conflict + 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. + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + no_content: + description: A header with no content is returned. + temporary_redirect: + description: Temporary Redirect + 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_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" + found: + description: Found + dependency_review_forbidden: + description: Response if GitHub Advanced Security is not enabled for this repository + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + unacceptable: + description: Unacceptable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + scim_bad_request: + description: Bad request + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + authorization_failure: + description: Authorization failure + permission_denied: + description: Permission denied + scim_too_many_requests: + description: Too many requests + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + scim_internal_error: + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + duplicate_record_detected: + description: Duplicate record detected diff --git a/etc/specs/GitHubEnterprise-3.15/current.spec.yaml b/etc/specs/GitHubEnterprise-3.15/current.spec.yaml new file mode 100644 index 00000000000..4f8d2901508 --- /dev/null +++ b/etc/specs/GitHubEnterprise-3.15/current.spec.yaml @@ -0,0 +1,218591 @@ +--- +openapi: 3.1.0 +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: ghes + x-github-release: 3.15 +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 GitHub Orgs. +- name: packages + description: Manage packages for authenticated users and organizations. +- name: projects + description: Interact with GitHub Projects. +- 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: Look for stuff 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: scim + description: Provisioning of GitHub organization membership for SCIM-enabled providers. +- name: enterprise-admin + description: Enterprise Administration +- name: oauth-authorizations + description: OAuth Authorizations API +- name: security-advisories + description: Security Advisories API +- name: code-security + description: Endpoints to manage code security using the REST API. +servers: +- url: "{protocol}://{hostname}/api/v3" + variables: + hostname: + description: Self-hosted Enterprise Server hostname + default: HOSTNAME + protocol: + description: Self-hosted Enterprise Server protocol + default: http +externalDocs: + description: GitHub Enterprise Developer Docs + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/rest/meta/meta#github-api-root + "/admin/hooks": + get: + summary: List global webhooks + description: '' + operationId: enterprise-admin/list-global-webhooks + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#list-global-webhooks + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + post: + summary: Create a global webhook + description: '' + operationId: enterprise-admin/create-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#create-a-global-webhook + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook" + 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: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: 'The [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) + that trigger this webhook. A global webhook can be triggered by + `user` and `organization` events. Default: `user` and `organization`.' + 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 + events: + - organization + - user + config: + url: https://example.com/webhook + content_type: json + secret: secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/hooks/{hook_id}": + get: + summary: Get a global webhook + description: '' + operationId: enterprise-admin/get-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#get-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook" + examples: + default: + "$ref": "#/components/examples/global-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + patch: + summary: Update a global webhook + description: Parameters that are not provided will be overwritten with the default + value or removed if no default exists. + operationId: enterprise-admin/update-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#update-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/global-hook-2" + examples: + default: + "$ref": "#/components/examples/global-hook-2" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + config: + type: object + description: Key/value pairs to provide settings for this webhook. + properties: + url: + type: string + description: The URL to which the payloads will be delivered. + content_type: + type: string + description: The media type used to serialize the payloads. + Supported values include `json` and `form`. The default is + `form`. + secret: + type: string + description: If provided, the `secret` will be used as the `key` + to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers) + header. + 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.** + required: + - url + events: + type: array + description: 'The [events](https://docs.github.com/enterprise-server@3.15/webhooks/event-payloads) + that trigger this webhook. A global webhook can be triggered by + `user` and `organization` events. Default: `user` and `organization`.' + 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: + events: + - organization + config: + url: https://example.com/webhook + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + delete: + summary: Delete a global webhook + description: '' + operationId: enterprise-admin/delete-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#delete-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/hooks/{hook_id}/pings": + post: + summary: Ping a global webhook + description: This will trigger a [ping event](https://docs.github.com/enterprise-server@3.15/webhooks/#ping-event) + to be sent to the webhook. + operationId: enterprise-admin/ping-global-webhook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/global-webhooks#ping-a-global-webhook + parameters: + - "$ref": "#/components/parameters/hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: global-webhooks + "/admin/keys": + get: + summary: List public keys + description: '' + operationId: enterprise-admin/list-public-keys + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#list-public-keys + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - accessed + default: created + - name: since + description: Only show public keys accessed after the given time. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/public-key-full" + examples: + default: + "$ref": "#/components/examples/enterprise-public-key-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/keys/{key_ids}": + delete: + summary: Delete a public key + description: '' + operationId: enterprise-admin/delete-public-key + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-a-public-key + parameters: + - "$ref": "#/components/parameters/key-ids" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/ldap/teams/{team_id}/mapping": + patch: + summary: Update LDAP mapping for a team + description: Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) + (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) + must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.15/rest/teams/teams/#create-a-team) + endpoint to create a team with LDAP mapping. + operationId: enterprise-admin/update-ldap-mapping-for-team + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team + parameters: + - "$ref": "#/components/parameters/team-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ldap-mapping-team" + examples: + default: + "$ref": "#/components/examples/ldap-mapping-team" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + 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. + required: + - ldap_dn + examples: + default: + value: + ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/teams/{team_id}/sync": + post: + summary: Sync LDAP mapping for a team + description: Note that this API call does not automatically initiate an LDAP + sync. Rather, if a `201` is returned, the sync job is queued successfully, + and is performed when the instance is ready. + operationId: enterprise-admin/sync-ldap-mapping-for-team + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-team + parameters: + - "$ref": "#/components/parameters/team-id" + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: + status: + type: string + examples: + default: + value: + status: queued + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/users/{username}/mapping": + patch: + summary: Update LDAP mapping for a user + description: '' + operationId: enterprise-admin/update-ldap-mapping-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ldap-mapping-user" + examples: + default: + "$ref": "#/components/examples/ldap-mapping-user" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + 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. + required: + - ldap_dn + examples: + default: + value: + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/ldap/users/{username}/sync": + post: + summary: Sync LDAP mapping for a user + description: Note that this API call does not automatically initiate an LDAP + sync. Rather, if a `201` is returned, the sync job is queued successfully, + and is performed when the instance is ready. + operationId: enterprise-admin/sync-ldap-mapping-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#sync-ldap-mapping-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: + status: + type: string + examples: + default: + value: + status: queued + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: ldap + "/admin/organizations": + post: + summary: Create an organization + description: '' + operationId: enterprise-admin/create-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/orgs#create-an-organization + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-simple" + examples: + default: + "$ref": "#/components/examples/organization-simple" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The organization's username. + admin: + type: string + description: The login of the user who will manage this organization. + profile_name: + type: string + description: The organization's display name. + required: + - login + - admin + examples: + default: + value: + login: github + profile_name: GitHub, Inc. + admin: monalisaoctocat + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: orgs + "/admin/organizations/{org}": + patch: + summary: Update an organization name + description: '' + operationId: enterprise-admin/update-org-name + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/orgs#update-an-organization-name + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Job queued to rename organization. It may take a few + minutes to complete. + url: https:///api/v3/organizations/1 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The organization's new name. + required: + - login + examples: + default: + value: + login: the-new-octocats + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: orgs + "/admin/pre-receive-environments": + get: + summary: List pre-receive environments + description: '' + operationId: enterprise-admin/list-pre-receive-environments + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#list-pre-receive-environments + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + post: + summary: Create a pre-receive environment + description: '' + operationId: enterprise-admin/create-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#create-a-pre-receive-environment + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The new pre-receive environment's name. + image_url: + type: string + description: URL from which to download a tarball of this environment. + required: + - name + - image_url + examples: + default: + value: + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}": + get: + summary: Get a pre-receive environment + description: '' + operationId: enterprise-admin/get-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#get-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + patch: + summary: Update a pre-receive environment + description: You cannot modify the default environment. If you attempt to modify + the default environment, you will receive a `422 Unprocessable Entity` response. + operationId: enterprise-admin/update-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#update-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment" + examples: + default-response: + "$ref": "#/components/examples/pre-receive-environment-default-response" + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Cannot modify or delete the default environment + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: This pre-receive environment's new name. + image_url: + type: string + description: URL from which to download a tarball of this environment. + examples: + default: + value: + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + delete: + summary: Delete a pre-receive environment + description: |- + If you attempt to delete an environment that cannot be deleted, you will receive a `422 Unprocessable Entity` response. + + The possible error messages are: + + * _Cannot modify or delete the default environment_ + * _Cannot delete environment that has hooks_ + * _Cannot delete environment when download is in progress_ + operationId: enterprise-admin/delete-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#delete-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '204': + description: Response + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Cannot modify or delete the default environment + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": + post: + summary: Start a pre-receive environment download + description: |- + Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment. + + If a download cannot be triggered, you will receive a `422 Unprocessable Entity` response. + + The possible error messages are: + + * _Cannot modify or delete the default environment_ + * _Can not start a new download when a download is in progress_ + operationId: enterprise-admin/start-pre-receive-environment-download + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#start-a-pre-receive-environment-download + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment-download-status" + examples: + default-response: + "$ref": "#/components/examples/pre-receive-environment-download-status-default-response" + '422': + description: Client Errors + content: + application/json: + schema: + type: object + properties: + message: + type: string + errors: + type: array + items: + type: object + properties: + resource: + type: string + code: + type: string + message: + type: string + examples: + client-errors: + value: + message: Validation Failed + errors: + - resource: PreReceiveEnvironment + code: custom + message: Can not start a new download when a download is in + progress + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": + get: + summary: Get the download status for a pre-receive environment + description: In addition to seeing the download status at the "[Get a pre-receive + environment](#get-a-pre-receive-environment)" endpoint, there is also this + separate endpoint for just the download status. + operationId: enterprise-admin/get-download-status-for-pre-receive-environment + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-environments#get-the-download-status-for-a-pre-receive-environment + parameters: + - "$ref": "#/components/parameters/pre-receive-environment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-environment-download-status" + examples: + default: + "$ref": "#/components/examples/pre-receive-environment-download-status" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-environments + "/admin/pre-receive-hooks": + get: + summary: List pre-receive hooks + description: '' + operationId: enterprise-admin/list-pre-receive-hooks + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#list-pre-receive-hooks + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The property to sort the results by. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + post: + summary: Create a pre-receive hook + description: '' + operationId: enterprise-admin/create-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#create-a-pre-receive-hook + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the hook. + script: + type: string + description: The script that the hook runs. + script_repository: + type: object + description: The GitHub repository where the script is kept. + properties: {} + additionalProperties: true + environment: + type: object + description: The pre-receive environment where the script is executed. + properties: {} + additionalProperties: true + enforcement: + type: string + description: 'The state of enforcement for this hook. default: `disabled`' + allow_downstream_configuration: + type: boolean + description: 'Whether enforcement can be overridden at the org or + repo level. default: `false`' + required: + - name + - script + - script_repository + - environment + examples: + default: + value: + name: Check Commits + script: scripts/commit_check.sh + enforcement: disabled + allow_downstream_configuration: false + script_repository: + full_name: DevIT/hooks + environment: + id: 2 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + "/admin/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook + description: '' + operationId: enterprise-admin/get-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#get-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + patch: + summary: Update a pre-receive hook + description: '' + operationId: enterprise-admin/update-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#update-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the hook. + script: + type: string + description: The script that the hook runs. + script_repository: + type: object + description: The GitHub repository where the script is kept. + properties: {} + additionalProperties: true + environment: + type: object + description: The pre-receive environment where the script is executed. + properties: {} + additionalProperties: true + enforcement: + type: string + description: The state of enforcement for this hook. + allow_downstream_configuration: + type: boolean + description: Whether enforcement can be overridden at the org or + repo level. + examples: + default: + value: + name: Check Commits + environment: + id: 1 + allow_downstream_configuration: true + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + delete: + summary: Delete a pre-receive hook + description: '' + operationId: enterprise-admin/delete-pre-receive-hook + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/pre-receive-hooks#delete-a-pre-receive-hook + parameters: + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: pre-receive-hooks + "/admin/tokens": + get: + summary: List personal access tokens + description: Lists personal access tokens for all users, including admin users. + operationId: enterprise-admin/list-personal-access-tokens + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#list-personal-access-tokens + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/classic-personal-access-tokens" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/tokens/{token_id}": + delete: + summary: Delete a personal access token + description: Deletes a personal access token. Returns a `403 - Forbidden` status + when a personal access token is in use. For example, if you access this endpoint + with the same personal access token that you are trying to delete, you will + receive this error. + operationId: enterprise-admin/delete-personal-access-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-a-personal-access-token + parameters: + - "$ref": "#/components/parameters/token-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users": + post: + summary: Create a user + description: |- + If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user) for the user. + + The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `"octo_cat"` as the login, a user named `"octo-cat"` will be created. + + If the login name or email address is already associated with an account, the server will return a `422` response. + operationId: enterprise-admin/create-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#create-a-user + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/simple-user" + examples: + default: + "$ref": "#/components/examples/simple-user" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The user's username. + email: + type: string + description: |- + **Required for built-in authentication.** The user's email + address. This parameter can be omitted when using CAS, LDAP, or SAML. + For more information, see "[About authentication for your enterprise](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/managing-iam-for-your-enterprise/about-authentication-for-your-enterprise)." + suspended: + type: boolean + description: Whether to set the user as suspended when the user + is created. + default: false + required: + - login + examples: + default: + value: + login: monalisa + email: octocat@github.com + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users/{username}": + patch: + summary: Update the username for a user + description: '' + operationId: enterprise-admin/update-username-for-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#update-the-username-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Response + content: + application/json: + schema: + type: object + properties: + message: + type: string + url: + type: string + examples: + default: + value: + message: Job queued to rename user. It may take a few minutes + to complete. + url: https://api.github.com/user/1 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + login: + type: string + description: The user's new username. + required: + - login + examples: + default: + value: + login: thenewmonalisa + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Delete a user + description: |- + Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#suspend-a-user) is often a better option. + + You can delete any user account except your own. + operationId: enterprise-admin/delete-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/admin/users/{username}/authorizations": + post: + summary: Create an impersonation OAuth token + description: '' + operationId: enterprise-admin/create-impersonation-o-auth-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#create-an-impersonation-oauth-token + parameters: + - "$ref": "#/components/parameters/username" + responses: + '201': + description: Response when creating a new impersonation OAuth token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + '200': + description: Response when getting an existing impersonation OAuth token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + scopes: + type: array + description: A list of [scopes](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + items: + type: string + required: + - scopes + examples: + default: + value: + scopes: + - public_repo + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Delete an impersonation OAuth token + description: '' + operationId: enterprise-admin/delete-impersonation-o-auth-token + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#delete-an-impersonation-oauth-token + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/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/enterprise-server@3.15/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + 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)." + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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)." + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/rest/apps/webhooks#list-deliveries-for-an-app-webhook + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/cursor" + 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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 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/enterprise-server@3.15/rest/apps/apps#suspend-an-app-installation)" endpoint. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/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\nWhen using the repository or permission parameters to + reduce the access of the token, the complexity of the token is increased due + to both the number of permissions in the request and the number of repositories + the token will have access to. If the complexity is too large, the token will + fail to be issued. If this occurs, the error message will indicate the maximum + number of repositories that should be requested. For the average application + requesting 8 permissions, this limit is around 5000 repositories. With fewer + permissions requested, more repositories are supported.\n\nYou must use a + [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - rails + repository_ids: + description: List of repository IDs that the token should have access + to + type: array + items: + type: integer + examples: + - 1 + 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 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 Enterprise Server API or webhook events is blocked for that account. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/grants": + get: + summary: List your grants + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-grants + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/application-grant" + examples: + default: + "$ref": "#/components/examples/application-grant-items" + 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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/applications/grants/{grant_id}": + get: + summary: Get a single grant + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-grant + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-a-single-grant + parameters: + - "$ref": "#/components/parameters/grant-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/application-grant" + examples: + default: + "$ref": "#/components/examples/application-grant" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + delete: + summary: Delete a grant + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-grant + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#delete-a-grant + parameters: + - "$ref": "#/components/parameters/grant-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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + examples: + - 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 + examples: + - octocat + target_id: + description: The ID of the user or organization to scope the user + access token to. **Required** unless `target` is specified. + type: integer + examples: + - 1 + 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 + examples: + - 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. + type: array + items: + type: integer + examples: + - 1 + 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] + > 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/enterprise-server@3.15/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 + "/authorizations": + get: + summary: List your authorizations + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/list-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#list-your-authorizations + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: client_id + in: query + required: false + description: The client ID of your GitHub app. + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-items" + 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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + post: + summary: Create a new authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + Creates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.15/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + + To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. + + You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.15/articles/creating-an-access-token-for-command-line-use). + + Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.15/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. + tags: + - oauth-authorizations + operationId: oauth-authorizations/create-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#create-a-new-authorization + parameters: [] + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + client_id: + description: The OAuth app client key for which to create the token. + maxLength: 20 + type: string + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + examples: + default: + summary: Create an authorization + value: + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + client_id: abcde12345fghij67890 + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + '410': + "$ref": "#/components/responses/gone" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/clients/{client_id}": + put: + summary: Get-or-create an authorization for a specific app + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app + parameters: + - "$ref": "#/components/parameters/oauth-client-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + required: + - client_secret + type: object + examples: + default: + summary: Create an authorization for an app + value: + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + responses: + '200': + description: if returning an existing token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + response-if-returning-an-existing-token: + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token-2" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '201': + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/clients/{client_id}/{fingerprint}": + put: + summary: Get-or-create an authorization for a specific app and fingerprint + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + > [!WARNING] + > Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). + + This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-or-create-authorization-for-app-and-fingerprint + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-or-create-an-authorization-for-a-specific-app-and-fingerprint + parameters: + - "$ref": "#/components/parameters/oauth-client-id" + - name: fingerprint + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + properties: + client_secret: + description: The OAuth app client secret for which to create the + token. + maxLength: 40 + type: string + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + required: + - client_secret + type: object + examples: + default: + summary: Create an authorization for an app and fingerprint + value: + client_secret: 3ef4ad510c59ad37bac6bb4f80047fb3aee3cc7f + scopes: + - public_repo + note: optional note + note_url: http://optional/note/url + responses: + '200': + description: if returning an existing token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + response-if-returning-an-existing-token: + "$ref": "#/components/examples/authorization-response-if-returning-an-existing-token" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '201': + description: Response if returning a new token + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-3" + headers: + Location: + example: https://api.github.com/authorizations/1 + schema: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/authorizations/{authorization_id}": + get: + summary: Get a single authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/get-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#get-a-single-authorization + parameters: + - "$ref": "#/components/parameters/authorization-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-2" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + patch: + summary: Update an existing authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + + If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.15/rest/overview/other-authentication-methods#working-with-two-factor-authentication)." + + You can only send one of these scope keys at a time. + tags: + - oauth-authorizations + operationId: oauth-authorizations/update-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization + parameters: + - "$ref": "#/components/parameters/authorization-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + scopes: + description: A list of scopes that this authorization is in. + type: + - array + - 'null' + items: + type: string + examples: + - public_repo + - user + add_scopes: + description: A list of scopes to add to this authorization. + type: array + items: + type: string + remove_scopes: + description: A list of scopes to remove from this authorization. + type: array + items: + type: string + note: + description: A note to remind you what the OAuth token is for. + type: string + examples: + - Update all gems + note_url: + description: A URL to remind you what app the OAuth token is for. + type: string + fingerprint: + description: A unique string to distinguish an authorization from + others created for the same client ID and user. + type: string + examples: + default: + summary: Example of updating scopes and note + value: + add_scopes: + - public_repo + remove_scopes: + - user + note: optional note + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authorization" + examples: + default: + "$ref": "#/components/examples/authorization-2" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + delete: + summary: Delete an authorization + description: |- + > [!WARNING] + > **Closing down notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.15/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations) will be removed on November 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/). + tags: + - oauth-authorizations + operationId: oauth-authorizations/delete-authorization + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/oauth-authorizations/oauth-authorizations#delete-an-authorization + parameters: + - "$ref": "#/components/parameters/authorization-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 + removalDate: '2020-11-13' + deprecationDate: '2020-02-14' + category: oauth-authorizations + subcategory: oauth-authorizations + deprecated: true + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/emojis": + get: + summary: Get emojis + description: Lists all the emojis available to use on GitHub Enterprise Server. + operationId: emojis/get + tags: + - emojis + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + "/enterprise/announcement": + get: + summary: Get the global announcement banner + description: Gets the current message and expiration date of the global announcement + banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/get-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/announcement#get-the-global-announcement-banner + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + patch: + summary: Set the global announcement banner + description: Sets the message and expiration time for the global announcement + banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/set-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/announcement#set-the-global-announcement-banner + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + value: + announcement: Very **important** announcement about _something_. + expires_at: '2021-01-01T00:00:00.000+00:00' + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + delete: + summary: Remove the global announcement banner + description: Removes the global announcement banner in your enterprise. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-announcement + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/announcement#remove-the-global-announcement-banner + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: announcement + "/enterprise/settings/license": + get: + summary: Get license information + description: '' + operationId: enterprise-admin/get-license-information + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/license#get-license-information + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/license-info" + examples: + default: + "$ref": "#/components/examples/license-info" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: license + "/enterprise/stats/all": + get: + summary: Get all statistics + description: '' + operationId: enterprise-admin/get-all-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-all-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-overview" + examples: + default: + "$ref": "#/components/examples/enterprise-overview" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/comments": + get: + summary: Get comment statistics + description: '' + operationId: enterprise-admin/get-comment-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-comment-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-comment-overview" + examples: + default: + value: + total_commit_comments: 5000 + total_gist_comments: 400 + total_issue_comments: 10900 + total_pull_request_comments: 9900 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/gists": + get: + summary: Get gist statistics + description: '' + operationId: enterprise-admin/get-gist-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-gist-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-gist-overview" + examples: + default: + value: + total_gists: 500 + private_gists: 30 + public_gists: 470 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/hooks": + get: + summary: Get hooks statistics + operationId: enterprise-admin/get-hooks-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-hooks-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-hook-overview" + examples: + default: + value: + total_hooks: 50 + active_hooks: 47 + inactive_hooks: 3 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/issues": + get: + summary: Get issue statistics + description: '' + operationId: enterprise-admin/get-issue-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-issue-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-issue-overview" + examples: + default: + value: + total_issues: 5000 + open_issues: 300 + closed_issues: 4700 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/milestones": + get: + summary: Get milestone statistics + description: '' + operationId: enterprise-admin/get-milestone-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-milestone-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-milestone-overview" + examples: + default: + value: + total_milestones: 90 + open_milestones: 10 + closed_milestones: 80 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/orgs": + get: + summary: Get organization statistics + description: '' + operationId: enterprise-admin/get-org-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-organization-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-organization-overview" + examples: + default: + value: + total_orgs: 50 + disabled_orgs: 1 + total_teams: 70 + total_team_members: 700 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/pages": + get: + summary: Get pages statistics + description: '' + operationId: enterprise-admin/get-pages-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-pages-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-page-overview" + examples: + default: + value: + total_pages: 20 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/pulls": + get: + summary: Get pull request statistics + description: '' + operationId: enterprise-admin/get-pull-request-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-pull-request-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-pull-request-overview" + examples: + default: + value: + total_pulls: 1200 + merged_pulls: 1100 + mergeable_pulls: 90 + unmergeable_pulls: 10 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/repos": + get: + summary: Get repository statistics + operationId: enterprise-admin/get-repo-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-repository-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-repository-overview" + examples: + default: + value: + total_repos: 200 + root_repos: 1 + fork_repos: 10 + org_repos: 150 + total_pushes: 39000 + total_wikis: 5 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/security-products": + get: + summary: Get security products statistics + description: |- + Gets the statistics about security products for a GitHub Enterprise Server instance. + + To use this endpoint, you must be a site admin. + operationId: enterprise-admin/get-security-products + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-security-products-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-security-products-overview" + examples: + default: + "$ref": "#/components/examples/enterprise-security-products-overview" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprise/stats/users": + get: + summary: Get users statistics + description: '' + operationId: enterprise-admin/get-user-stats + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/admin-stats#get-users-statistics + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-user-overview" + examples: + default: + value: + total_users: 100 + admin_users: 3 + suspended_users: 1 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: admin-stats + "/enterprises/{enterprise}/actions/cache/usage": + get: + summary: Get GitHub Actions cache usage for an enterprise + description: |- + Gets the total GitHub Actions cache usage for an enterprise. + 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 `admin:enterprise` scope to use this endpoint. + operationId: actions/get-actions-cache-usage-for-enterprise + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/cache/usage-policy": + get: + summary: Get GitHub Actions cache usage policy for an enterprise + description: |- + Gets the GitHub Actions cache usage policy for an enterprise. + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-actions-cache-usage-policy-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-policy-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-enterprise" + examples: + default: + "$ref": "#/components/examples/actions-cache-usage-policy-enterprise" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + category: actions + subcategory: cache + patch: + summary: Set GitHub Actions cache usage policy for an enterprise + description: |- + Sets the GitHub Actions cache usage policy for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-usage-policy-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/cache#set-github-actions-cache-usage-policy-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-enterprise" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-usage-policy-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: false + category: actions + subcategory: cache + "/enterprises/{enterprise}/actions/permissions": + get: + summary: Get GitHub Actions permissions for an enterprise + description: |- + Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-enterprise-permissions" + examples: + default: + "$ref": "#/components/examples/actions-enterprise-permissions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set GitHub Actions permissions for an enterprise + description: |- + Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-github-actions-permissions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-github-actions-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + required: + - enabled_organizations + examples: + default: + value: + enabled_organizations: all + allowed_actions: selected + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/organizations": + get: + summary: List selected organizations enabled for GitHub Actions in an enterprise + description: |- + Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#list-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + organizations: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + required: + - total_count + - organizations + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set selected organizations enabled for GitHub Actions in an enterprise + description: |- + Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-selected-organizations-enabled-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs to enable for GitHub Actions. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + examples: + default: + value: + selected_organization_ids: + - 32 + - 91 + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": + put: + summary: Enable a selected organization for GitHub Actions in an enterprise + description: |- + Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/enable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#enable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + delete: + summary: Disable a selected organization for GitHub Actions in an enterprise + description: |- + Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/disable-selected-organization-github-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#disable-a-selected-organization-for-github-actions-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/selected-actions": + get: + summary: Get allowed actions for an enterprise + description: |- + Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + default: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + put: + summary: Set allowed actions for an enterprise + description: |- + Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-allowed-actions-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/selected-actions" + examples: + selected_actions: + "$ref": "#/components/examples/selected-actions" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/permissions/workflow": + get: + summary: Get default workflow permissions for an enterprise + description: |- + Gets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, + as well as whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + + OAuth tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/get-github-actions-default-workflow-permissions-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#get-default-workflow-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success 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: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + put: + summary: Set default workflow permissions for an enterprise + description: |- + Sets the default workflow permissions granted to the `GITHUB_TOKEN` when running workflows in an enterprise, and sets + whether GitHub Actions can submit approving pull request reviews. For more information, see + "[Enforcing a policy for workflow permissions in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise#enforcing-a-policy-for-workflow-permissions-in-your-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/set-github-actions-default-workflow-permissions-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/permissions#set-default-workflow-permissions-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-set-default-workflow-permissions" + examples: + default: + "$ref": "#/components/examples/actions-default-workflow-permissions" + responses: + '204': + description: Success response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: permissions + "/enterprises/{enterprise}/actions/runner-groups": + get: + summary: List self-hosted runner groups for an enterprise + description: |- + Lists all self-hosted runner groups for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runner-groups-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-self-hosted-runner-groups-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/visible-to-organization" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + total_count: + type: number + runner_groups: + type: array + items: + "$ref": "#/components/schemas/runner-groups-enterprise" + required: + - total_count + - runner_groups + examples: + default: + "$ref": "#/components/examples/runner-groups-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + post: + summary: Create a self-hosted runner group for an enterprise + description: |- + Creates a new self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#create-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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 organizations + or select individual organization. + type: string + enum: + - selected + - all + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - name + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + selected_organization_ids: + - 32 + - 91 + runners: + - 9 + - 2 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": + get: + summary: Get a self-hosted runner group for an enterprise + description: |- + Gets a specific self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#get-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + patch: + summary: Update a self-hosted runner group for an enterprise + description: |- + Updates the `name` and `visibility` of a self-hosted runner group in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/update-self-hosted-runner-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: false + 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 organizations + or select individual organizations. + type: string + enum: + - selected + - all + default: all + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + examples: + default: + value: + name: Expensive hardware runners + visibility: selected + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/runner-groups-enterprise" + examples: + default: + "$ref": "#/components/examples/runner-group-update-enterprise" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Delete a self-hosted runner group from an enterprise + description: |- + Deletes a self-hosted runner group for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#delete-a-self-hosted-runner-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": + get: + summary: List organization access to a self-hosted runner group in an enterprise + description: |- + Lists the organizations with access to a self-hosted runner group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + properties: + total_count: + type: number + organizations: + type: array + items: + "$ref": "#/components/schemas/organization-simple" + required: + - total_count + - organizations + examples: + default: + "$ref": "#/components/examples/organization-targets" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set organization access for a self-hosted runner group in an enterprise + description: |- + Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#set-organization-access-for-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + selected_organization_ids: + description: List of organization IDs that can access the runner + group. + type: array + items: + type: integer + description: Unique identifier of the organization. + required: + - selected_organization_ids + examples: + default: + value: + selected_organization_ids: + - 32 + - 91 + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": + put: + summary: Add organization access to a self-hosted runner group in an enterprise + description: |- + Adds an organization to the list of selected organizations 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 enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#add-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove organization access to a self-hosted runner group in an enterprise + description: |- + Removes an organization from the list of selected organizations 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 enterprise](#create-a-self-hosted-runner-group-for-an-enterprise)." + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#remove-organization-access-to-a-self-hosted-runner-group-in-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/org-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": + get: + summary: List self-hosted runners in a group for an enterprise + description: |- + Lists the self-hosted runners that are in a specific enterprise group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#list-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + properties: + total_count: + type: number + runners: + type: array + items: + "$ref": "#/components/schemas/runner" + required: + - total_count + - runners + examples: + default: + "$ref": "#/components/examples/runner-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + put: + summary: Set self-hosted runners in a group for an enterprise + description: |- + Replaces the list of self-hosted runners that are part of an enterprise runner group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/set-self-hosted-runners-in-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#set-self-hosted-runners-in-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": + put: + summary: Add a self-hosted runner to a group for an enterprise + description: |- + Adds a self-hosted runner to a runner group configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/add-self-hosted-runner-to-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#add-a-self-hosted-runner-to-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + delete: + summary: Remove a self-hosted runner from a group for an enterprise + description: |- + Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runner-groups#remove-a-self-hosted-runner-from-a-group-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-group-id" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runner-groups + "/enterprises/{enterprise}/actions/runners": + get: + summary: List self-hosted runners for an enterprise + description: |- + Lists all self-hosted runners configured for an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-self-hosted-runners-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-self-hosted-runners-for-an-enterprise + parameters: + - name: name + description: The name of a self-hosted runner. + in: query + schema: + type: string + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + 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: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/downloads": + get: + summary: List runner applications for an enterprise + description: |- + Lists binaries for the runner application that you can download and run. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/list-runner-applications-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-runner-applications-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/runner-application" + examples: + default: + "$ref": "#/components/examples/runner-application-items-airgap" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/generate-jitconfig": + post: + summary: Create configuration for a just-in-time runner for an Enterprise + description: |- + Generates a configuration that can be passed to the runner application at startup. + + OAuth tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - actions + operationId: actions/generate-runner-jitconfig-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + 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" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/registration-token": + post: + summary: Create a registration token for an enterprise + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + 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/enterprises/octo-enterprise --token TOKEN + ``` + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-registration-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-registration-token-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authentication-token" + examples: + default: + "$ref": "#/components/examples/authentication-token" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/remove-token": + post: + summary: Create a remove token for an enterprise + description: |- + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour. + + Example using remove token: + + To remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this + endpoint. + + ``` + ./config.sh remove --token TOKEN + ``` + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/create-remove-token-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#create-a-remove-token-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/authentication-token" + examples: + default: + "$ref": "#/components/examples/authentication-token-2" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}": + get: + summary: Get a self-hosted runner for an enterprise + description: |- + Gets a specific self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/get-self-hosted-runner-for-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#get-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + delete: + summary: Delete a self-hosted runner from an enterprise + description: |- + Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + operationId: enterprise-admin/delete-self-hosted-runner-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#delete-a-self-hosted-runner-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '204': + description: Response + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}/labels": + get: + summary: List labels for a self-hosted runner for an enterprise + description: |- + Lists all labels for a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/list-labels-for-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#list-labels-for-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '200': + "$ref": "#/components/responses/actions_runner_labels" + '404': + "$ref": "#/components/responses/not_found" + x-github: + enabledForGitHubApps: false + githubCloudOnly: true + category: actions + subcategory: self-hosted-runners + post: + summary: Add custom labels to a self-hosted runner for an enterprise + description: |- + Add custom labels to a self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/add-custom-labels-to-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#add-custom-labels-to-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + put: + summary: Set custom labels for a self-hosted runner for an enterprise + description: |- + Remove all previous custom labels and set the new custom labels for a specific + self-hosted runner configured in an enterprise. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/set-custom-labels-for-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#set-custom-labels-for-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + delete: + summary: Remove all custom labels from a self-hosted runner for an enterprise + description: |- + Remove all custom labels from a self-hosted runner configured in an + enterprise. Returns the remaining read-only labels from the runner. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-all-custom-labels-from-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-all-custom-labels-from-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/runner-id" + responses: + '200': + "$ref": "#/components/responses/actions_runner_labels_readonly" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/actions/runners/{runner_id}/labels/{name}": + delete: + summary: Remove a custom label from a self-hosted runner for an enterprise + description: |- + Remove a custom label from a self-hosted runner configured + in an enterprise. 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. + + OAuth app tokens and personal access tokens (classic) need the `manage_runners:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: enterprise-admin/remove-custom-label-from-self-hosted-runner-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/self-hosted-runners#remove-a-custom-label-from-a-self-hosted-runner-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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: true + enabledForGitHubApps: false + category: actions + subcategory: self-hosted-runners + "/enterprises/{enterprise}/audit-log": + get: + summary: Get the audit log for an enterprise + operationId: enterprise-admin/get-audit-log + description: |- + Gets the audit log for an enterprise. + + The authenticated user must be an enterprise admin to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/audit-log#get-the-audit-log-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/audit-log-enterprise-phrase" + - "$ref": "#/components/parameters/audit-log-include" + - "$ref": "#/components/parameters/audit-log-after" + - "$ref": "#/components/parameters/audit-log-before" + - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/per-page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/audit-log-event" + examples: + default: + "$ref": "#/components/examples/audit-log" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: audit-log + "/enterprises/{enterprise}/code-scanning/alerts": + get: + summary: List code scanning alerts for an enterprise + description: |- + Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + + The authenticated user must be a member of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo` scope to use this endpoint. + tags: + - code-scanning + operationId: code-scanning/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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 + 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: true + enabledForGitHubApps: false + previews: [] + category: code-scanning + subcategory: code-scanning + "/enterprises/{enterprise}/code_security_and_analysis": + get: + summary: Get code security and analysis features for an enterprise + description: |- + Gets code security and analysis settings for the specified 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: + - enterprise-admin + operationId: secret-scanning/get-security-analysis-settings-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/code-security-and-analysis#get-code-security-and-analysis-features-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/enterprise-security-analysis-settings" + examples: + default: + "$ref": "#/components/examples/enterprise-security-analysis-settings" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + patch: + summary: Update code security and analysis features for an enterprise + description: |- + Updates the settings for advanced security, Dependabot alerts, secret scanning, and push protection for new repositories in an enterprise. + + The authenticated user must be an administrator of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: secret-scanning/patch-security-analysis-settings-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/code-security-and-analysis#update-code-security-and-analysis-features-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + advanced_security_enabled_for_new_repositories: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled + for new repositories. For more information, see "[About GitHub + Advanced Security](https://docs.github.com/enterprise-server@3.15/get-started/learning-about-github/about-github-advanced-security)." + advanced_security_enabled_new_user_namespace_repos: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled + for new user namespace repositories. For more information, see + "[About GitHub Advanced Security](https://docs.github.com/enterprise-server@3.15/get-started/learning-about-github/about-github-advanced-security)." + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: Whether Dependabot alerts are automatically enabled + for new repositories. For more information, see "[About Dependabot + alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + secret_scanning_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning is automatically enabled for + new repositories. For more information, see "[About secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning push protection is automatically + enabled for new repositories. For more information, see "[Protecting + pushes with secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: |- + The URL that will be displayed to contributors who are blocked from pushing a secret. For more information, see "[Protecting pushes with secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/protecting-pushes-with-secret-scanning)." + To disable this functionality, set this field to `null`. + secret_scanning_non_provider_patterns_enabled_for_new_repositories: + type: + - boolean + - 'null' + description: Whether secret scanning of non-provider patterns is + enabled for new repositories under this enterprise. + examples: + default: + value: + advanced_security_enabled_for_new_repositories: true + advanced_security_enabled_new_user_namespace_repos: true + dependabot_alerts_enabled_for_new_repositories: true + secret_scanning_enabled_for_new_repositories: true + secret_scanning_push_protection_enabled_for_new_repositories: true + secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md + secret_scanning_non_provider_patterns_enabled_for_new_repositories: true + 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 + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + "/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + - "$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}/secret-scanning/alerts": + get: + summary: List secret scanning alerts for an enterprise + description: |- + 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/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization), or for personal account repositories. + tags: + - secret-scanning + operationId: secret-scanning/list-alerts-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/secret-scanning-alert-state" + - "$ref": "#/components/parameters/secret-scanning-alert-secret-type" + - "$ref": "#/components/parameters/secret-scanning-alert-resolution" + - "$ref": "#/components/parameters/secret-scanning-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/secret-scanning-alert-validity" + 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: false + category: secret-scanning + subcategory: secret-scanning + "/enterprises/{enterprise}/settings/billing/advanced-security": + get: + summary: Get GitHub Advanced Security active committers for an enterprise + description: |- + Gets the GitHub Advanced Security active committers for an enterprise per repository. + + Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of active_users for each repository. + + The total number of repositories with committer information is tracked by the `total_count` field. + tags: + - billing + operationId: billing/get-github-advanced-security-billing-ghe + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/billing#get-github-advanced-security-active-committers-for-an-enterprise + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/advanced-security-active-committers" + examples: + default: + "$ref": "#/components/examples/advanced-security-active-committers" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: billing + "/enterprises/{enterprise}/{security_product}/{enablement}": + post: + summary: Enable or disable a security feature + description: |- + Enables or disables the specified security feature for all repositories in an enterprise. + + The authenticated user must be an administrator of the enterprise to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + tags: + - enterprise-admin + operationId: secret-scanning/post-security-product-enablement-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/code-security-and-analysis#enable-or-disable-a-security-feature + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/enterprise-security-product" + - "$ref": "#/components/parameters/enterprise-security-product-enablement" + 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 + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: enterprise-admin + subcategory: code-security-and-analysis + "/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/enterprise-server@3.15/rest/activity/events#list-public-events + parameters: + - "$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-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. + + * **Timeline**: The GitHub Enterprise Server global public timeline + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/enterprise-server@3.15/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 Enterprise Server. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/rest/gists/gists#create-a-gist + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + description: + description: Description of the gist + type: string + examples: + - Example Ruby script + files: + description: Names and content for the files that make up the gist + type: object + additionalProperties: + type: object + properties: + content: + description: Content of the file + readOnly: false + type: string + required: + - content + examples: + - hello.rb: + content: puts "Hello, World!" + public: + oneOf: + - description: Flag indicating whether the gist is public + type: boolean + default: false + examples: + - true + - type: string + default: 'false' + enum: + - 'true' + - 'false' + examples: + - 'true' + 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. + + Note: With [pagination](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/update + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + type: string + examples: + - Example Ruby script + 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`. + type: object + additionalProperties: + type: + - object + - 'null' + properties: + content: + description: The new content of the file. + type: string + filename: + description: The new filename for the file. + type: + - string + - 'null' + examples: + - hello.rb: + content: blah + filename: goodbye.rb + type: + - object + - 'null' + 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: + "$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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/list-comments + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/create-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + examples: + - 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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/update-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + examples: + - 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + tags: + - gists + operationId: gists/get-revision + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: + "$ref": "#/components/schemas/repository" + repository_selection: + type: string + examples: + - 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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/manage/v1/access/ssh": + get: + summary: Get the configured SSH keys + description: Gets the configured SSH keys on all available nodes. For more information, + see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/get-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-configured-ssh-keys + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-ssh" + examples: + default: + "$ref": "#/components/examples/ghes-get-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Set a new SSH key + description: Adds a SSH key to the `authorized_keys` file for your GitHub Enterprise + Server instance. This will grant access via SSH to your instance. For more + information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/set-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#set-a-new-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-ssh-request" + examples: + default: + value: + key: ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw== + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-ssh-response" + examples: + default: + "$ref": "#/components/examples/ghes-set-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + delete: + summary: Delete a SSH key + description: Deletes a SSH key from the `authorized_keys` file for your GitHub + Enterprise Server instance. This will remove access via SSH to your instance. + For more information, see "[Accessing the administrative shell (SSH)](https://docs.github.com/enterprise-server@3.15/admin/administering-your-instance/administering-your-instance-from-the-command-line/accessing-the-administrative-shell-ssh)." + operationId: enterprise-admin/delete-manage-ssh + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#delete-a-ssh-key + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-delete-ssh-request" + examples: + default: + value: + key: ssh-rsa AAAAB3NzaC1yc2EAAAADCIABAAAAgQCY/ZiDDOFWcZnYXPwMbvwQDofXPdHxLfxPK+HWGVPd1DLcDncYBUSB0bmCU2g9Sc+oHKLoHhXp0ivau9h+EpmQJ7V8vqsRdD9pc4aL/WAnUyF4o3Y7xL94rlRpVbVo/tNjzcvqxxyzBiYyy3GciCMpYQh/uKt56B94/5PNyIGEEw== + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-delete-ssh-response" + examples: + default: + "$ref": "#/components/examples/ghes-delete-ssh" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/checks/system-requirements": + get: + summary: Get the system requirement check results for configured cluster nodes + description: |- + Checks if the minimum requirements for system hardware resources are met on each configured cluster node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-checks-system-requirements + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-system-requirement-check-results-for-configured-cluster-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-checks-system-requirements" + examples: + default: + "$ref": "#/components/examples/ghes-checks-system-requirements" + '400': + description: Bad request + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/cluster/status": + get: + summary: Get the status of services running on all cluster nodes + description: |- + Gets the status of all services running on each cluster node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-cluster-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-cluster-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-cluster-status" + examples: + default: + "$ref": "#/components/examples/ghes-cluster-status" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/apply": + get: + summary: Get the status of a ghe-config-apply run + description: Displays the current status of `ghe-config-apply` in the environment + or the status of a historical run by ID. + operationId: enterprise-admin/get-manage-config-apply-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-a-ghe-config-apply-run + parameters: + - name: run_id + description: The unique run ID of the `ghe-config-apply` run. + in: query + required: false + schema: + type: string + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + running: + type: boolean + description: Whether the ghe-config-apply run is still running + in the environment + successful: + type: boolean + description: Whether the ghe-config-apply run was successful in + the environment + nodes: + type: array + items: + type: object + properties: + run_id: + type: string + description: The unique Run ID of the ghe-config-apply run + on the host + hostname: + type: string + description: The hostname of the node + running: + type: boolean + description: Whether the ghe-config-apply run is still running + on the host + successful: + type: boolean + description: Whether the ghe-config-apply run was successful + on the host + examples: + default: + value: + running: true + successful: false + nodes: + - run_id: d34db33f + hostname: ghes-01.lan + running: true + successful: false + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Trigger a ghe-config-apply run + description: |- + Triggers a run of `ghe-config-apply` from the `ghes-manage` agent on your Nomad Delegate instance. + You can provide a run ID or allow one to be generated randomly. + operationId: enterprise-admin/post-manage-run-config-apply + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#trigger-a-ghe-config-apply-run + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + description: The run ID to execute `ghe-config-apply` with. If not + provided, a run ID will be generated randomly. + examples: + default: + value: + run_id: d34db33f + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + run_id: + type: string + description: Run ID the job was launched with + examples: + default: + value: + run_id: d34db33f + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/apply/events": + get: + summary: List events from ghe-config-apply + description: Lists events from an in-process `ghe-config-apply` run on your + Github Enterprise Server instance. + operationId: enterprise-admin/get-manage-config-apply-events + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#list-events-from-ghe-config-apply + parameters: + - name: last_request_id + description: The unique ID of the last response from a host, used for pagination. + in: query + required: false + schema: + type: string + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + properties: + nodes: + type: array + items: + type: object + properties: + node: + type: string + description: Hostname of the node + last_request_id: + type: string + description: Unique ID of the last response from a host + used for pagination + events: + type: array + items: + type: object + properties: + timestamp: + type: string + severity_text: + type: string + body: + type: string + event_name: + type: string + topology: + type: string + hostname: + type: string + config_run_id: + type: string + trace_id: + type: string + span_id: + type: string + span_parent_id: + type: string + span_depth: + type: integer + examples: + default: + value: + nodes: + - node: ghes-01.lan + last_request_id: 387cd628c06d606700e79be368e5e574:0cde553750689c76:0000000000000000 + events: + - timestamp: '2023-01-01T13:00:00+00:00' + severity_text: INFO + body: Validating services + event_name: Enterprise::ConfigApply::PhaseValidation#config_phase_validation + topology: multinode + hostname: ghes-01.lan + config_run_id: d34db33f + trace_id: 387cd628c06d606700e79be368e5e574 + span_id: 0cde553750689c76 + span_parent_id: 0 + span_depth: 0 + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/init": + post: + summary: Initialize instance configuration with license and password + description: |- + When you boot and set up a GitHub instance for the first time, you can use this endpoint to upload a license and set the initial root site administrator password. + + > [!IMPORTANT] + > To start the configuration process and apply the license, you need to `POST` to [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + + The root site administrator password provided when calling this endpoint is used to authenticate for all other endpoints in the GHES Manage API and the Management Console UI. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/initialize-instance-configuration + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#initialize-instance-configuration-with-license-and-password + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + multipart/form-data: + schema: + "$ref": "#/components/schemas/ghes-config-init-request" + examples: + default: + value: + license: "@enterprise.ghl" + password: provide-password-here! + responses: + '202': + description: Response + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/license": + get: + summary: Get the enterprise license information + description: Gets information about the license that is currently set for the + enterprise. + operationId: enterprise-admin/license-info + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-enterprise-license-information + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-license-info" + examples: + default: + "$ref": "#/components/examples/ghes-license-info" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + put: + summary: Upload an enterprise license + description: |- + Uploads a new enterprise license. In order to apply it right away, use the `apply` query parameter. + + > [!NOTE] + > The request body for this operation must be submitted as `multipart/form-data` data. You can can reference the license file by prefixing the filename with the `@` symbol using `curl`. For more information, see the [`curl` documentation](https://curl.se/docs/manpage.html#-F). + operationId: enterprise-admin/license-upload + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#upload-an-enterprise-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/license-apply" + requestBody: + required: true + content: + multipart/form-data: + schema: + "$ref": "#/components/schemas/ghes-upload-license-request" + examples: + default: + value: + license: "@enterprise.ghl" + responses: + '201': + description: Created + '202': + description: Accepted + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/license/check": + get: + summary: Check a license + description: Check the status of the license that is currently set for the enterprise. + operationId: enterprise-admin/license-check + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#check-a-license + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-license-check" + examples: + default: + "$ref": "#/components/examples/ghes-license-check" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/nodes": + get: + summary: Get GHES node metadata for all nodes + description: Get node metadata for all configured nodes in the current cluster. + For more information, see "[About clustering](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/configuring-clustering/about-clustering)." + operationId: enterprise-admin/get-config-nodes + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-ghes-node-metadata-for-all-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-config-nodes" + examples: + default: + "$ref": "#/components/examples/ghes-config-nodes" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/config/settings": + get: + summary: Get the GHES settings + description: Gets a list of settings for a GitHub Enterprise Server instance. + operationId: enterprise-admin/get-manage-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-ghes-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-settings" + examples: + default: + "$ref": "#/components/examples/ghes-get-settings" + '400': + description: Bad request + '401': + description: Unauthorized + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + put: + summary: Set settings + description: |- + Updates the settings on your instance. For a list of the available settings, see the [Get settings endpoint](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-settings). + + **Notes:** + - The request body only requires the settings parameters that should be updated to be specified, all other parameters will be unmodified or populated from the default values. + - You cannot set the Management Console root site administrator password with this API endpoint. Use the `ghe-set-password` utility to change the management console password. For more information, see "[Command-line utilities](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-set-password)." + operationId: enterprise-admin/set-manage-settings + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#set-settings + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + description: Only the settings parameters that should be modified need to + be specified. + content: + application/json: + schema: + type: object + examples: + default: + value: + public_pages: true + responses: + '204': + description: Response + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/maintenance": + get: + summary: Get the status of maintenance mode + description: Gets the status and details of maintenance mode on all available + nodes. For more information, see "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + operationId: enterprise-admin/get-manage-maintenance + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-get-maintenance" + examples: + default: + "$ref": "#/components/examples/ghes-get-maintenance" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + post: + summary: Set the status of maintenance mode + description: Sets or schedules the maintenance mode. For more information, see + "[Enabling and scheduling maintenance mode](https://docs.github.com/enterprise-server@3.15/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." + operationId: enterprise-admin/set-manage-maintenance + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#set-the-status-of-maintenance-mode + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-maintenance-request" + examples: + default: + value: + enabled: true + when: '2006-01-02T15:04:05+00:00' + ip_exception_list: + - 192.168.1.0/24 + - 1.1.1.1 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-set-maintenance-response" + examples: + default: + "$ref": "#/components/examples/ghes-set-maintenance" + '400': + description: Bad request + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/replication/status": + get: + summary: Get the status of services running on all replica nodes + description: |- + Gets the status of all services running on each replica node. + This endpoint may take several seconds to reply. + operationId: enterprise-admin/get-replication-status + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-the-status-of-services-running-on-all-replica-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-replication-status" + examples: + default: + "$ref": "#/components/examples/ghes-replication-status" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/manage/v1/version": + get: + summary: Get all GHES release versions for all nodes + description: Gets the GitHub Enterprise Server release versions that are currently + installed on all available nodes. For more information, see "[GitHub Enterprise + Server releases](https://docs.github.com/enterprise-server@3.15/admin/all-releases)." + operationId: enterprise-admin/get-version + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#get-all-ghes-release-versions-for-all-nodes + servers: + - url: "{protocol}://{hostname}" + variables: + hostname: + default: HOSTNAME + description: Self-hosted Enterprise Server hostname + protocol: + default: http + description: Self-hosted Enterprise Server protocol + parameters: + - "$ref": "#/components/parameters/uuid" + - "$ref": "#/components/parameters/cluster-roles" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ghes-version" + examples: + default: + "$ref": "#/components/examples/ghes-version" + '401': + description: Unauthorized + '500': + description: Internal error + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: manage-ghes + "/markdown": + post: + summary: Render a Markdown document + description: '' + operationId: markdown/render + tags: + - markdown + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + type: string + examples: + - markdown + 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/enterprise-server@3.15/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 + "/meta": + get: + summary: Get GitHub Enterprise Server meta information + description: '' + tags: + - meta + operationId: meta/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise + Server: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-read + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 Enterprise + Server as done: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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**. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/{organization_id}/custom_roles": + get: + summary: Closing down - List custom repository roles in an organization + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed in the future. Use the "[List custom repository roles](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization)" endpoint instead. + + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be administrator of the organization or of a repository of the organization 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/list-custom-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#closing-down---list-custom-repository-roles-in-an-organization + parameters: + - name: organization_id + description: The unique identifier of the organization. + in: path + required: true + schema: + type: string + responses: + '200': + description: Response - list of custom role names + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of custom roles in this organization + type: integer + examples: + - 3 + custom_roles: + type: array + items: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + removalDate: '2025-02-15' + deprecationDate: '2023-02-15' + category: orgs + subcategory: custom-roles + deprecated: true + "/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, and outside collaborators to enable [two-factor authentication](https://docs.github.com/enterprise-server@3.15/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 Enterprise Server plan, GitHub Apps need the `Organization plan` permission. + tags: + - orgs + operationId: orgs/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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] + > **Closing down notice:** GitHub Enterprise Server 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 and will be replaced with code security configurations in a future GitHub Enterprise Server version. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. \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_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 + examples: + - '"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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + 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 + 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/enterprise-server@3.15/site-policy/github-terms/github-terms-of-service + operationId: orgs/delete + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + "/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/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + "$ref": "#/components/schemas/oidc-custom-sub" + 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: + '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 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. + operationId: actions/get-github-actions-permissions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 in an organization. + + If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the 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/enterprise-server@3.15/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" + required: + - enabled_repositories + examples: + default: + value: + enabled_repositories: all + allowed_actions: selected + x-github: + enabledForGitHubApps: true + githubCloudOnly: false + 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/enterprise-server@3.15/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)." + + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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 for an organization + description: |- + Gets the selected actions 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. + operationId: actions/get-allowed-actions-organization + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 for an organization + description: |- + Sets the actions 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)." + + If the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the 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/enterprise-server@3.15/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/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + can submit approving pull request reviews. For more information, see + "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/rest/actions/permissions#set-default-workflow-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Success response + '409': + description: Conflict response when changing a setting is prevented by the + owning enterprise + 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + 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. + + 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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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-airgap" + 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/enterprise-server@3.15/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" + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/rest/actions/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: + '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/enterprise-server@3.15/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` + 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/enterprise-server@3.15/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/actions/secrets#add-selected-repository-to-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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}/announcement": + get: + summary: Get announcement banner for organization + description: |- + Gets the announcement banner currently set for the organization. Only returns the announcement banner set at the + organization level. Organization members may also see an enterprise-level announcement banner. To get an + announcement banner displayed at the enterprise level, use the enterprise-level endpoint. + tags: + - orgs + operationId: announcement-banners/get-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/announcement-banners/organizations#get-announcement-banner-for-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement-banner" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + patch: + summary: Set announcement banner for organization + description: Sets the announcement banner to display for the organization. + tags: + - orgs + operationId: announcement-banners/set-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/announcement-banners/organizations#set-announcement-banner-for-organization + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement" + examples: + default: + "$ref": "#/components/examples/announcement" + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/announcement-banner" + examples: + default: + "$ref": "#/components/examples/announcement" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + delete: + summary: Remove announcement banner from organization + description: Removes the announcement banner currently set for the organization. + tags: + - orgs + operationId: announcement-banners/remove-announcement-banner-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/announcement-banners/organizations#remove-announcement-banner-from-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: announcement-banners + subcategory: organizations + "/orgs/{org}/audit-log": + get: + summary: Get the audit log for an organization + description: |- + Gets the audit log for an organization. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization)." + + By default, the response includes up to 30 events from the past three months. Use the `phrase` parameter to filter results and retrieve older events. For example, use the `phrase` parameter with the `created` qualifier to filter events based on when the events occurred. For more information, see "[Reviewing the audit log for your organization](https://docs.github.com/enterprise-server@3.15/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/reviewing-the-audit-log-for-your-organization#searching-the-audit-log)." + + Use pagination to retrieve fewer or more than 30 events. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api)." + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:audit_log` scope to use this endpoint. + operationId: orgs/get-audit-log + tags: + - orgs + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/orgs#get-the-audit-log-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/audit-log-phrase" + - "$ref": "#/components/parameters/audit-log-include" + - "$ref": "#/components/parameters/audit-log-after" + - "$ref": "#/components/parameters/audit-log-before" + - "$ref": "#/components/parameters/audit-log-order" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/audit-log-event" + examples: + default: + "$ref": "#/components/examples/audit-log" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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" + 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. + + 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. + + > [!NOTE] + > The enablement status will only be returned for installed security products. + tags: + - code-security + operationId: code-security/get-configurations-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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. + + > [!NOTE] + > Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error. + tags: + - code-security + operationId: code-security/create-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + enum: + - enabled + - disabled + default: disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph. Dependency + Graph is not configurable in GitHub Enterprise Server. + enum: + - enabled + - disabled + - not_set + default: enabled + 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_default_setup: + type: string + description: The enablement status of code scanning default setup + enum: + - enabled + - disabled + - not_set + default: disabled + 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 + 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 + 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. + + The authenticated user must be an administrator or security manager for the organization to use this endpoint. + + > [!NOTE] + > The enablement status will only be returned for installed security products. + tags: + - code-security + operationId: code-security/get-default-configurations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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. + 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. + + 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. + + > [!NOTE] + > The enablement status will only be returned for installed security products. + tags: + - code-security + operationId: code-security/get-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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. + + > [!NOTE] + > Only installed security products may be specified in the request body. Specifying an uninstalled security product will result in a validation error. + tags: + - code-security + operationId: code-security/update-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + enum: + - enabled + - disabled + dependency_graph: + type: string + description: The enablement status of Dependency Graph. Dependency + Graph is not configurable in GitHub Enterprise Server. + enum: + - enabled + - disabled + - not_set + 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 + 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 + 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 + 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. + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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. + + > [!NOTE] + > The enablement status will only be returned for installed security products. + tags: + - code-security + operationId: code-security/set-configuration-as-default + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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-repositories-for-configuration + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/orgs/{org}/custom-repository-roles": + get: + summary: List custom repository roles in an organization + description: |- + List the custom repository roles available in this organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/list-custom-repo-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-custom-repository-roles-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response - list of custom role names + content: + application/json: + schema: + type: object + properties: + total_count: + description: The number of custom roles in this organization + type: integer + examples: + - 3 + custom_roles: + type: array + items: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-list-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + post: + summary: Create a custom repository role + description: |- + Creates a custom repository role that can be used by all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/create-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#create-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role-create-schema" + examples: + default: + value: + name: Labeler + description: A role for issue and pull request labelers + base_role: read + permissions: + - add_label + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/orgs/{org}/custom-repository-roles/{role_id}": + get: + summary: Get a custom repository role + description: |- + Gets a custom repository role that is available to all repositories owned by the organization. For more information on custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/get-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#get-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + patch: + summary: Update a custom repository role + description: |- + Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/update-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#update-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role-update-schema" + examples: + default: + value: + name: Labeler + description: A role for issue and PR labelers + base_role: read + permissions: + - add_label + - remove_label + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-repository-role" + examples: + default: + "$ref": "#/components/examples/organization-custom-repository-role-example" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + delete: + summary: Delete a custom repository role + description: |- + Deletes a custom role from an organization. Once the custom role has been deleted, any + user, team, or invitation with the deleted custom role will be reassigned the inherited role. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-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/delete-custom-repo-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#delete-a-custom-repository-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/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/enterprise-server@3.15/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + - "$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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), + [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) + endpoints. + items: + 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: + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: dependabot + subcategory: 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/enterprise-server@3.15/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` + 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/enterprise-server@3.15/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret) + and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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}/external-group/{group_id}": + get: + summary: Get an external group + description: |- + Displays information about the specific group's usage. Provides a list of the group's external members as well as a list of teams that this group is connected to. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/external-idp-group-info-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#get-an-external-group + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/group-id" + - "$ref": "#/components/parameters/members-per-page" + - "$ref": "#/components/parameters/members-page" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-group" + examples: + default: + "$ref": "#/components/examples/external-group" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + "/orgs/{org}/external-groups": + get: + summary: List external groups in an organization + description: |- + Lists external groups available in an organization. You can query the groups using the `display_name` parameter, only groups with a `group_name` containing the text provided in the `display_name` parameter will be returned. You can also limit your page results using the `per_page` parameter. GitHub Enterprise Server generates a url-encoded `page` token using a cursor value for where the next page begins. For more information on cursor pagination, see "[Offset and Cursor Pagination explained](https://dev.to/jackmarchant/offset-and-cursor-pagination-explained-b89)." + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/list-external-idp-groups-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#list-external-groups-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - name: page + description: Page token + in: query + schema: + type: integer + - name: display_name + description: Limits the list to groups containing the text in the group name + in: query + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-groups" + examples: + default: + "$ref": "#/components/examples/external-groups" + headers: + Link: + example: ; + rel="next" + schema: + type: string + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + "/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + examples: + - '"kdaigle"' + password: + type: string + examples: + - '"password"' + required: + - url + events: + type: array + description: Determines what [events](https://docs.github.com/enterprise-server@3.15/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 + `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/enterprise-server@3.15/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, + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - '"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. + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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" + 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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/enterprise-server@3.15/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. This options is only available for organization + owners. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 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/enterprise-server@3.15/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. + tags: + - orgs + operationId: orgs/remove-member + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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. + tags: + - orgs + operationId: orgs/remove-membership-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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). + + 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/enterprise-server@3.15/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 + type: string + examples: + - repositories + 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. + + Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.15/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." + tags: + - migrations + operationId: migrations/start-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + description: Indicates whether repositories should be locked (to + prevent manipulation) while migrating data. + default: false + examples: + - true + 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 + description: Indicates whether attachments should be excluded from + the migration (to reduce migration archive file size). + default: false + examples: + - true + exclude_releases: + type: boolean + description: Indicates whether releases should be excluded from + the migration (to reduce migration archive file size). + default: false + examples: + - true + exclude_owner_projects: + type: boolean + description: Indicates whether projects owned by the organization + or users should be excluded. from the migration. + default: false + examples: + - true + org_metadata_only: + type: boolean + description: Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore other + flags). + default: false + examples: + - true + 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. + + 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/enterprise-server@3.15/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 + type: string + examples: + - repositories + 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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/orgs/{org}/organization-fine-grained-permissions": + get: + summary: List organization fine-grained permissions for an organization + description: |- + Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-repository-fine-grained-permissions-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 permissions of `read_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/list-organization-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#list-organization-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/organization-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/organization-fine-grained-permission-example" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + "/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/enterprise-server@3.15/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. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in 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-roles + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + post: + summary: Create a custom organization role + description: |- + Creates a custom organization role that can be assigned to users and teams, granting them specific + permissions over the organization and optionally across all repositories in the organization. For + more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + To include repository permissions in an organization role, you must also include the `base_role` + field, which is one of `read`, `write`, `triage`, `maintain`, or `admin` (or `none` if no base role is set). This base role provides a set of + fine-grained permissions as well as implicit permissions - those that aren't exposed as fine-grained permissions + and can only be granted through the base role (like "reading a repo"). If you include repository permissions, those + permissions apply across all of the repositories in the organization. You do not have to include organization permissions + in order to add repository permissions. + + See "[List repository permissions](https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization)" for valid repository permissions. + + 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 permissions of `write_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/create-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#create-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-organization-role-create-schema" + examples: + default: + value: + 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 + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + 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:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" + x-github: + githubCloudOnly: true + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + + 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/enterprise-server@3.15/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 + patch: + summary: Update a custom organization role + description: |- + Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + If the update would add repository permissions, the `base_role` must also be set to a value besides `none`, either + previously or as part of the update. + If the update sets the `base_role` field to `none`, you must also remove all of the repository + permissions as well, otherwise the update will fail. + + 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 permissions of `write_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/patch-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#update-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-custom-organization-role-update-schema" + examples: + default: + value: + description: Permissions to manage custom roles within an org. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/organization-role" + 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:19:11Z' + '422': + "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: organization-roles + delete: + summary: Delete a custom organization role. + description: |- + Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + 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 permissions of `write_organization_custom_org_role` in the organization. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/delete-custom-organization-role + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/organization-roles#delete-a-custom-organization-role + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/role-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + in: query + required: false + schema: + type: string + enum: + - 2fa_disabled + - 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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" + 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. + + 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/enterprise-server@3.15/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 + - 'null' + description: Reason for approving or denying the requests. Max 1024 + characters. + maxLength: 1024 + 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. + + 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/enterprise-server@3.15/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 + - 'null' + description: Reason for approving or denying the request. Max 1024 + characters. + maxLength: 1024 + 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. + + 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/enterprise-server@3.15/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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/list-pat-grants + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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" + 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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-accesses + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + Only GitHub Apps can use this endpoint. + tags: + - orgs + operationId: orgs/update-pat-access + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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}/pre-receive-hooks": + get: + summary: List pre-receive hooks for an organization + description: List all pre-receive hooks that are enabled or testing for this + organization as well as any disabled hooks that can be configured at the organization + level. Globally disabled pre-receive hooks that do not allow downstream configuration + are not listed. + operationId: enterprise-admin/list-pre-receive-hooks-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#list-pre-receive-hooks-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + description: The sort order for the response collection. + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook for an organization + description: '' + operationId: enterprise-admin/get-pre-receive-hook-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#get-a-pre-receive-hook-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + patch: + summary: Update pre-receive hook enforcement for an organization + description: For pre-receive hooks which are allowed to be configured at the + org level, you can set `enforcement` and `allow_downstream_configuration` + operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + enforcement: + description: The state of enforcement for the hook on this repository. + type: string + allow_downstream_configuration: + description: Whether repositories can override enforcement. + type: boolean + examples: + default: + value: + enforcement: enabled + allow_downstream_configuration: false + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + delete: + summary: Remove pre-receive hook enforcement for an organization + description: Removes any overrides for this hook at the org level for this org. + operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-org + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/org-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/org-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/org-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: org-pre-receive-hooks + "/orgs/{org}/projects": + get: + summary: List organization projects + description: 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. + tags: + - projects + operationId: projects/list-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#list-organization-projects + parameters: + - "$ref": "#/components/parameters/org" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + post: + summary: Create an organization project + description: 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. + tags: + - projects + operationId: projects/create-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#create-an-organization-project + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the project. + body: + type: string + description: The description of the project. + required: + - name + examples: + default: + value: + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-2" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/get-all-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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/create-or-update-custom-properties + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/get-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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/create-or-update-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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/remove-custom-property + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + Organization members can read these properties. + tags: + - orgs + operationId: orgs/list-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 Enterprise Server. The REST API + supports the same qualifiers as the web interface for GitHub Enterprise + Server. To learn more about the format of the query, see [Constructing a + search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-server@3.15/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. + 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/create-or-update-custom-properties-values-for-repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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.) + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/rest/repos/repos#list-organization-repositories + parameters: + - "$ref": "#/components/parameters/org" + - name: type + description: Specifies the types of repositories you want returned. `internal` + is not yet supported when a GitHub App calls this endpoint with an installation + access token. + in: query + required: false + schema: + type: string + enum: + - all + - public + - private + - forks + - sources + - member + - internal + - 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. + + 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/enterprise-server@3.15/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. **Note**: For GitHub + Enterprise Server, this endpoint will only list repositories available + to all users on the enterprise. For more information, see \"[Creating + an internal repository](https://docs.github.com/enterprise-server@3.15/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" + in the GitHub Help documentation. \nThe `visibility` parameter + overrides the `private` parameter when you use both parameters + with the `nebula-preview` preview header." + enum: + - public + - private + - internal + 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 + examples: + - 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/enterprise-server@3.15/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 + "/orgs/{org}/repository-fine-grained-permissions": + get: + summary: List repository fine-grained permissions for an organization + description: |- + Lists the fine-grained permissions that can be used in custom repository roles for an organization. For more information, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)." + + The authenticated user must be an administrator of the organization or of a repository of the organization 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/list-repo-fine-grained-permissions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/orgs/custom-roles#list-repository-fine-grained-permissions-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-fine-grained-permission" + examples: + default: + "$ref": "#/components/examples/repository-fine-grained-permission-example" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: custom-roles + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/repository-rule" + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + 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" + '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. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + **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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/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* + 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" + '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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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-resolution" + - "$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" + 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}/security-managers": + get: + summary: List security manager teams + description: |- + Lists teams that are security managers for an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-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: + - orgs + operationId: orgs/list-security-manager-teams + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + previews: [] + category: orgs + subcategory: security-managers + "/orgs/{org}/security-managers/teams/{team_slug}": + put: + summary: Add a security manager team + description: |- + Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." + + The authenticated user must be an administrator 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: + - orgs + operationId: orgs/add-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + delete: + summary: Remove a security manager team + description: |- + 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/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) team from an organization." + + 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/remove-security-manager-team + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + "/orgs/{org}/settings/billing/advanced-security": + get: + summary: Get GitHub Advanced Security active committers for an organization + description: |- + Gets the GitHub Advanced Security active committers for an organization per repository. + + Each distinct user login across all repositories is counted as a single Advanced Security seat, so the `total_advanced_security_committers` is not the sum of advanced_security_committers for each repository. + + If this organization defers to an enterprise for billing, the `total_advanced_security_committers` returned from the organization API may include some users that are in more than one organization, so they will only consume a single Advanced Security seat at the enterprise level. + + The total number of repositories with committer information is tracked by the `total_count` field. + tags: + - billing + operationId: billing/get-github-advanced-security-billing-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/billing/billing#get-github-advanced-security-active-committers-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Success + content: + application/json: + schema: + "$ref": "#/components/schemas/advanced-security-active-committers" + examples: + default: + "$ref": "#/components/examples/advanced-security-active-committers" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: billing + subcategory: billing + "/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/enterprise-server@3.15/rest/teams/teams#list-teams + 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/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 IDs 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. + 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. LDAP synchronization + must be enabled to map LDAP entries to a team. Use the "[Update + LDAP mapping for a team](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team)" + endpoint to change the LDAP DN. For more information, see "[Using + LDAP](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/authenticating-users-for-your-github-enterprise-server-instance/using-ldap#enabling-ldap-sync)." + 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 + "/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 Enterprise Server 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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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 + - 'null' + description: The ID of a team to set as the parent team. + 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. + + 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/enterprise-server@3.15/rest/teams/teams#delete-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/orgs/{org}/teams/{team_slug}/discussions": + get: + summary: List discussions + description: |- + List all discussions on a team's page. + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/direction" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - name: pinned + in: query + required: false + description: Pinned discussions only filter + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + post: + summary: Create a discussion + description: |- + Creates a new discussion post on a team's page. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." + + > [!NOTE] + > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + private: + type: boolean + description: Private posts are only visible to team members, organization + owners, and team maintainers. Public posts are visible to all + members of the organization. Set to `true` to create a private + post. + default: false + required: + - title + - body + examples: + default: + value: + title: Our first team post + body: Hi! This is an area for us to collaborate as a team. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": + get: + summary: Get a discussion + description: |- + Get a specific discussion on a team's page. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + patch: + summary: Update a discussion + description: |- + Edits the title and body text of a discussion post. Only the parameters you provide are updated. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + examples: + default: + value: + title: Welcome to our first team post + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + delete: + summary: Delete a discussion + description: |- + Delete a discussion from a team's page. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": + get: + summary: List discussion comments + description: |- + List all comments on a team discussion. + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussion-comments-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$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/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + post: + summary: Create a discussion comment + description: |- + Creates a new comment on a team discussion. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like apples? + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": + get: + summary: Get a discussion comment + description: |- + Get a specific comment on a team discussion. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + patch: + summary: Update a discussion comment + description: |- + Edits the body text of a discussion comment. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like pineapples? + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + delete: + summary: Delete a discussion comment + description: |- + Deletes a comment on a team discussion. + + > [!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}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: discussion-comments + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": + get: + summary: List reactions for a team discussion comment + description: |- + List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + post: + summary: Create reaction for a team discussion comment + description: |- + Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). + + 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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) + to add to the team discussion comment. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '200': + description: Response when the reaction type has already been added to this + team discussion comment + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": + delete: + summary: Delete team discussion comment reaction + description: |- + > [!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/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/delete-for-team-discussion-comment + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-team-discussion-comment-reaction + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - "$ref": "#/components/parameters/reaction-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": + get: + summary: List reactions for a team discussion + description: |- + List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). + + > [!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`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + post: + summary: Create reaction for a team discussion + description: |- + Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). + + 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`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) + to add to the team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": + delete: + summary: Delete team discussion reaction + description: |- + > [!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/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/delete-for-team-discussion + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#delete-team-discussion-reaction + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/reaction-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: reactions + subcategory: reactions + "/orgs/{org}/teams/{team_slug}/external-groups": + get: + summary: List a connection between an external group and a team + description: |- + Lists a connection between a team and an external group. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/list-linked-external-idp-groups-to-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#list-a-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-groups" + examples: + default: + "$ref": "#/components/examples/external-groups" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: teams + subcategory: external-groups + patch: + summary: Update the connection between an external group and a team + description: |- + Creates a connection between a team and an external group. Only one external group can be linked to a team. + + You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation. + tags: + - teams + operationId: teams/link-external-idp-group-to-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + group_id: + type: integer + description: External Group Id + examples: + - 1 + required: + - group_id + examples: + default: + value: + group_id: 123 + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/external-group" + examples: + default: + "$ref": "#/components/examples/external-group" + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: teams + subcategory: external-groups + delete: + summary: Remove the connection between an external group and a team + description: |- + Deletes a connection between a team and an external group. + + You can manage team membership with your IdP using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + tags: + - teams + operationId: teams/unlink-external-idp-group-from-team-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/external-groups#remove-the-connection-between-an-external-group-and-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: teams + subcategory: external-groups + "/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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}/projects": + get: + summary: List team projects + description: |- + 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`. + tags: + - teams + operationId: teams/list-projects-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects + 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/team-project" + examples: + default: + "$ref": "#/components/examples/team-project-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": + get: + summary: Check team permissions for a project + description: |- + 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}`. + tags: + - teams + operationId: teams/check-permissions-for-project-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-project" + examples: + default: + "$ref": "#/components/examples/team-project" + '404': + description: Not Found if project is not managed by this team + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + put: + summary: Add or update team project permissions + description: |- + 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}`. + tags: + - teams + operationId: teams/add-or-update-project-permissions-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + permission: + type: string + description: 'The permission to grant to the team for this project. + Default: the team''s `permission` attribute will be used to determine + what permission to grant the team on this project. Note that, + if you choose not to pass any parameters, you''ll need to set + `Content-Length` to zero when calling this endpoint. For more + information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)."' + enum: + - read + - write + - admin + examples: + default: + summary: Updates the permissions for the team to write for the project + value: + permission: write + responses: + '204': + description: Response + '403': + description: Forbidden if the project is not owned by the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-the-project-is-not-owned-by-the-organization: + value: + message: Must have admin rights to Repository. + documentation_url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + delete: + summary: Remove a project from a team + description: |- + 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}`. + tags: + - teams + operationId: teams/remove-project-in-org + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/team-slug" + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: teams + subcategory: teams + "/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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}`. + + > [!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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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 + "/projects/columns/cards/{card_id}": + get: + summary: Get a project card + description: Gets information about a project card. + tags: + - projects + operationId: projects/get-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/cards#get-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '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: cards + patch: + summary: Update an existing project card + description: '' + tags: + - projects + operationId: projects/update-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/cards#update-an-existing-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + note: + description: The project card's note + type: + - string + - 'null' + examples: + - Update all gems + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + examples: + default: + summary: Change the note on the card + value: + note: Add payload for delete Project column + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + delete: + summary: Delete a project card + description: Deletes a project card + tags: + - projects + operationId: projects/delete-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/cards#delete-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + responses: + '204': + description: Response + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/cards/{card_id}/moves": + post: + summary: Move a project card + description: '' + tags: + - projects + operationId: projects/move-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/cards#move-a-project-card + parameters: + - "$ref": "#/components/parameters/card-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + position: + description: 'The position of the card in a column. Can be one of: + `top`, `bottom`, or `after:` to place after the specified + card.' + type: string + pattern: "^(?:top|bottom|after:\\d+)$" + examples: + - bottom + column_id: + description: The unique identifier of the column the card should + be moved to + type: integer + examples: + - 42 + required: + - position + type: object + examples: + default: + summary: Move the card to the bottom of the column + value: + column_id: 42 + position: bottom + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + default: + value: + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + resource: + type: string + field: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '503': + description: Response + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/{column_id}": + get: + summary: Get a project column + description: Gets information about a project column. + tags: + - projects + operationId: projects/get-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/columns#get-a-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + patch: + summary: Update an existing project column + description: '' + tags: + - projects + operationId: projects/update-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/columns#update-an-existing-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + required: + - name + type: object + examples: + default: + summary: Rename the project column + value: + name: To Do + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column" + '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: columns + delete: + summary: Delete a project column + description: Deletes a project column. + tags: + - projects + operationId: projects/delete-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/columns#delete-a-project-column + parameters: + - "$ref": "#/components/parameters/column-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: true + category: projects + subcategory: columns + "/projects/columns/{column_id}/cards": + get: + summary: List project cards + description: Lists the project cards in a project. + tags: + - projects + operationId: projects/list-cards + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/cards#list-project-cards + parameters: + - "$ref": "#/components/parameters/column-id" + - name: archived_state + description: Filters the project cards that are returned by the card's state. + in: query + required: false + schema: + type: string + enum: + - all + - archived + - not_archived + default: not_archived + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card-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: cards + post: + summary: Create a project card + description: '' + tags: + - projects + operationId: projects/create-card + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/cards#create-a-project-card + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - type: object + properties: + note: + description: The project card's note + type: + - string + - 'null' + examples: + - Update all gems + required: + - note + - type: object + properties: + content_id: + description: The unique identifier of the content associated with + the card + type: integer + examples: + - 42 + content_type: + description: The piece of content associated with the card + type: string + examples: + - PullRequest + required: + - content_id + - content_type + examples: + default: + summary: Create a new card + value: + note: Add payload for delete Project column + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-card" + examples: + default: + "$ref": "#/components/examples/project-card" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + description: Validation failed + content: + application/json: + schema: + oneOf: + - "$ref": "#/components/schemas/validation-error" + - "$ref": "#/components/schemas/validation-error-simple" + '503': + description: Response + content: + application/json: + schema: + type: object + properties: + code: + type: string + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: object + properties: + code: + type: string + message: + type: string + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: cards + "/projects/columns/{column_id}/moves": + post: + summary: Move a project column + description: '' + tags: + - projects + operationId: projects/move-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/columns#move-a-project-column + parameters: + - "$ref": "#/components/parameters/column-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + position: + description: 'The position of the column in a project. Can be one + of: `first`, `last`, or `after:` to place after the + specified column.' + type: string + pattern: "^(?:first|last|after:\\d+)$" + examples: + - last + required: + - position + type: object + examples: + default: + summary: Move the column to the end of the board + value: + position: last + responses: + '201': + description: Response + content: + application/json: + schema: + type: object + properties: {} + additionalProperties: false + examples: + default: + value: + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + "/projects/{project_id}": + get: + summary: Get a project + description: 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. + tags: + - projects + operationId: projects/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#get-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '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 + patch: + summary: Update a project + description: 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. + operationId: projects/update + tags: + - projects + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#update-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + properties: + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + state: + description: State of the project; either 'open' or 'closed' + type: string + examples: + - open + organization_permission: + description: The baseline permission that all organization members + have on this project + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. + type: boolean + type: object + examples: + default: + summary: Change the name, state, and permissions for a project + value: + name: Week One Sprint + state: open + organization_permission: write + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '404': + description: Not Found if the authenticated user does not have access to + the project + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + delete: + summary: Delete a project + description: Deletes a project board. Returns a `404 Not Found` status if projects + are disabled. + operationId: projects/delete + tags: + - projects + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#delete-a-project + parameters: + - "$ref": "#/components/parameters/project-id" + responses: + '204': + description: Delete Success + '304': + "$ref": "#/components/responses/not_modified" + '403': + description: Forbidden + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + errors: + type: array + items: + type: string + '401': + "$ref": "#/components/responses/requires_authentication" + '410': + "$ref": "#/components/responses/gone" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/projects/{project_id}/collaborators": + get: + summary: List project collaborators + description: 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. + tags: + - projects + operationId: projects/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#list-project-collaborators + parameters: + - "$ref": "#/components/parameters/project-id" + - name: affiliation + description: Filters the collaborators by their affiliation. `outside` means + outside collaborators of a project that are not a member of the project's + organization. `direct` means collaborators with permissions to a project, + 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 + - "$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" + '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: projects + subcategory: collaborators + "/projects/{project_id}/collaborators/{username}": + put: + summary: Add project collaborator + description: 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. + tags: + - projects + operationId: projects/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#add-project-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + permission: + description: The permission to grant the collaborator. + enum: + - read + - write + - admin + default: write + type: string + examples: + - write + examples: + default: + summary: Applying write permissions for the new collaborator + value: + permission: write + 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: true + category: projects + subcategory: collaborators + delete: + summary: Remove user as a collaborator + description: Removes a collaborator from an organization project. You must be + an organization owner or a project `admin` to remove a collaborator. + tags: + - projects + operationId: projects/remove-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#remove-user-as-a-collaborator + parameters: + - "$ref": "#/components/parameters/project-id" + - "$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" + '422': + "$ref": "#/components/responses/validation_failed" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: collaborators + "/projects/{project_id}/collaborators/{username}/permission": + get: + summary: Get project permission for a user + description: '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.' + tags: + - projects + operationId: projects/get-permission-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/collaborators#get-project-permission-for-a-user + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/username" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-collaborator-permission" + examples: + default: + "$ref": "#/components/examples/project-collaborator-permission" + '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: true + category: projects + subcategory: collaborators + "/projects/{project_id}/columns": + get: + summary: List project columns + description: Lists the project columns in a project. + tags: + - projects + operationId: projects/list-columns + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/columns#list-project-columns + parameters: + - "$ref": "#/components/parameters/project-id" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project-column" + examples: + default: + "$ref": "#/components/examples/project-column-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: columns + post: + summary: Create a project column + description: Creates a new project column. + tags: + - projects + operationId: projects/create-column + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/columns#create-a-project-column + parameters: + - "$ref": "#/components/parameters/project-id" + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + required: + - name + type: object + examples: + default: + value: + name: Remaining tasks + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project-column" + examples: + default: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '422': + "$ref": "#/components/responses/validation_failed_simple" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: columns + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + tags: + - repos + operationId: repos/get + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/rest/repos/repos#replace-all-repository-topics) + endpoint." + tags: + - repos + operationId: repos/update + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - internal + security_and_analysis: + type: + - object + - 'null' + 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/enterprise-server@3.15/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. + 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)." + 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_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`. + 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 + 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" + '422': + "$ref": "#/components/responses/validation_failed" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + previews: + - required: false + name: nebula + note: |- + You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.15/rest/repos), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/). + + To access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + ```shell + application/vnd.github.nebula-preview+json + ``` + - required: false + name: baptiste + note: |- + The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.15/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + + ```shell + application/vnd.github.baptiste-preview+json + ``` + 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/repos/repos#delete-a-repository + '307': + "$ref": "#/components/responses/temporary_redirect" + '404': + "$ref": "#/components/responses/not_found" + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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/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/enterprise-server@3.15/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/cache/usage-policy": + get: + summary: Get GitHub Actions cache usage policy for a repository + description: |- + Gets GitHub Actions cache usage policy 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-usage-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/cache#get-github-actions-cache-usage-policy-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-policy-for-repository" + examples: + default: + "$ref": "#/components/examples/actions-cache-usage-policy" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: cache + patch: + summary: Set GitHub Actions cache usage policy for a repository + description: |- + Sets GitHub Actions cache usage policy for a repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/set-actions-cache-usage-policy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/actions/cache#set-github-actions-cache-usage-policy-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-cache-usage-policy-for-repository" + examples: + selected_actions: + "$ref": "#/components/examples/actions-cache-usage-policy" + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + '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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 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. + operationId: actions/get-github-actions-permissions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 in the repository. + + If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for 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/enterprise-server@3.15/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" + required: + - enabled + examples: + default: + value: + enabled: true + allowed_actions: selected + 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 internal and private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/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)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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/enterprise-server@3.15/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. + This endpoint only applies to internal and private repositories. + For more information, see "[Allowing access to components in a private repository](https://docs.github.com/enterprise-server@3.15/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)" and + "[Allowing access to components in an internal repository](https://docs.github.com/enterprise-server@3.15/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-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/enterprise-server@3.15/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/selected-actions": + get: + summary: Get allowed actions for a repository + description: |- + Gets the settings for selected actions 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. + operationId: actions/get-allowed-actions-repository + tags: + - actions + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 for a repository + description: |- + Sets the actions 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)." + + If the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings. + + To use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories. + + 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/enterprise-server@3.15/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, + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 + can submit approving pull request reviews. + For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 or enterprise + 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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-airgap" + 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/enterprise-server@3.15/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" + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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" + 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. + + 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/enterprise-server@3.15/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 + about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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`. + + 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/enterprise-server@3.15/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: + '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/enterprise-server@3.15/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/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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: + '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 + about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + `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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + items: + type: integer + examples: + - 161171787 + examples: + - 161171787 + - 161171795 + state: + type: string + description: Whether to approve or reject deployment to the specified + environments. + enum: + - approved + - rejected + examples: + - approved + comment: + type: string + description: A comment to accompany the deployment review + examples: + - 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`. + + 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/enterprise-server@3.15/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + 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/enterprise-server@3.15/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 + - 'null' + 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: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + 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: + '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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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`. + + 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/enterprise-server@3.15/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`. + + 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/enterprise-server@3.15/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: 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 10. Any default properties + configured in the workflow file will be used when `inputs` are + omitted. + additionalProperties: true + maxProperties: 10 + 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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/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/enterprise-server@3.15/repositories/viewing-activity-and-data-for-your-repository)." + tags: + - repos + operationId: repos/list-activities + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + "/repos/{owner}/{repo}/assignees": + get: + summary: List assignees + description: Lists the [available assignees](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 automated security fixes are enabled for a repository + description: 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/enterprise-server@3.15/articles/configuring-automated-security-fixes)". + tags: + - repos + operationId: repos/check-automated-security-fixes + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/repos#check-if-automated-security-fixes-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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + description: Require status checks to pass before merging. Set to + `null` to disable. + 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 + - 'null' + description: Enforce all configured restrictions for administrators. + Set to `true` to enforce required status checks for repository + administrators. Set to `null` to disable. + required_pull_request_reviews: + type: + - object + - 'null' + description: Require at least one approving review on a pull request, + before merging. Set to `null` to disable. + 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/enterprise-server@3.15/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 + - 'null' + 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. + 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/enterprise-server@3.15/github/administering-a-repository/requiring-a-linear-commit-history)" + in the GitHub Help documentation.' + allow_force_pushes: + type: + - boolean + - 'null' + 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/enterprise-server@3.15/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" + in the GitHub Help documentation."' + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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`. + + > [!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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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`. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/enterprise-server@3.15/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/rerequest-run + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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: + '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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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`. + + > [!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/enterprise-server@3.15/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`. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. + tags: + - checks + operationId: checks/rerequest-suite + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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: + 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/enterprise-server@3.15/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/direction" + - 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" + 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. + + 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/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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" + required: + - state + 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. + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/code-scanning-alert" + examples: + default: + "$ref": "#/components/examples/code-scanning-alert-dismissed" + '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}/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/enterprise-server@3.15/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" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/code-scanning-alert-instance" + 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, + 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/enterprise-server@3.15/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" + - 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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/json+sarif: + 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" + '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. + + 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/enterprise-server@3.15/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 + - 'null' + 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/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + '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" + '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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + type: string + format: uri + examples: + - file:///github/workspace/ + 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 + 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)." + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + file. + + For more information about the correct CODEOWNERS syntax, + see "[About code owners](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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}/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. + 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. + + 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/list-collaborators + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: |- + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." + + **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. + tags: + - repos + operationId: repos/add-collaborator + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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.** + default: push + examples: + new-invitation-is-created: + summary: Add a collaborator with triage permissions + value: + permission: triage + responses: + '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': + "$ref": "#/components/responses/validation_failed" + '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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 of a collaborator. The possible repository + permissions are `admin`, `write`, `read`, and `none`. + + *Note*: 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`. To determine the role assigned to the + collaborator, see the `role_name` attribute, which will provide the full role name, including custom roles. The + `permissions` hash can also be used to determine which base level of access the collaborator has to the repository. + tags: + - repos + operationId: repos/get-collaborator-permission-level + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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** + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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`. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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, will only return 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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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" + '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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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. + + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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" + '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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + responses: + '200': + description: Response + content: + application/vnd.github.object: + schema: + "$ref": "#/components/schemas/content-tree" + 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-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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - '"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 + examples: + - '"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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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-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-scope" + - "$ref": "#/components/parameters/dependabot-alert-sort" + - "$ref": "#/components/parameters/direction" + - name: page + description: "**Closing down notice**. Page number of the results to fetch. + Use cursor-based pagination with `before` or `after` instead." + deprecated: true + 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/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + deprecated: true + in: query + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + required: + - state + 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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: + '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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + default: none + - "$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. + + The `ref` parameter can be any named branch, tag, or SHA. At GitHub Enterprise Server 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + description: Short description of the deployment. + default: '' + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + "/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/enterprise-server@3.15/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 Enterprise Server 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + type: integer + examples: + - 5 + 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] + > 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/enterprise-server@3.15/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)." + + > [!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/enterprise-server@3.15/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 + - 'null' + properties: + wait_timer: + "$ref": "#/components/schemas/wait-timer" + prevent_self_review: + "$ref": "#/components/schemas/prevent-self-review" + reviewers: + type: + - array + - 'null' + 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 + examples: + - 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + examples: + - 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - 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. + + 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/enterprise-server@3.15/rest/apps/apps#get-an-app). + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: + '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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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 Enterprise Server 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/enterprise-server@3.15/rest/repos/forks#create-a-fork + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + 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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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). + + **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/enterprise-server@3.15/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 + '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). + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!NOTE] + > You need to explicitly [request a pull request](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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': + "$ref": "#/components/responses/validation_failed" + '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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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** + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/rest/git/commits#create-a-commit)" and "[Update a reference](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + 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." + 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: + "$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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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 + - 'null' + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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)." + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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" + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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/enterprise-server@3.15/articles/disabling-issues/), the API returns a `410 Gone` status. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + 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.**_' + 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._' + type: + - 'null' + - string + - integer + 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 + - 'null' + color: + type: + - string + - 'null' + 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 + 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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/reactions": + get: + summary: List reactions for an issue comment + description: List the reactions to an [issue comment](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was + [transferred](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: + "$ref": "#/components/examples/issue" + '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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + type: + - 'null' + - string + - integer + body: + type: + - string + - 'null' + description: The contents of the issue. + assignee: + type: + - string + - 'null' + 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 + - 'null' + enum: + - completed + - not_planned + - reopened + - + description: The reason for the state change. Ignored unless `state` + is changed. + examples: + - 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. + type: + - 'null' + - string + - integer + 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 + - 'null' + color: + type: + - string + - 'null' + 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 + 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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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. If you provide an empty array of labels, + all labels are removed from the issue. ' + tags: + - issues + operationId: issues/add-labels + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 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 replace all of the labels for an issue. For + more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.15/rest/issues/labels#set-labels-for-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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + 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/enterprise-server@3.15/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}/reactions": + get: + summary: List reactions for an issue + description: List the reactions to an [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/list-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: false + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue). + tags: + - reactions + operationId: reactions/delete-for-issue + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/articles/repository-permission-levels-for-an-organization/)\" + and \"[Permission levels for a user account repository](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/lfs": + put: + summary: Enable Git LFS for a repository + description: |- + Enables Git LFS for a repository. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: repos/enable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/lfs#enable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '202': + "$ref": "#/components/responses/accepted" + '403': + description: |- + We will return a 403 with one of the following messages: + + - Git LFS support not enabled because Git LFS is globally disabled. + - Git LFS support not enabled because Git LFS is disabled for the root repository in the network. + - Git LFS support not enabled because Git LFS is disabled for . + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: repos + subcategory: lfs + delete: + summary: Disable Git LFS for a repository + description: |- + Disables Git LFS for a repository. + + OAuth app tokens and personal access tokens (classic) need the `admin:enterprise` scope to use this endpoint. + operationId: repos/disable-lfs-for-repo + tags: + - repos + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/lfs#disable-git-lfs-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '204': + description: Response + x-github: + githubCloudOnly: true + enabledForGitHubApps: false + category: repos + subcategory: lfs + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server Pages site + description: |- + Gets information about a GitHub Enterprise Server 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/enterprise-server@3.15/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 Enterprise Server Pages site + description: |- + Configures a GitHub Enterprise Server 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/enterprise-server@3.15/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 + - 'null' + description: The source branch and directory used to publish your Pages + site. + 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 Enterprise Server Pages site + description: |- + Updates information for a GitHub Enterprise Server 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/enterprise-server@3.15/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 + - 'null' + 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/enterprise-server@3.15/pages/configuring-a-custom-domain-for-your-github-pages-site)." + 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 Enterprise Server Pages site + description: |- + Deletes a GitHub Enterprise Server 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/enterprise-server@3.15/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 Enterprise Server Pages builds + description: |- + Lists builts of a GitHub Enterprise Server 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/enterprise-server@3.15/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 Enterprise Server 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/enterprise-server@3.15/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 Enterprise Server 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/enterprise-server@3.15/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 Enterprise Server Pages build + description: |- + Gets information about a GitHub Enterprise Server 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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_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. + 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: + - artifact_url + - 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 + preview: false + 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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}/pre-receive-hooks": + get: + summary: List pre-receive hooks for a repository + description: List all pre-receive hooks that are enabled or testing for this + repository as well as any disabled hooks that are allowed to be enabled at + the repository level. Pre-receive hooks that are disabled at a higher level + and are not configurable will not be listed. + operationId: enterprise-admin/list-pre-receive-hooks-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#list-pre-receive-hooks-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + - "$ref": "#/components/parameters/direction" + - name: sort + in: query + required: false + schema: + type: string + enum: + - created + - updated + - name + default: created + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook-items" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": + get: + summary: Get a pre-receive hook for a repository + description: '' + operationId: enterprise-admin/get-pre-receive-hook-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#get-a-pre-receive-hook-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + patch: + summary: Update pre-receive hook enforcement for a repository + description: For pre-receive hooks which are allowed to be configured at the + repo level, you can set `enforcement` + operationId: enterprise-admin/update-pre-receive-hook-enforcement-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook-2" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + enforcement: + description: The state of enforcement for the hook on this repository. + type: string + enum: + - enabled + - disabled + - testing + examples: + default: + value: + enforcement: enabled + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + delete: + summary: Remove pre-receive hook enforcement for a repository + description: |- + Deletes any overridden enforcement on this repository for the specified hook. + + Responds with effective values inherited from owner and/or global level. + operationId: enterprise-admin/remove-pre-receive-hook-enforcement-for-repo + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/repo-pre-receive-hooks#remove-pre-receive-hook-enforcement-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pre-receive-hook-id" + responses: + '200': + description: Responds with effective values inherited from owner and/or + global level. + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-pre-receive-hook" + examples: + default: + "$ref": "#/components/examples/repository-pre-receive-hook" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: enterprise-admin + subcategory: repo-pre-receive-hooks + "/repos/{owner}/{repo}/projects": + get: + summary: List repository projects + description: 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. + tags: + - projects + operationId: projects/list-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#list-repository-projects + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items-2" + headers: + Link: + "$ref": "#/components/headers/link" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + post: + summary: Create a repository project + description: 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. + tags: + - projects + operationId: projects/create-for-repo + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#create-a-repository-project + 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 project. + body: + type: string + description: The description of the project. + required: + - name + examples: + default: + value: + name: Projects Documentation + body: Developer documentation project for the developer site. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-3" + '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_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/get-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + 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/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - 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/enterprise-server@3.15/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/enterprise-server@3.15/articles/about-pull-requests#draft-pull-requests)" + in the GitHub Help documentation to learn more. + issue: + type: integer + format: int64 + 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. + examples: + - 1 + 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, + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/pulls/pulls/#create-a-pull-request), or [edit](https://docs.github.com/enterprise-server@3.15/rest/pulls/pulls#update-a-pull-request) a pull request, GitHub Enterprise Server 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/enterprise-server@3.15/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 Enterprise Server 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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. + examples: + - 2 + 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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/enterprise-server@3.15/rest/commits/commits#list-commits) + endpoint. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." + tags: + - pulls + operationId: pulls/merge + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + - 'null' + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - 28 + side: + type: string + examples: + - RIGHT + start_line: + type: integer + examples: + - 26 + start_side: + type: string + examples: + - 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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + > [!NOTE] + > To dismiss a pull request review on a [protected branch](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + enum: + - DISMISS + examples: + - '"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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + 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/enterprise-server@3.15/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 + - 'null' + 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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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 + '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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - '"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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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" + 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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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" + 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/enterprise-server@3.15/rest/releases/releases#delete-a-release + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/release-id" + responses: + '204': + description: Response + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server renames asset filenames that have special characters, + non-alphanumeric characters, and leading or trailing periods. The \"[List + release assets](https://docs.github.com/enterprise-server@3.15/rest/releases/assets#list-release-assets)\"\nendpoint + lists the renamed filenames. For more information and help, contact [GitHub + Enterprise Server 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/releases/assets#upload-a-release-asset + servers: + - url: https://HOSTNAME/api/uploads + 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/enterprise-server@3.15/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/list-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/rest/releases/releases#get-a-release). + tags: + - reactions + operationId: reactions/delete-for-release + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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}/replicas/caches": + get: + summary: List repository cache replication status + description: Lists the status of each repository cache replica. + tags: + - repos + operationId: repos/list-cache-info + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/repos#list-repository-cache-replication-status + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Status information for cache replicas + content: + application/json: + schema: + type: array + items: + description: Status for a cache replica + type: object + properties: + host: + type: string + location: + type: string + git: + type: object + properties: + sync_status: + type: string + enum: + - offline + - inactive + - in_sync + - not_in_sync + last_sync: + type: string + format: date-time + required: + - sync_status + - last_sync + required: + - host + - location + - git + examples: + default: + value: + - host: host-1 + location: berlin + git: + - sync_status: in_sync + - last_sync: '2022-01-10T19:33:52Z' + - host: host-2 + location: chicago + git: + - sync_status: offline + - last_sync: '2022-01-10T19:34:12Z' + headers: + Link: + "$ref": "#/components/headers/link" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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" + '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. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + **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/enterprise-server@3.15/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/enterprise-server@3.15/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" + '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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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-resolution" + - "$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" + 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. + + 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/enterprise-server@3.15/rest/secret-scanning/secret-scanning#get-a-secret-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/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. + + 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/enterprise-server@3.15/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" + required: + - state + examples: + default: + value: + state: resolved + resolution: false_positive + 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 + '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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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}/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + tags: + - repos + operationId: repos/get-code-frequency-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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" + 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/enterprise-server@3.15/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: |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 + tags: + - repos + operationId: repos/get-contributors-stats + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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`. + + 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/enterprise-server@3.15/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: + + * `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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/activity/watching#set-a-repository-subscription). + tags: + - activity + operationId: activity/delete-repo-subscription + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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}/tags/protection": + get: + summary: Closing down - List tag protection states for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + + This returns the tag protection states of a repository. + + This information is only available to repository administrators. + tags: + - repos + operationId: repos/list-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/tags#closing-down---list-tag-protection-states-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/tag-protection" + examples: + default: + "$ref": "#/components/examples/tag-protection-items" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + post: + summary: Closing down - Create a tag protection state for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + + This creates a tag protection state for a repository. + This endpoint is only available to repository administrators. + tags: + - repos + operationId: repos/create-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/tags#closing-down---create-a-tag-protection-state-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + pattern: + type: string + description: An optional glob pattern to match against when enforcing + tag protection. + required: + - pattern + examples: + default: + value: + pattern: v1.* + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/tag-protection" + examples: + default: + "$ref": "#/components/examples/tag-protection" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + "/repos/{owner}/{repo}/tags/protection/{tag_protection_id}": + delete: + summary: Closing down - Delete a tag protection state for a repository + description: |- + > [!WARNING] + > **Closing down notice:** This operation is closing down and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/enterprise-server@3.15/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + + This deletes a tag protection state for a repository. + This endpoint is only available to repository administrators. + tags: + - repos + operationId: repos/delete-tag-protection + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/repos/tags#closing-down---delete-a-tag-protection-state-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/tag-protection-id" + responses: + '204': + description: Response + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: tags + deprecationDate: '2024-05-29' + removalDate: '2024-08-30' + deprecated: true + "/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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` cannot contain uppercase letters. + 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}/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/enterprise-server@3.15/articles/about-repository-transfers/). + tags: + - repos + operationId: repos/transfer + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/check-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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: false + 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/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/enable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 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/enterprise-server@3.15/articles/about-security-alerts-for-vulnerable-dependencies)". + tags: + - repos + operationId: repos/disable-vulnerability-alerts + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + `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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + previews: + - required: true + name: baptiste + note: |- + Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types) in the `Accept` header: + + ```shell + application/vnd.github.baptiste-preview+json + ``` + "/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/repos/repos#list-public-repositories + parameters: + - "$ref": "#/components/parameters/since-repo" + - name: visibility + description: Specifies the types of repositories to return. This endpoint + will only list repositories available to all users on the enterprise. + in: query + required: false + schema: + type: string + default: public + enum: + - all + - public + examples: + - all + 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 + "/scim/v2/enterprises/{enterprise}/Groups": + get: + summary: List provisioned SCIM groups for an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Lists provisioned SCIM groups in an enterprise. + + You can improve query search time by using the `excludedAttributes` query parameter with a value of `members` to exclude members from the response. + operationId: enterprise-admin/list-provisioned-groups-enterprise + tags: + - enterprise-admin + - scim + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#list-provisioned-scim-groups-for-an-enterprise + parameters: + - name: filter + description: If specified, only results that match the specified filter will + be returned. Multiple filters are not supported. Possible filters are `externalId`, + `id`, and `displayName`. For example, `?filter="externalId eq '9138790-10932-109120392-12321'"`. + in: query + required: false + schema: + type: string + examples: + displayName: + value: Engineering + externalId: + value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + - "$ref": "#/components/parameters/excluded-attributes" + - "$ref": "#/components/parameters/start-index" + - "$ref": "#/components/parameters/count" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, either groups were found or not found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-list" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group-list" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Creates a SCIM group for an enterprise. + + If members are included as part of the group provisioning payload, they will be created as external group members. It is up to a provider to store a mapping between the `externalId` and `id` of each user. + operationId: enterprise-admin/provision-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#provision-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/group" + examples: + group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + responses: + '201': + description: Group has been created + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + group: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}": + get: + summary: Get SCIM provisioning information for an enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Gets information about a SCIM group. + operationId: enterprise-admin/get-provisioning-information-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/excluded-attributes" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, a group was found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Replaces an existing provisioned group’s information. + + You must provide all the information required for the group as if you were provisioning it for the first time. Any existing group information that you don't provide will be removed, including group membership. If you want to only update a specific attribute, use the [Update an attribute for a SCIM enterprise group](#update-an-attribute-for-a-scim-enterprise-group) endpoint instead. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/group" + examples: + group: + summary: Group + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + groupWithMembers: + summary: Group with member + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + responses: + '200': + description: Group was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + group: + "$ref": "#/components/examples/scim-enterprise-group" + groupWithMembers: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise group + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Update a provisioned group’s individual attributes. + + To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships. + + Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here. + operationId: enterprise-admin/update-attribute-for-enterprise-group + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/patch-schema" + examples: + updateGroup: + summary: Update Group + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: displayName + value: Employees + addMembers: + summary: Add Members + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: add + path: members + value: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + responses: + '204': + description: Response + '200': + description: Success, group was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-group-response" + examples: + updateGroup: + "$ref": "#/components/examples/scim-enterprise-group" + addMembers: + "$ref": "#/components/examples/scim-enterprise-group" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM group from an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Deletes a SCIM group from an enterprise. + operationId: enterprise-admin/delete-scim-group-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#delete-a-scim-group-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/scim-group-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: Group was deleted, no content + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users": + get: + summary: List SCIM provisioned identities for an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Lists provisioned SCIM enterprise members. + + When a user with a SCIM-provisioned external identity is removed from an enterprise through a `patch` with `active` flag set to `false`, the account's metadata is preserved to allow the user to re-join the enterprise in the future. However, the user's account will be suspended and the user will not be able to sign-in. In order to permanently suspend the users account with no ability to re-join the enterprise in the future, use the `delete` request. Users that were not permanently deleted will be visible in the returned results. + operationId: enterprise-admin/list-provisioned-identities-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#list-scim-provisioned-identities-for-an-enterprise + parameters: + - name: filter + description: If specified, only results that match the specified filter will + be returned. Multiple filters are not supported. Possible filters are `userName`, + `externalId`, `id`, and `displayName`. For example, `?filter="externalId + eq '9138790-10932-109120392-12321'"`. + in: query + required: false + schema: + type: string + examples: + userName: + value: userName eq 'E012345' + externalId: + value: externalId eq 'E012345' + - "$ref": "#/components/parameters/start-index" + - "$ref": "#/components/parameters/count" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, either users were found or not found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-list" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-user-list" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + post: + summary: Provision a SCIM enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Creates an external identity for a new SCIM enterprise user. + + SCIM does not authenticate users, it only provisions them. The authentication of users is done by SAML. However, when SCIM is enabled, all users need to be provisioned through SCIM before a user can sign in through SAML. The matching of a user to a SCIM provisioned user is done when the SAML assertion is consumed. The user will be matched on SAML response `NameID` to SCIM `userName`. + + When converting existing enterprise to use SCIM, the user handle (`userName`) from the SCIM payload will be used to match the provisioned user to an already existing user in the enterprise. Since the new identity record is created for newly provisioned users the matching for those records is done using a user's handle. Currently the matching will be performed to all of the users no matter if they were SAML JIT provisioned or created as local users. + operationId: enterprise-admin/provision-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#provision-a-scim-enterprise-user + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/user" + examples: + user: + "$ref": "#/components/examples/in-user" + enterpriseOwner: + "$ref": "#/components/examples/in-user-owner" + responses: + '201': + description: User has been created + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + user: + "$ref": "#/components/examples/scim-enterprise-user" + enterpriseOwner: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/scim/v2/enterprises/{enterprise}/Users/{scim_user_id}": + get: + summary: Get SCIM provisioning information for an enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Gets information about a SCIM user. + operationId: enterprise-admin/get-provisioning-information-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#get-scim-provisioning-information-for-an-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '200': + description: Success, a user was found + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + default: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + put: + summary: Set SCIM information for a provisioned enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Replaces an existing provisioned user's information. + + You must provide all the information required for the user as if you were provisioning them for the first time. Any existing user information that you don't provide will be removed. If you want to only update a specific attribute, use the [Update an attribute for a SCIM user](#update-an-attribute-for-a-scim-enterprise-user) endpoint instead. + + > [!WARNING] + > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + operationId: enterprise-admin/set-information-for-provisioned-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#set-scim-information-for-a-provisioned-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/user" + examples: + user: + "$ref": "#/components/examples/in-user" + responses: + '200': + description: User was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + user: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + patch: + summary: Update an attribute for a SCIM enterprise user + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Update a provisioned user's individual attributes. + + To change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). + + > [!NOTE] + > Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `"path": "emails[type eq \"work\"]"` will not work. + + > [!WARNING] + > Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed. + > ``` + > { + > "Operations":[{ + > "op":"replace", + > "value":{ + > "active":false + > } + > }] + > } + > ``` + operationId: enterprise-admin/update-attribute-for-enterprise-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/patch-schema" + examples: + userMultiValuedProperties: + summary: Multi Valued Property + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: emails[type eq 'work'].value + value: updatedEmail@microsoft.com + - op: replace + path: name.familyName + value: updatedFamilyName + userSingleValuedProperties: + summary: Single Valued Property + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: userName + value: 5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com + - op: replace + path: displayName + value: Monalisa Octocat + disableUser: + summary: Disable User + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + Operations: + - op: replace + path: active + value: false + responses: + '200': + description: Success, user was updated + content: + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-enterprise-user-response" + examples: + userMultiValuedProperties: + "$ref": "#/components/examples/scim-enterprise-user" + userSingleValuedProperties: + "$ref": "#/components/examples/scim-enterprise-user" + disableUser: + "$ref": "#/components/examples/scim-enterprise-user" + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/duplicate_record_detected" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + delete: + summary: Delete a SCIM user from an enterprise + description: |- + > [!NOTE] + > The SCIM API endpoints for enterprise accounts are currently in private preview and are subject to change. + + Permanently suspends a SCIM user from an enterprise, removes all data for the user, obfuscates the login, email, and display name of the user, removes all external-identity SCIM attributes, and deletes the emails, avatar, PATs, SSH keys, OAuth authorizations credentials, GPG keys, and SAML mappings for the user. You will not be able to undo this action. + operationId: enterprise-admin/delete-user-from-enterprise + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/scim#delete-a-scim-user-from-an-enterprise + parameters: + - "$ref": "#/components/parameters/scim-user-id" + - "$ref": "#/components/parameters/enterprise" + responses: + '204': + description: User was deleted, no content + '400': + "$ref": "#/components/responses/scim_bad_request" + '401': + "$ref": "#/components/responses/authorization_failure" + '403': + "$ref": "#/components/responses/permission_denied" + '404': + "$ref": "#/components/responses/not_found" + '429': + "$ref": "#/components/responses/scim_too_many_requests" + '500': + "$ref": "#/components/responses/scim_internal_error" + x-github: + enabledForGitHubApps: true + githubCloudOnly: true + category: enterprise-admin + subcategory: scim + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + tags: + - search + operationId: search/code + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). + See "[Searching code](https://docs.github.com/enterprise-server@3.15/search-github/searching-on-github/searching-code)" + for a detailed list of qualifiers. + in: query + required: true + schema: + type: string + - name: sort + description: 'Sorts the results of your query. Can only be `indexed`, which + indicates how recently a file has been indexed by the GitHub Enterprise + Server search infrastructure. Default: [best match](https://docs.github.com/enterprise-server@3.15/rest/search/search#ranking-search-results)' + in: query + required: false + schema: + type: string + enum: + - indexed + - 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 + - "$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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). + See "[Searching commits](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). + See "[Searching issues and pull requests](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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" + 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/issue-search-result-item" + examples: + default: + "$ref": "#/components/examples/issue-search-result-item-paginated" + '503': + "$ref": "#/components/responses/service_unavailable" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). + See "[Searching for repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api). See "[Searching topics](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/search/search#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/queries#search)." + tags: + - search + operationId: search/users + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 Enterprise + Server. The REST API supports the same qualifiers as the web interface for + GitHub Enterprise Server. To learn more about the format of the query, see + [Constructing a search query](https://docs.github.com/enterprise-server@3.15/rest/search/search#constructing-a-search-query). + See "[Searching users](https://docs.github.com/enterprise-server@3.15/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 Enterprise Server. Default: + [best match](https://docs.github.com/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - 'null' + description: The ID of a team to set as the parent team. + 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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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}/discussions": + get: + summary: List discussions (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 discussions`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions) endpoint. + + List all discussions on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#list-discussions-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$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/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + post: + summary: Create a discussion (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 [`Create a discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion) endpoint. + + Creates a new discussion post on a team's page. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#create-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + private: + type: boolean + description: Private posts are only visible to team members, organization + owners, and team maintainers. Public posts are visible to all + members of the organization. Set to `true` to create a private + post. + default: false + required: + - title + - body + examples: + default: + value: + title: Our first team post + body: Hi! This is an area for us to collaborate as a team. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}": + get: + summary: Get a discussion (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 a discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion) endpoint. + + Get a specific discussion on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + patch: + summary: Update a discussion (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 discussion](https://docs.github.com/enterprise-server@3.15/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 app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#update-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + title: + type: string + description: The discussion post's title. + body: + type: string + description: The discussion post's body text. + examples: + default: + value: + title: Welcome to our first team post + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion" + examples: + default: + "$ref": "#/components/examples/team-discussion-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + delete: + summary: Delete a discussion (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 discussion`](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion) endpoint. + + Delete a discussion from a team's page. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#delete-a-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments": + get: + summary: List discussion comments (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 discussion comments](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments) endpoint. + + List all comments on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/list-discussion-comments-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#list-discussion-comments-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$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/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + post: + summary: Create a discussion comment (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 [Create a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + + Creates a new comment on a team discussion. + + This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/guides/best-practices-for-using-the-rest-api)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/create-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#create-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like apples? + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + triggersNotification: true + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": + get: + summary: Get a discussion comment (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 a discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + + Get a specific comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/get-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + patch: + summary: Update a discussion comment (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 discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + + Edits the body text of a discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/update-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#update-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + body: + type: string + description: The discussion comment's body text. + required: + - body + examples: + default: + value: + body: Do you like pineapples? + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-discussion-comment" + examples: + default: + "$ref": "#/components/examples/team-discussion-comment-2" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + delete: + summary: Delete a discussion comment (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 discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + + Deletes a comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - teams + operationId: teams/delete-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#delete-a-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-01' + deprecationDate: '2020-01-21' + category: teams + subcategory: discussion-comments + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": + get: + summary: List reactions for a team discussion comment (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 reactions for a team discussion comment`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + + List the reactions to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + post: + summary: Create reaction for a team discussion comment (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 "[Create reaction for a team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + + Create a reaction to a [team discussion comment](https://docs.github.com/enterprise-server@3.15/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-comment-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - "$ref": "#/components/parameters/comment-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) + to add to the team discussion comment. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/reaction" + examples: + default: + "$ref": "#/components/examples/reaction" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + "/teams/{team_id}/discussions/{discussion_number}/reactions": + get: + summary: List reactions for a team discussion (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 reactions for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + + List the reactions to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/list-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + - name: content + description: Returns a single [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions). + Omit this parameter to list all reactions to a team discussion. + 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" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + deprecated: true + post: + summary: Create reaction for a team discussion (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 [`Create reaction for a team discussion`](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + + Create a reaction to a [team discussion](https://docs.github.com/enterprise-server@3.15/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + tags: + - reactions + operationId: reactions/create-for-team-discussion-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/discussion-number" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + content: + type: string + description: The [reaction type](https://docs.github.com/enterprise-server@3.15/rest/reactions/reactions#about-reactions) + to add to the team discussion. + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + required: + - content + examples: + default: + value: + content: heart + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/reaction" + examples: + default: + "$ref": "#/components/examples/reaction" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + removalDate: '2021-02-21' + deprecationDate: '2020-02-26' + category: reactions + subcategory: reactions + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + We recommend using the [Get team membership for a user](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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. + + We recommend using the [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + We recommend using the [Remove team membership for a user](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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 Enterprise Server 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 Enterprise Server](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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}/projects": + get: + summary: List team projects (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 projects`](https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects) endpoint. + + Lists the organization projects for a team. + tags: + - teams + operationId: teams/list-projects-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#list-team-projects-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/team-project" + examples: + default: + "$ref": "#/components/examples/team-project-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}/projects/{project_id}": + get: + summary: Check team permissions for a project (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 project](https://docs.github.com/enterprise-server@3.15/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. + tags: + - teams + operationId: teams/check-permissions-for-project-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#check-team-permissions-for-a-project-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/team-project" + examples: + default: + "$ref": "#/components/examples/team-project" + '404': + description: Not Found if project 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 project 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 project permissions](https://docs.github.com/enterprise-server@3.15/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. + tags: + - teams + operationId: teams/add-or-update-project-permissions-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-id" + requestBody: + required: false + content: + application/json: + schema: + type: object + properties: + permission: + type: string + description: 'The permission to grant to the team for this project. + Default: the team''s `permission` attribute will be used to determine + what permission to grant the team on this project. Note that, + if you choose not to pass any parameters, you''ll need to set + `Content-Length` to zero when calling this endpoint. For more + information, see "[HTTP method](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)."' + enum: + - read + - write + - admin + examples: + default: + summary: Example of setting permission to read + value: + permission: read + responses: + '204': + description: Response + '403': + description: Forbidden if the project is not owned by the organization + content: + application/json: + schema: + type: object + properties: + message: + type: string + documentation_url: + type: string + examples: + response-if-the-project-is-not-owned-by-the-organization: + value: + message: Must have admin rights to Repository. + documentation_url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#add-or-update-team-project-permissions + '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 + delete: + summary: Remove a project 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 project from a team](https://docs.github.com/enterprise-server@3.15/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. + tags: + - teams + operationId: teams/remove-project-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/teams/teams#remove-a-project-from-a-team-legacy + parameters: + - "$ref": "#/components/parameters/team-id" + - "$ref": "#/components/parameters/project-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}/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/enterprise-server@3.15/rest/teams/teams#list-team-repositories) endpoint. + tags: + - teams + operationId: teams/list-repos-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/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/enterprise-server@3.15/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] + > **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/enterprise-server@3.15/rest/teams/teams#list-child-teams) endpoint. + tags: + - teams + operationId: teams/list-child-legacy + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - Omar Jahandar + email: + description: The publicly visible email address of the user. + type: string + examples: + - omar@example.com + blog: + description: The new blog URL of the user. + type: string + examples: + - blog.example.com + twitter_username: + description: The new Twitter username of the user. + type: + - string + - 'null' + examples: + - therealomarj + company: + description: The new company of the user. + type: string + examples: + - Acme corporation + location: + description: The new location of the user. + type: string + examples: + - 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/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/enterprise-server@3.15/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/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + examples: + - username@example.com + minItems: 1 + examples: [] + required: + - emails + example: + emails: + - octocat@github.com + - mona@github.com + - type: array + items: + type: string + examples: + - 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/enterprise-server@3.15/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 + examples: + - username@example.com + minItems: 1 + example: + emails: + - octocat@github.com + - mona@github.com + required: + - emails + - type: array + items: + type: string + examples: + - 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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" + '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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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: + "$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/enterprise-server@3.15/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/enterprise-server@3.15/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/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_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/enterprise-server@3.15/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 + examples: + - 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + readOnly: false + type: boolean + examples: + - true + exclude_metadata: + description: Indicates whether metadata should be excluded and only + git source should be included for the migration. + readOnly: false + type: boolean + examples: + - true + exclude_git_data: + description: Indicates whether the repository git data should be + excluded from the migration. + readOnly: false + type: boolean + examples: + - true + exclude_attachments: + description: Do not include attachments in the migration + readOnly: false + type: boolean + examples: + - true + exclude_releases: + description: Do not include releases in the migration + readOnly: false + type: boolean + examples: + - true + exclude_owner_projects: + description: Indicates whether projects owned by the organization + or users should be excluded. + readOnly: false + type: boolean + examples: + - true + org_metadata_only: + type: boolean + description: Indicates whether this should only include organization + metadata (repositories array should be empty and will ignore other + flags). + default: false + examples: + - true + exclude: + description: Exclude attributes from the API response to improve + performance + readOnly: false + type: array + items: + description: Allowed values that can be passed to the exclude + param. + enum: + - repositories + type: string + examples: + - repositories + examples: + - repositories + repositories: + type: array + items: + description: Repository path, owner and name + type: string + examples: + - acme/widgets + 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}/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/enterprise-server@3.15/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 + "/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/enterprise-server@3.15/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 + "/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/projects": + post: + summary: Create a user project + description: 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. + tags: + - projects + operationId: projects/create-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#create-a-user-project + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + required: + - name + type: object + examples: + default: + summary: Create a new project + value: + name: My Projects + body: A board to manage my personal projects. + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + '422': + "$ref": "#/components/responses/validation_failed_simple" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: projects + subcategory: projects + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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" + '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. + + 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/enterprise-server@3.15/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 + examples: + - 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 + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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. + type: string + examples: + - Haskell + license_template: + description: The license keyword of the open source license for + this repository. + type: string + examples: + - mit + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + default: false + type: boolean + examples: + - 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 + examples: + - true + is_template: + description: Whether this repository acts as a template that can + be used to generate new repositories. + default: false + type: boolean + examples: + - 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 + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + examples: + - https://twitter.com/github + examples: [] + 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. + + 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/enterprise-server@3.15/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 + examples: + - https://twitter.com/github + examples: [] + 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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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 + examples: + - 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/rest/users/emails)". + tags: + - users + operationId: users/get-by-id + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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 + "/users": + get: + summary: List users + description: |- + Lists all users, in the order that they signed up on GitHub Enterprise Server. 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/enterprise-server@3.15/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/enterprise-server@3.15/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/{username}": + get: + summary: Get a user + description: |- + Provides publicly available information about someone with a GitHub account. + + The `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [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 Enterprise Server. For more information, see [Authentication](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/rest/users/emails)". + tags: + - users + operationId: users/get-by-username + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/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}/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/enterprise-server@3.15/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). + + > [!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/enterprise-server@3.15/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. + + > [!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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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. + + You must use a [JWT](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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}/projects": + get: + summary: List user projects + description: Lists projects for a user. + tags: + - projects + operationId: projects/list-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/projects/projects#list-user-projects + parameters: + - "$ref": "#/components/parameters/username" + - name: state + description: Indicates the state of the projects to return. + in: query + required: false + schema: + type: string + enum: + - open + - closed + - all + default: open + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/project" + examples: + default: + "$ref": "#/components/examples/project-items-3" + headers: + Link: + "$ref": "#/components/headers/link" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: projects + subcategory: projects + "/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/enterprise-server@3.15/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] + > 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/enterprise-server@3.15/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/enterprise-server@3.15/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}/site_admin": + put: + summary: Promote a user to be a site administrator + 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/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." + operationId: enterprise-admin/promote-user-to-be-site-administrator + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#promote-a-user-to-be-a-site-administrator + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Demote a site administrator + description: You can demote any user account except your own. + operationId: enterprise-admin/demote-site-administrator + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#demote-a-site-administrator + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.15/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/enterprise-server@3.15/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. + + This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + "/users/{username}/suspended": + put: + summary: Suspend a user + description: |- + If your GitHub instance uses [LDAP Sync with Active Directory LDAP servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response. + + You can suspend any user account except your own. + + 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/enterprise-server@3.15/rest/guides/getting-started-with-the-rest-api#http-method)." + operationId: enterprise-admin/suspend-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#suspend-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + requestBody: + required: false + content: + application/json: + schema: + type: + - object + - 'null' + properties: + reason: + type: string + description: The reason the user is being suspended. This message + will be logged in the [audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). + If you don't provide a `reason`, it will default to "Suspended + via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ + is the person who performed the action. + examples: + reason: + value: + reason: Suspended during leave of absence. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + delete: + summary: Unsuspend a user + description: If your GitHub instance uses [LDAP Sync with Active Directory LDAP + servers](https://docs.github.com/enterprise-server@3.15/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap), + this API is disabled and will return a `403` response. Active Directory LDAP-authenticated + users cannot be unsuspended using the API. + operationId: enterprise-admin/unsuspend-user + tags: + - enterprise-admin + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/users#unsuspend-a-user + parameters: + - "$ref": "#/components/parameters/username" + responses: + '204': + description: Response + requestBody: + content: + application/json: + schema: + type: + - object + - 'null' + properties: + reason: + type: string + description: The reason the user is being unsuspended. This message + will be logged in the [audit log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/about-the-audit-log-for-your-enterprise). + If you don't provide a `reason`, it will default to "Unsuspended + via API by _SITE\_ADMINISTRATOR_", where _SITE\_ADMINISTRATOR_ + is the person who performed the action. + examples: + reason: + value: + reason: Unsuspended after leave of absence. + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: enterprise-admin + subcategory: users + "/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/enterprise-server@3.15/rest/meta/meta#get-the-zen-of-github + responses: + '200': + description: Response + content: + application/json: + schema: + type: string + examples: + default: + summary: Example response + value: Responsive is better than fast + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: meta + subcategory: meta +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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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-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. + For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule)" in the GraphQL documentation or "[Branch protection](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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-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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + bypass-request-secret-scanning-cancelled: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning push protection bypass request was cancelled. + operationId: exemption-request-secret-scanning/cancelled + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-cancelled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-completed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning bypass request was completed. + operationId: exemption-request-secret-scanning/completed + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-completed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-created: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning push protection bypass request was created. + operationId: exemption-request-secret-scanning/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-dismissed: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A secret scanning push protection bypass response was dismissed. + operationId: exemption-request-secret-scanning/response-dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-response-dismissed" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + bypass-request-secret-scanning-response-submitted: + post: + summary: |- + This event occurs when there is activity related to a user's request to bypass secret scanning push protection. + + For more information, see "[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection)." + + To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission. + + Note: Delegated bypass for push protection is currently in public preview and subject to change. + description: A response either approving or rejecting the secret scanning push + protection bypass request was submitted. + operationId: exemption-request-secret-scanning/response-submitted + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning + parameters: + - name: User-Agent + in: header + example: GitHub-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-exemption-request-response-submitted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: bypass_request_secret_scanning + supported-webhook-types: + - repository + - organization + - app + cache-sync: + post: + summary: This event occurs when a Git ref has been successfully synced to a + cache replica. For more information, see "[About repository caching](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/caching-repositories/about-repository-caching)." + operationId: cache-sync + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#cache_sync + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-cache-sync" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: cache_sync + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/developers/apps/guides/creating-ci-tests-with-the-checks-api)." + operationId: check-run/requested-action + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/mutations#createcheckrun) + or "[Create a check run](https://docs.github.com/enterprise-server@3.15/rest/checks/runs#create-a-check-run)" + in the REST API documentation. + operationId: check-suite/requested + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/mutations#createchecksuite) + or "[Create a check suite](https://docs.github.com/enterprise-server@3.15/rest/checks/suites#create-a-check-suite)" + in the REST API documentation. + operationId: check-suite/rerequested + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. + operationId: dependabot-alert/auto-dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was manually closed. + operationId: dependabot-alert/dismissed + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change removed a vulnerability. + operationId: dependabot-alert/fixed + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A manifest file change introduced a vulnerable dependency that + had previously been fixed. + operationId: dependabot-alert/reintroduced + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.15/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.15/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. + + > [!NOTE] + > Webhook events for Dependabot alerts are currently in public preview and subject to change. + description: A Dependabot alert was manually reopened. + operationId: dependabot-alert/reopened + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.9.0 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.9.0 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + enterprise-anonymous-access-disabled: + post: + summary: This event occurs when there is activity relating to anonymous Git + read access in an enterprise. For more information, see "[Enforcing repository + management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." + description: Anonymous Git read access was disabled. + operationId: enterprise/anonymous-access-disabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#enterprise + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-disabled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: enterprise + supported-webhook-types: + - business + enterprise-anonymous-access-enabled: + post: + summary: This event occurs when there is activity relating to anonymous Git + read access in an enterprise. For more information, see "[Enforcing repository + management policies in your enterprise](https://docs.github.com/enterprise-server@3.15/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." + description: Anonymous Git read access was enabled. + operationId: enterprise/anonymous-access-enabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#enterprise + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-enterprise-anonymous-access-enabled" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: enterprise + supported-webhook-types: + - business + fork: + post: + summary: |- + This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-server@3.15/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) + or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/locked + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/pinned + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)." + operationId: issues/transferred + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: issues/unlocked + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)." + operationId: issues/unpinned + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + label-created: + post: + summary: |- + This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.15/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. + description: A package was published to a registry. + operationId: package/published + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + - app + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.15/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. + description: A previously published package was updated. + operationId: package/updated + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + - app + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was approved. + operationId: personal-access-token-request/approved + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + 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/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was created. + operationId: personal-access-token-request/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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. + + > [!NOTE] + > Fine-grained PATs are in public preview. Related APIs, events, and functionality are subject to change. + description: A fine-grained personal access token request was denied. + operationId: personal-access-token-request/denied + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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 + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/locked + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/communities/moderating-comments-and-conversations/locking-conversations)." + operationId: pull-request/unlocked + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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, + 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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)." + operationId: release/edited + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-anonymous-access-disabled: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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: Someone disabled anonymous Git read access to the repository. For + more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." + operationId: repository/anonymous-access-disabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-anonymous-access-disabled" + 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: + - app + - business + - organization + - repository + repository-anonymous-access-enabled: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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: Someone enabled anonymous Git read access to the repository. For + more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)." + operationId: repository/anonymous-access-enabled + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-repository-anonymous-access-enabled" + 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: + - app + - business + - organization + - repository + repository-archived: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-privatized: + post: + summary: |- + This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.15/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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-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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.15/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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-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. + For more information about repository rulesets, see "[Managing rulesets](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or "[Repository rules](https://docs.github.com/enterprise-server@3.15/rest/repos/rules)" and "[Organization rules](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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-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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + > [!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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + + For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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-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/enterprise-server@3.15/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + 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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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. + For more information, see "[About teams](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + user-created: + post: + summary: This event occurs when there is activity relating to user accounts + in an enterprise. + description: A user account was added to the enterprise. + operationId: user/created + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#user + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-user-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: user + supported-webhook-types: + - business + user-deleted: + post: + summary: This event occurs when there is activity relating to user accounts + in an enterprise. + description: A user account was removed from the enterprise. + operationId: user/deleted + externalDocs: + url: https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#user + parameters: + - name: User-Agent + in: header + example: GitHub-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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-user-deleted" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: true + category: webhooks + subcategory: user + supported-webhook-types: + - business + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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/enterprise-server@3.15/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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: 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 + - name: X-GitHub-Enterprise-Version + in: header + example: 3.1.9 + schema: + type: string + - name: X-GitHub-Enterprise-Host + in: header + example: ghes.github.com + 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 + global-hook: + type: object + properties: + type: + type: string + id: + type: integer + name: + type: string + active: + type: boolean + events: + type: array + items: + type: string + config: + type: object + properties: + url: + type: string + content_type: + type: string + insecure_ssl: + type: string + secret: + type: string + updated_at: + type: string + created_at: + type: string + url: + type: string + ping_url: + type: string + global-hook-2: + type: object + properties: + type: + type: string + id: + type: integer + name: + type: string + active: + type: boolean + events: + type: array + items: + type: string + config: + type: object + properties: + url: + type: string + content_type: + type: string + insecure_ssl: + type: string + updated_at: + type: string + created_at: + type: string + url: + type: string + ping_url: + type: string + public-key-full: + type: object + properties: + id: + type: integer + format: int64 + key: + type: string + user_id: + type: + - integer + - 'null' + repository_id: + type: + - integer + - 'null' + format: int64 + url: + type: string + title: + type: string + read_only: + type: boolean + verified: + type: boolean + created_at: + type: string + format: date-time + added_by: + type: + - string + - 'null' + last_used: + type: + - string + - 'null' + format: date-time + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + - last_used + - user_id + - repository_id + ldap-mapping-team: + type: object + properties: + ldap_dn: + type: string + id: + type: integer + node_id: + type: string + url: + type: string + html_url: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + members_url: + type: string + repositories_url: + type: string + parent: + type: + - 'null' + ldap-mapping-user: + title: Ldap Private User + description: Ldap Private User + type: object + properties: + ldap_dn: + type: string + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - true + plan: + type: object + properties: + collaborators: + type: integer + name: + type: string + space: + type: integer + private_repos: + type: integer + required: + - collaborators + - name + - space + - private_repos + suspended_at: + type: string + format: date-time + business_plus: + type: boolean + user_view_type: + type: string + examples: + - 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 + - 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 + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + pre-receive-environment: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + image_url: + type: string + url: + type: string + html_url: + type: string + default_environment: + type: boolean + created_at: + type: string + hooks_count: + type: integer + download: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + pre-receive-environment-download-status: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + script: + type: string + script_repository: + type: object + properties: + id: + type: integer + full_name: + type: string + url: + type: string + html_url: + type: string + environment: + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + image_url: + type: string + url: + type: string + html_url: + type: string + default_environment: + type: boolean + created_at: + type: string + hooks_count: + type: integer + download: + type: object + properties: + url: + type: string + state: + type: string + downloaded_at: + type: + - string + - 'null' + message: + type: + - string + - 'null' + allow_downstream_configuration: + type: boolean + simple-user: + title: Simple User + description: A GitHub user. + type: object + properties: + name: + type: + - string + - 'null' + email: + type: + - string + - 'null' + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + starred_at: + type: string + examples: + - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - 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 + 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 + 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 leve 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 + 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 + 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 + 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 custom + property management. + 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_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 + team_discussions: + type: string + description: The level of permission to grant the access token to manage + team discussions and related comments. + 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_administration: + type: string + description: The level of permission to grant the access token to list and + manage repositories a user is starring. + enum: + - read + - write + example: + contents: read + issues: read + deployments: write + single_file: read + 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 + - 'null' + examples: + - config.yaml + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + account: + "$ref": "#/components/schemas/simple-user" + required: + - permissions + - repository_selection + - single_file_name + - repositories_url + - account + 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 + - 'null' + items: + type: string + token: + type: string + token_last_eight: + type: + - string + - 'null' + hashed_token: + type: + - string + - 'null' + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + note: + type: + - string + - 'null' + note_url: + type: + - string + - 'null' + format: uri + updated_at: + type: string + format: date-time + created_at: + type: string + format: date-time + fingerprint: + type: + - string + - 'null' + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + installation: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/scoped-installation" + expires_at: + type: + - string + - 'null' + format: date-time + required: + - app + - id + - note + - note_url + - scopes + - token + - hashed_token + - token_last_eight + - fingerprint + - url + - created_at + - updated_at + - expires_at + 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 + - 'null' + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: + - string + - 'null' + description: The unique package name within its ecosystem. + required: + - ecosystem + - name + vulnerable_version_range: + type: + - string + - 'null' + description: The range of the package versions affected by the vulnerability. + first_patched_version: + type: + - string + - 'null' + description: The package version that resolves the vulnerability. + vulnerable_functions: + type: + - array + - 'null' + description: The functions in the package that are affected by the vulnerability. + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions + cvss-severities: + type: + - object + - 'null' + properties: + cvss_v3: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 3 vector string. + score: + type: + - number + - 'null' + description: The CVSS 3 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_v4: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS 4 vector string. + score: + type: + - number + - 'null' + description: The CVSS 4 score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + 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 + - 'null' + description: The Common Vulnerabilities and Exposures (CVE) ID. + 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 + - 'null' + format: uri + description: The API URL for the repository advisory. + readOnly: true + summary: + type: string + description: A short summary of the advisory. + maxLength: 1024 + description: + type: + - string + - 'null' + description: A detailed description of what the advisory entails. + maxLength: 65535 + 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 + - 'null' + format: uri + description: The URL of the advisory's source code. + identifiers: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + description: The date and time of when the advisory was reviewed by GitHub, + in ISO 8601 format. + readOnly: true + nvd_published_at: + type: + - string + - 'null' + 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 + withdrawn_at: + type: + - string + - 'null' + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO + 8601 format. + readOnly: true + vulnerabilities: + type: + - array + - 'null' + description: The products and respective version ranges affected by the + advisory. + items: + "$ref": "#/components/schemas/vulnerability" + cvss: + type: + - object + - 'null' + properties: + vector_string: + type: + - string + - 'null' + description: The CVSS vector. + score: + type: + - number + - 'null' + description: The CVSS score. + minimum: 0 + maximum: 10 + readOnly: true + required: + - vector_string + - score + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + cwes: + type: + - array + - 'null' + 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 + epss: + type: + - object + - 'null' + properties: + percentage: + type: number + percentile: + type: number + credits: + type: + - array + - 'null' + description: In GitHub Enterprise Server, this field will always be empty + because the user metadata of credited users will not be available. + 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 + 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 + 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 + - 'null' + properties: + id: + description: Unique identifier of the GitHub app + type: integer + examples: + - 37 + slug: + description: The slug name of the GitHub app + type: string + examples: + - probot-owners + node_id: + type: string + examples: + - MDExOkludGVncmF0aW9uMQ== + client_id: + type: string + examples: + - '"Iv1.25b5d1e65ffc4022"' + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + name: + description: The name of the GitHub app + type: string + examples: + - Probot Owners + description: + type: + - string + - 'null' + examples: + - The description of the app. + external_url: + type: string + format: uri + examples: + - https://example.com + html_url: + type: string + format: uri + examples: + - https://github.com/apps/super-ci + created_at: + type: string + format: date-time + examples: + - '2017-07-08T16:18:44-04:00' + updated_at: + type: string + format: date-time + examples: + - '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 + type: array + items: + type: string + examples: + - label + - deployment + installations_count: + description: The number of installations associated with the GitHub app + type: integer + examples: + - 5 + client_secret: + type: string + examples: + - '"1d4b2097ac622ba702d19de498f005747a8b21d3"' + webhook_secret: + type: + - string + - 'null' + examples: + - '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' + pem: + type: string + examples: + - '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END + RSA PRIVATE KEY-----\n"' + 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. + format: uri + examples: + - https://example.com/webhook + 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`. + examples: + - '"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/enterprise-server@3.15/webhooks/event-payloads/#delivery-headers). + examples: + - '"********"' + 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.** + examples: + - '"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 + examples: + - 42 + guid: + description: Unique identifier for the event (shared with all deliveries + for all webhooks that subscribe to this event). + type: string + examples: + - 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the webhook delivery occurred. + type: string + format: date-time + examples: + - '2021-05-12T20:33:44Z' + redelivery: + description: Whether the webhook delivery is a redelivery. + type: boolean + examples: + - false + duration: + description: Time spent delivering. + type: number + examples: + - 0.03 + status: + description: Describes the response returned after attempting the delivery. + type: string + examples: + - failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + examples: + - 502 + event: + description: The event that triggered the delivery. + type: string + examples: + - issues + action: + description: The type of activity for the event that triggered the delivery. + type: + - string + - 'null' + examples: + - opened + installation_id: + description: The id of the GitHub App installation associated with this + event. + type: + - integer + - 'null' + examples: + - 123 + repository_id: + description: The id of the repository associated with this event. + type: + - integer + - 'null' + examples: + - 123 + throttled_at: + description: Time when the webhook delivery was throttled. + type: + - string + - 'null' + format: date-time + examples: + - '2021-05-12T20:33:44Z' + 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 + - 'null' + documentation_url: + type: + - string + - 'null' + detail: + type: + - string + - 'null' + status: + type: integer + scimType: + type: + - string + - 'null' + 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 + - 'null' + - type: + - integer + - 'null' + - type: + - array + - 'null' + 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 + examples: + - 42 + guid: + description: Unique identifier for the event (shared with all deliveries + for all webhooks that subscribe to this event). + type: string + examples: + - 58474f00-b361-11eb-836d-0e4f3503ccbe + delivered_at: + description: Time when the delivery was delivered. + type: string + format: date-time + examples: + - '2021-05-12T20:33:44Z' + redelivery: + description: Whether the delivery is a redelivery. + type: boolean + examples: + - false + duration: + description: Time spent delivering. + type: number + examples: + - 0.03 + status: + description: Description of the status of the attempted delivery + type: string + examples: + - failed to connect + status_code: + description: Status code received when delivery was made. + type: integer + examples: + - 502 + event: + description: The event that triggered the delivery. + type: string + examples: + - issues + action: + description: The type of activity for the event that triggered the delivery. + type: + - string + - 'null' + examples: + - opened + installation_id: + description: The id of the GitHub App installation associated with this + event. + type: + - integer + - 'null' + examples: + - 123 + repository_id: + description: The id of the repository associated with this event. + type: + - integer + - 'null' + examples: + - 123 + throttled_at: + description: Time when the webhook delivery was throttled. + type: + - string + - 'null' + format: date-time + examples: + - '2021-05-12T20:33:44Z' + url: + description: The URL target of the delivery. + type: string + examples: + - https://www.example.com + request: + type: object + properties: + headers: + description: The request headers sent with the webhook delivery. + type: + - object + - 'null' + additionalProperties: true + payload: + description: The webhook payload. + type: + - object + - 'null' + additionalProperties: true + required: + - headers + - payload + response: + type: object + properties: + headers: + description: The response headers received when the delivery was made. + type: + - object + - 'null' + additionalProperties: true + payload: + description: The response payload received. + type: + - string + - 'null' + additionalProperties: true + required: + - headers + - payload + required: + - id + - guid + - delivered_at + - redelivery + - duration + - status + - status_code + - event + - action + - installation_id + - repository_id + - request + - response + enterprise: + title: Enterprise + description: An enterprise on GitHub. + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '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-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 + examples: + - 42 + node_id: + type: string + examples: + - 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 + examples: + - '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 + examples: + - 1 + account: + anyOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/enterprise" + type: + - 'null' + - object + 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 + examples: + - https://api.github.com/app/installations/1/access_tokens + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/installation/repositories + html_url: + type: string + format: uri + examples: + - https://github.com/organizations/github/settings/installations/1 + app_id: + type: integer + examples: + - 1 + target_id: + description: The ID of the user or organization this token is being scoped + to. + type: integer + target_type: + type: string + examples: + - 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 + - 'null' + examples: + - config.yaml + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + app_slug: + type: string + examples: + - github-actions + suspended_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + suspended_at: + type: + - string + - 'null' + format: date-time + contact_email: + type: + - string + - 'null' + examples: + - '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' + 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 + license-simple: + title: License Simple + description: License Simple + type: object + properties: + key: + type: string + examples: + - mit + name: + type: string + examples: + - MIT License + url: + type: + - string + - 'null' + format: uri + examples: + - https://api.github.com/licenses/mit + spdx_id: + type: + - string + - 'null' + examples: + - MIT + node_id: + type: string + examples: + - MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + required: + - key + - name + - url + - spdx_id + - node_id + repository: + title: Repository + description: A repository on GitHub. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + deprecated: true + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - '"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 + 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 + examples: + - README.md + has_multiple_single_files: + type: boolean + examples: + - true + single_file_paths: + type: array + items: + type: string + examples: + - config.yml + - ".github/issue_TEMPLATE.md" + required: + - token + - expires_at + application-grant: + title: Application Grant + description: The authorization associated with an OAuth Access. + type: object + properties: + id: + type: integer + format: int64 + examples: + - 1 + url: + type: string + format: uri + examples: + - https://api.github.com/applications/grants/1 + app: + type: object + properties: + client_id: + type: string + name: + type: string + url: + type: string + format: uri + required: + - client_id + - name + - url + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + scopes: + type: array + items: + type: string + examples: + - public_repo + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - app + - id + - scopes + - url + - created_at + - updated_at + code-of-conduct: + title: Code Of Conduct + description: Code Of Conduct + type: object + properties: + key: + type: string + examples: + - contributor_covenant + name: + type: string + examples: + - Contributor Covenant + url: + type: string + format: uri + examples: + - https://api.github.com/codes_of_conduct/contributor_covenant + body: + type: string + examples: + - | + # 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 + - 'null' + format: uri + required: + - url + - html_url + - key + - name + announcement-message: + type: + - string + - 'null' + description: The announcement text in GitHub Flavored Markdown. For more information + about GitHub Flavored Markdown, see "[Basic writing and formatting syntax](https://docs.github.com/enterprise-server@3.15/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)." + examples: + - Very **important** announcement about _something_. + announcement-expiration: + type: + - string + - 'null' + format: date-time + description: 'The time at which the announcement expires. This is a timestamp + in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. + To set an announcement that never expires, omit this parameter, set it to + `null`, or set it to an empty string.' + examples: + - '"2021-01-01T00:00:00.000-07:00"' + announcement: + title: Enterprise Announcement + description: Enterprise global announcement + type: object + properties: + announcement: + "$ref": "#/components/schemas/announcement-message" + expires_at: + "$ref": "#/components/schemas/announcement-expiration" + required: + - announcement + license-info: + type: object + properties: + seats: + oneOf: + - type: string + - type: integer + seats_used: + type: integer + seats_available: + oneOf: + - type: string + - type: integer + kind: + type: string + days_until_expiration: + type: integer + expire_at: + type: string + enterprise-repository-overview: + title: Repository Enterprise Stats + type: object + properties: + total_repos: + type: integer + root_repos: + type: integer + fork_repos: + type: integer + org_repos: + type: integer + total_pushes: + type: integer + total_wikis: + type: integer + required: + - total_repos + - root_repos + - fork_repos + - org_repos + - total_pushes + - total_wikis + enterprise-hook-overview: + title: Hooks Enterprise Stats + type: object + properties: + total_hooks: + type: integer + active_hooks: + type: integer + inactive_hooks: + type: integer + required: + - total_hooks + - active_hooks + - inactive_hooks + enterprise-page-overview: + title: Enterprise Pages Stats + type: object + properties: + total_pages: + type: integer + required: + - total_pages + enterprise-organization-overview: + title: Enterprise Organization Stats + type: object + properties: + total_orgs: + type: integer + disabled_orgs: + type: integer + total_teams: + type: integer + total_team_members: + type: integer + required: + - total_orgs + - disabled_orgs + - total_teams + - total_team_members + enterprise-user-overview: + title: Enterprise User Stats + type: object + properties: + total_users: + type: integer + admin_users: + type: integer + suspended_users: + type: integer + required: + - total_users + - admin_users + - suspended_users + enterprise-pull-request-overview: + title: Enterprise Pull Request Stats + type: object + properties: + total_pulls: + type: integer + merged_pulls: + type: integer + mergeable_pulls: + type: integer + unmergeable_pulls: + type: integer + required: + - total_pulls + - merged_pulls + - mergeable_pulls + - unmergeable_pulls + enterprise-issue-overview: + title: Enterprise Issue Stats + type: object + properties: + total_issues: + type: integer + open_issues: + type: integer + closed_issues: + type: integer + required: + - total_issues + - open_issues + - closed_issues + enterprise-milestone-overview: + title: Enterprise Milestone Stats + type: object + properties: + total_milestones: + type: integer + open_milestones: + type: integer + closed_milestones: + type: integer + required: + - total_milestones + - open_milestones + - closed_milestones + enterprise-gist-overview: + title: Enterprise Gist Stats + type: object + properties: + total_gists: + type: integer + private_gists: + type: integer + public_gists: + type: integer + required: + - total_gists + - private_gists + - public_gists + enterprise-comment-overview: + title: Enterprise Comment Stats + type: object + properties: + total_commit_comments: + type: integer + total_gist_comments: + type: integer + total_issue_comments: + type: integer + total_pull_request_comments: + type: integer + required: + - total_commit_comments + - total_gist_comments + - total_issue_comments + - total_pull_request_comments + enterprise-overview: + type: object + properties: + repos: + "$ref": "#/components/schemas/enterprise-repository-overview" + hooks: + "$ref": "#/components/schemas/enterprise-hook-overview" + pages: + "$ref": "#/components/schemas/enterprise-page-overview" + orgs: + "$ref": "#/components/schemas/enterprise-organization-overview" + users: + "$ref": "#/components/schemas/enterprise-user-overview" + pulls: + "$ref": "#/components/schemas/enterprise-pull-request-overview" + issues: + "$ref": "#/components/schemas/enterprise-issue-overview" + milestones: + "$ref": "#/components/schemas/enterprise-milestone-overview" + gists: + "$ref": "#/components/schemas/enterprise-gist-overview" + comments: + "$ref": "#/components/schemas/enterprise-comment-overview" + enterprise-security-products-overview: + title: Enterprise Security Products Stats + type: object + properties: + total_repos: + type: integer + nonarchived_repos: + type: integer + secret_scanning_enabled_repos: + type: integer + secret_scanning_push_protection_enabled_repos: + type: integer + code_scanning_enabled_repos: + type: integer + code_scanning_pr_reviews_enabled_repos: + type: integer + code_scanning_default_setup_enabled_repos: + type: integer + code_scanning_default_setup_eligible_repos: + type: integer + dependabot_alerts_enabled_repos: + type: integer + dependabot_security_updates_enabled_repos: + type: integer + dependabot_version_updates_enabled_repos: + type: integer + advanced_security_enabled_repos: + type: integer + active_committers: + type: integer + purchased_committers: + type: integer + maximum_committers: + type: integer + 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-policy-enterprise: + title: Actions cache usage policy for an enterprise + description: GitHub Actions cache usage policy for an enterprise. + type: object + properties: + repo_cache_size_limit_in_gb: + description: For repositories in an enterprise, the default size limit for + the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 10 + max_repo_cache_size_limit_in_gb: + description: For repositories in an enterprise, the maximum value that can + be set as the limit for the sum of all caches in a repository, in gigabytes. + type: integer + examples: + - 15 + enabled-organizations: + type: string + description: The policy that controls the organizations in the enterprise that + are allowed to run GitHub Actions. + enum: + - all + - none + - selected + allowed-actions: + type: string + description: The permissions policy that controls the actions 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 that are allowed to + run, when `allowed_actions` is set to `selected`. + actions-enterprise-permissions: + type: object + properties: + enabled_organizations: + "$ref": "#/components/schemas/enabled-organizations" + selected_organizations_url: + type: string + description: The API URL to use to get or set the selected organizations + that are allowed to run GitHub Actions, when `enabled_organizations` is + set to `selected`. + allowed_actions: + "$ref": "#/components/schemas/allowed-actions" + selected_actions_url: + "$ref": "#/components/schemas/selected-actions-url" + required: + - enabled_organizations + 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. + patterns_allowed: + type: array + description: Specifies a list of string-matching patterns to allow specific + action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, + `monalisa/octocat@v2`, `monalisa/*`. + items: + type: string + required: + - github_owned_allowed + - patterns_allowed + 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-enterprise: + type: object + properties: + id: + type: number + name: + type: string + visibility: + type: string + default: + type: boolean + selected_organizations_url: + type: string + runners_url: + type: string + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - allows_public_repositories + - default + - runners_url + 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 + examples: + - 5 + runner_group_id: + description: The id of the runner group. + type: integer + examples: + - 1 + name: + description: The name of the runner. + type: string + examples: + - iMac + os: + description: The Operating System of the runner. + type: string + examples: + - macos + status: + description: The status of the runner. + type: string + examples: + - online + busy: + type: boolean + labels: + type: array + items: + "$ref": "#/components/schemas/runner-label" + 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 + examples: + - v1.1f699f1069f60xxx + expires_at: + description: The time this token expires + type: string + format: date-time + examples: + - '2016-07-11T22:14:10Z' + permissions: + type: object + examples: + - issues: read + deployments: write + repositories: + description: The repositories this token has access to + type: array + items: + "$ref": "#/components/schemas/repository" + single_file: + type: + - string + - 'null' + examples: + - config.yaml + 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 + audit-log-event: + type: object + properties: + "@timestamp": + type: integer + description: The time the audit log event occurred, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + action: + type: string + description: The name of the action that was performed, for example `user.login` + or `repo.create`. + active: + type: boolean + active_was: + type: boolean + actor: + type: string + description: The actor who performed the action. + actor_id: + type: integer + description: The id of the actor who performed the action. + actor_location: + type: object + properties: + country_name: + type: string + data: + type: object + additionalProperties: true + org_id: + type: integer + user_id: + type: integer + business_id: + type: integer + blocked_user: + type: string + description: The username of the account being blocked. + business: + type: string + config: + type: array + items: + type: object + config_was: + type: array + items: + type: object + content_type: + type: string + operation_type: + type: string + created_at: + type: integer + description: The time the audit log event was recorded, given as a [Unix + timestamp](http://en.wikipedia.org/wiki/Unix_time). + deploy_key_fingerprint: + type: string + _document_id: + type: string + description: A unique identifier for an audit event. + emoji: + type: string + events: + type: array + items: + type: object + events_were: + type: array + items: + type: object + explanation: + type: string + fingerprint: + type: string + hook_id: + type: integer + limited_availability: + type: boolean + message: + type: string + name: + type: string + old_user: + type: string + openssh_public_key: + type: string + org: + type: string + previous_visibility: + type: string + read_only: + type: boolean + repo: + type: string + description: The name of the repository. + repository: + type: string + description: The name of the repository. + repository_public: + type: boolean + target_login: + type: string + team: + type: string + transport_protocol: + type: integer + description: The type of protocol (for example, HTTP or SSH) used to transfer + Git data. + transport_protocol_name: + type: string + description: A human readable name for the protocol (for example, HTTP or + SSH) used to transfer Git data. + user: + type: string + description: The user that was affected by the action performed (if available). + visibility: + type: string + description: The repository visibility, for example `public` or `private`. + 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: + type: + - string + - 'null' + 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 + 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 + - 'null' + description: State of a code scanning alert. + enum: + - open + - dismissed + - fixed + - + alert-fixed-at: + type: + - string + - 'null' + 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 + alert-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + code-scanning-alert-dismissed-reason: + type: + - string + - 'null' + description: "**Required when the state is dismissed.** The reason for dismissing + or closing the alert." + enum: + - false positive + - won't fix + - used in tests + - + code-scanning-alert-dismissed-comment: + type: + - string + - 'null' + description: The dismissal comment associated with the dismissal of the alert. + maxLength: 280 + code-scanning-alert-rule-summary: + type: object + properties: + id: + type: + - string + - 'null' + 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: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + 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. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + code-scanning-analysis-tool-version: + type: + - string + - 'null' + 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`, + `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 + - 'null' + description: A classification of the file. For example to identify it as generated. + 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 + 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 + description: A unique identifier of the repository. + examples: + - 1296269 + node_id: + type: string + description: The GraphQL identifier of the repository. + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + description: The name of the repository. + examples: + - Hello-World + full_name: + type: string + description: The full, globally unique, name of the repository. + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + description: Whether the repository is private. + html_url: + type: string + format: uri + description: The URL to view the repository on GitHub.com. + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + description: The repository description. + examples: + - This your first repo! + fork: + type: boolean + description: Whether the repository is a fork. + url: + type: string + format: uri + description: The URL to get more information about the repository from the + GitHub API. + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + description: A template for the API URL to download the repository as an + archive. + examples: + - https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + description: A template for the API URL to list the available assignees + for issues in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + description: A template for the API URL to create or retrieve a raw Git + blob in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + description: A template for the API URL to get information about branches + in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + description: A template for the API URL to get information about collaborators + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + description: A template for the API URL to get information about comments + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + description: A template for the API URL to get information about commits + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + description: A template for the API URL to compare two commits or refs. + examples: + - https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + description: A template for the API URL to get the contents of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + description: A template for the API URL to list the contributors to the + repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + description: The API URL to list the deployments of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + description: The API URL to list the downloads on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + description: The API URL to list the events of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + description: The API URL to list the forks of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + description: A template for the API URL to get information about Git commits + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + description: A template for the API URL to get information about Git refs + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + description: A template for the API URL to get information about Git tags + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + issue_comment_url: + type: string + description: A template for the API URL to get information about issue comments + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + description: A template for the API URL to get information about issue events + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + description: A template for the API URL to get information about issues + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + description: A template for the API URL to get information about deploy + keys on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + description: A template for the API URL to get information about labels + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + description: The API URL to get information about the languages of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + description: The API URL to merge branches in the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + description: A template for the API URL to get information about milestones + of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + description: A template for the API URL to get information about notifications + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + description: A template for the API URL to get information about pull requests + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + description: A template for the API URL to get information about releases + on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/releases{/id} + stargazers_url: + type: string + format: uri + description: The API URL to list the stargazers on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + description: A template for the API URL to get information about statuses + of a commit. + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + description: The API URL to list the subscribers on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + description: The API URL to subscribe to notifications for this repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + description: The API URL to get information about tags on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + description: The API URL to list the teams on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + description: A template for the API URL to create or retrieve a raw Git + tree of the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + hooks_url: + type: string + format: uri + description: The API URL to list the hooks on the repository. + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks + 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-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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + required: + - number + - created_at + - url + - html_url + - instances_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + - most_recent_instance + - repository + enterprise-security-analysis-settings: + title: Enterprise Security Analysis Settings + type: object + properties: + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + Whether GitHub advanced security is automatically enabled for new repositories and repositories transferred to + this enterprise. + examples: + - false + advanced_security_enabled_for_new_user_namespace_repositories: + type: boolean + description: Whether GitHub Advanced Security is automatically enabled for + new user namespace repositories. + examples: + - false + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + Whether Dependabot alerts are automatically enabled for new repositories and repositories transferred to this + enterprise. + examples: + - false + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + Whether secret scanning is automatically enabled for new repositories and repositories transferred to this + enterprise. + examples: + - false + secret_scanning_push_protection_enabled_for_new_repositories: + type: boolean + description: |- + Whether secret scanning push protection is automatically enabled for new repositories and repositories + transferred to this enterprise. + examples: + - false + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: An optional URL string to display to contributors who are blocked + from pushing a secret. + examples: + - https://github.com/test-org/test-repo/blob/main/README.md + secret_scanning_non_provider_patterns_enabled_for_new_repositories: + type: boolean + description: Whether secret scanning of non-provider patterns is enabled + for new repositories under this enterprise. + examples: + - false + required: + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + 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 + - 'null' + description: Details pertaining to the package version that patches this + vulnerability. + readOnly: 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 + - 'null' + description: The unique CVE ID assigned to the advisory. + readOnly: 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 + 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 + - 'null' + description: The full CVSS vector string for the advisory. + readOnly: true + required: + - score + - vector_string + additionalProperties: false + cvss_severities: + "$ref": "#/components/schemas/cvss-severities" + 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 + - 'null' + description: 'The time that the advisory was withdrawn in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + required: + - ghsa_id + - cve_id + - summary + - description + - vulnerabilities + - severity + - cvss + - cwes + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + additionalProperties: false + alert-auto-dismissed-at: + type: + - string + - 'null' + description: 'The time that the alert was auto-dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + format: date-time + readOnly: true + 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 + - 'null' + description: The execution scope of the vulnerable dependency. + readOnly: true + enum: + - development + - runtime + - + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + dismissed_reason: + type: + - string + - 'null' + description: The reason that the alert was dismissed. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + - + dismissed_comment: + type: + - string + - 'null' + description: An optional comment associated with the alert's dismissal. + maxLength: 280 + fixed_at: + "$ref": "#/components/schemas/alert-fixed-at" + auto_dismissed_at: + "$ref": "#/components/schemas/alert-auto-dismissed-at" + 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 + 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 + - 'null' + description: "**Required when the `state` is `resolved`.** The reason for resolving + the alert." + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - + organization-secret-scanning-alert: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + repository: + "$ref": "#/components/schemas/simple-repository" + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + resolution_comment: + type: + - string + - 'null' + description: The comment that was optionally added when this alert was closed + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + advanced-security-active-committers-user: + type: object + properties: + user_login: + type: string + last_pushed_date: + type: string + examples: + - '2021-11-03' + last_pushed_email: + type: string + examples: + - monalisa@github.com + required: + - user_login + - last_pushed_date + - last_pushed_email + advanced-security-active-committers-repository: + type: object + properties: + name: + type: string + examples: + - octocat/Hello-World + advanced_security_committers: + type: integer + examples: + - 25 + advanced_security_committers_breakdown: + type: array + items: + "$ref": "#/components/schemas/advanced-security-active-committers-user" + required: + - name + - advanced_security_committers + - advanced_security_committers_breakdown + advanced-security-active-committers: + type: object + properties: + total_advanced_security_committers: + type: integer + examples: + - 25 + total_count: + type: integer + examples: + - 2 + maximum_advanced_security_committers: + type: integer + description: The total number of GitHub Advanced Security licences required + if all repositories were to enable GitHub Advanced Security + examples: + - 4 + purchased_advanced_security_committers: + type: integer + description: The total number of GitHub Advanced Security licences purchased + examples: + - 4 + repositories: + type: array + items: + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + required: + - repositories + actor: + title: Actor + description: Actor + type: object + properties: + id: + type: integer + login: + type: string + display_login: + type: string + gravatar_id: + type: + - string + - 'null' + url: + type: string + format: uri + avatar_url: + type: string + format: uri + required: + - id + - login + - gravatar_id + - url + - avatar_url + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones/1 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/milestones/v1.0 + labels_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/milestones/1/labels + id: + type: integer + examples: + - 1002604 + node_id: + type: string + examples: + - MDk6TWlsZXN0b25lMTAwMjYwNA== + number: + description: The number of the milestone. + type: integer + examples: + - 42 + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + default: open + examples: + - open + title: + description: The title of the milestone. + type: string + examples: + - v1.0 + description: + type: + - string + - 'null' + examples: + - Tracking milestone for version 1.0 + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + open_issues: + type: integer + examples: + - 4 + closed_issues: + type: integer + examples: + - 8 + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2013-02-12T13:22:01Z' + due_on: + type: + - string + - 'null' + format: date-time + examples: + - '2012-10-09T23:39:01Z' + 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 + author-association: + title: author_association + type: string + description: How the author is associated with the repository. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + examples: + - 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 + 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 + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/1 + 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 + type: integer + examples: + - 42 + state: + description: State of the issue; either 'open' or 'closed' + type: string + examples: + - open + state_reason: + description: The reason for the current state + type: + - string + - 'null' + enum: + - completed + - reopened + - not_planned + - + examples: + - not_planned + title: + description: Title of the issue + type: string + examples: + - Widget creation fails in Safari on OS X 10.8 + body: + description: Contents of the issue + type: + - string + - 'null' + examples: + - 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? + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + - 'null' + color: + type: + - string + - 'null' + default: + type: boolean + examples: + - bug + - registration + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + locked: + type: boolean + active_lock_reason: + type: + - string + - 'null' + comments: + type: integer + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + required: + - diff_url + - html_url + - patch_url + - url + closed_at: + type: + - string + - 'null' + format: date-time + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + draft: + type: boolean + closed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body_html: + type: string + body_text: + type: string + timeline_url: + type: string + format: uri + repository: + "$ref": "#/components/schemas/repository" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + author_association: + "$ref": "#/components/schemas/author-association" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + sub_issues_summary: + "$ref": "#/components/schemas/sub-issues-summary" + 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 + 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 + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + body_text: + type: string + body_html: + type: string + html_url: + type: string + format: uri + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - id + - node_id + - html_url + - issue_url + - author_association + - user + - url + - created_at + - updated_at + event: + title: Event + description: Event + type: object + properties: + id: + type: string + type: + type: + - string + - 'null' + 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: + type: object + properties: + action: + type: string + issue: + "$ref": "#/components/schemas/issue" + comment: + "$ref": "#/components/schemas/issue-comment" + pages: + type: array + items: + type: object + properties: + page_name: + type: string + title: + type: string + summary: + type: + - string + - 'null' + action: + type: string + sha: + type: string + html_url: + type: string + public: + type: boolean + created_at: + type: + - string + - 'null' + format: date-time + 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 + examples: + - https://github.com/timeline + user_url: + type: string + examples: + - https://github.com/{user} + current_user_public_url: + type: string + examples: + - https://github.com/octocat + current_user_url: + type: string + examples: + - https://github.com/octocat.private?token=abc123 + current_user_actor_url: + type: string + examples: + - https://github.com/octocat.private.actor?token=abc123 + current_user_organization_url: + type: string + examples: + - https://github.com/octocat-org + current_user_organization_urls: + type: array + items: + type: string + format: uri + examples: + - https://github.com/organizations/github/octocat.private.atom?token=abc123 + security_advisories_url: + type: string + examples: + - https://github.com/security-advisories + repository_discussions_url: + type: string + description: A feed of discussions for a given repository. + examples: + - https://github.com/{user}/{repo}/discussions + repository_discussions_category_url: + type: string + description: A feed of discussions for a given repository and category. + examples: + - https://github.com/{user}/{repo}/discussions/categories/{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 + - 'null' + comments: + type: integer + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + - 'null' + 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 + - 'null' + company: + type: + - string + - 'null' + blog: + type: + - string + - 'null' + location: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + notification_email: + type: + - string + - 'null' + format: email + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + twitter_username: + type: + - string + - 'null' + 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 + examples: + - 1 + total_private_repos: + type: integer + examples: + - 2 + owned_private_repos: + type: integer + examples: + - 2 + disk_usage: + type: integer + examples: + - 1 + collaborators: + type: integer + examples: + - 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + type: + - array + - 'null' + 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 + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/gist-history" + fork_of: + title: Gist + description: Gist + type: + - object + - 'null' + 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 + - 'null' + comments: + type: integer + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments_url: + type: string + format: uri + owner: + anyOf: + - type: 'null' + - "$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 + 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: + type: + - object + - 'null' + 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 + - 'null' + comments: + type: integer + user: + type: + - string + - 'null' + comments_url: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + truncated: + type: boolean + gist-comment: + title: Gist Comment + description: A comment made to a gist. + type: object + properties: + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDExOkdpc3RDb21tZW50MQ== + url: + type: string + format: uri + examples: + - https://api.github.com/gists/a6db0bec360bb87e9418/comments/1 + body: + description: The comment text. + type: string + maxLength: 65535 + examples: + - Body of the attachment + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-18T23:23:56Z' + updated_at: + type: string + format: date-time + examples: + - '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 + examples: + - https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f + version: + type: string + examples: + - 57a7f021a713b1c5a6a199b54cc514735d2d462f + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + change_status: + type: object + properties: + total: + type: integer + additions: + type: integer + deletions: + type: integer + committed_at: + type: string + format: date-time + examples: + - '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 + examples: + - C + source: + type: string + examples: + - | + # Object files + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + required: + - name + - source + license: + title: License + description: License + type: object + properties: + key: + type: string + examples: + - mit + name: + type: string + examples: + - MIT License + spdx_id: + type: + - string + - 'null' + examples: + - MIT + url: + type: + - string + - 'null' + format: uri + examples: + - https://api.github.com/licenses/mit + node_id: + type: string + examples: + - MDc6TGljZW5zZW1pdA== + html_url: + type: string + format: uri + examples: + - http://choosealicense.com/licenses/mit/ + description: + type: string + examples: + - 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 + examples: + - 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 + items: + type: string + examples: + - commercial-use + - modifications + - distribution + - sublicense + - private-use + conditions: + type: array + items: + type: string + examples: + - include-copyright + limitations: + type: array + items: + type: string + examples: + - no-liability + body: + type: string + examples: + - |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 + examples: + - true + required: + - key + - name + - url + - spdx_id + - node_id + - html_url + - description + - implementation + - permissions + - conditions + - limitations + - body + - featured + ghes-get-ssh: + type: array + items: + type: object + properties: + key: + type: string + format: ssh-key + description: The full public key + fingerprint: + type: string + format: ssh-key fingerprint + description: The fingerprint of the key + ghes-set-ssh-request: + title: Set SSH key + type: object + properties: + key: + description: The public SSH key to add to the `authorized_keys` file. + type: string + required: + - key + ghes-set-ssh-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + description: Hostname of the node where the SSH key was added. + uuid: + type: string + format: uuid + description: UUID of the SSH key that was added. + message: + type: string + description: Message indicating the result of the SSH key addition. + error: + type: string + description: Error message indicating the reason for the SSH key addition + failure. This field is only present if the SSH key addition failed. + modified: + type: boolean + description: Whether the SSH key was already present on the `authorized_keys` + file. + ghes-delete-ssh-request: + title: Set SSH key + type: object + properties: + key: + description: The public SSH key to remove from the `authorized_keys` file. + type: string + required: + - key + ghes-delete-ssh-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + description: Hostname of the node where the SSH key was removed. + uuid: + type: string + format: uuid + description: UUID of the SSH key that was removed. + message: + type: string + description: Message indicating the result of the SSH key removal. + error: + type: string + description: Error message indicating the reason for the SSH key removal + failure. This field is only present if the SSH key removal failed. + ghes-checks-result-indicator: + type: string + enum: + - OK + - FAILED + ghes-checks-system-requirements: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + roles_status: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-checks-result-indicator" + role: + type: string + ghes-cluster-status-indicator: + type: string + enum: + - UNKNOWN + - OK + - WARNING + - CRITICAL + ghes-cluster-status: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + services: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-cluster-status-indicator" + name: + type: string + details: + type: string + ghes-config-init-request: + title: Initialize configuration with license upload + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + password: + type: string + description: The root site administrator password. + required: + - license + - password + ghes-license-info: + type: object + properties: + advancedSecurityEnabled: + description: Whether the GitHub Advanced Security feature is enabled. + type: boolean + advancedSecuritySeats: + description: If the GitHub Advanced Security feature is enabled, the seat + count. + type: integer + clusterSupport: + description: Whether the cluster support feature is enabled. + type: boolean + company: + description: The company under which the license is issued. + type: string + croquetSupport: + description: Whether the Github Connect feature is enabled. + type: boolean + customTerms: + description: Whether this license is issued under custom terms. + type: boolean + evaluation: + description: Wheter this license is issued as an evaluation license. + type: boolean + expireAt: + description: The expiration date of the license. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + insightsEnabled: + description: Whether the insights feature is enabled. + type: boolean + insightsExpireAt: + description: If the insights feature is enabled, the expiration date. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + learningLabEvaluationExpires: + description: If the learning lab feature is enabled, the expiration date. + type: string + format: date-time + examples: + - '2025-01-02T07:59:59Z' + learningLabSeats: + description: If the learning lab feature is enabled, the seat count. + type: integer + perpetual: + description: Whether the perpetual feature is enabled. + type: boolean + referenceNumber: + description: The unique reference number of the license. + type: string + seats: + description: If the license is issued with limited seating, the seat count. + type: integer + sshAllowed: + description: Whether the SSH feature is enabled. + type: boolean + supportKey: + description: The support key of the license. + type: string + unlimitedSeating: + description: Whether the license is issued with unlimited seat count. + type: boolean + ghes-upload-license-request: + title: License upload form + type: object + properties: + license: + type: string + description: The content of your _.ghl_ license file. + required: + - license + ghes-license-check: + type: object + properties: + status: + description: The license status of the currently active enterprise license. + type: string + enum: + - valid + - invalid + - expired + - cluster mode not supported + ghes-cluster-topology: + type: string + enum: + - SingleNode + - Ha + - Cluster + ghes-cluster-roles: + type: string + enum: + - Blank + - ActionsServer + - ConsulServer + - ElasticsearchServer + - GitServer + - JobServer + - LaunchServer + - MemcacheServer + - MetricsServer + - MssqlServer + - MysqlServer + - PagesServer + - RedisServer + - StorageServer + - WebServer + ghes-config-nodes: + type: object + properties: + topology: + "$ref": "#/components/schemas/ghes-cluster-topology" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + uuid: + type: string + replica: + type: boolean + cluster_roles: + type: array + items: + "$ref": "#/components/schemas/ghes-cluster-roles" + ghes-get-settings: + type: object + properties: + private_mode: + type: boolean + public_pages: + type: boolean + subdomain_isolation: + type: boolean + signup_enabled: + type: boolean + github_hostname: + type: string + identicons_host: + type: string + http_proxy: + type: + - string + - 'null' + auth_mode: + type: string + expire_sessions: + type: boolean + admin_password: + type: + - string + - 'null' + configuration_id: + type: integer + configuration_run_count: + type: integer + avatar: + type: object + properties: + enabled: + type: boolean + uri: + type: string + customer: + type: object + properties: + name: + type: string + email: + type: string + uuid: + type: string + secret_key_data: + type: string + public_key_data: + type: string + license: + type: object + properties: + seats: + type: integer + evaluation: + type: boolean + perpetual: + type: boolean + unlimited_seating: + type: boolean + support_key: + type: string + ssh_allowed: + type: boolean + cluster_support: + type: boolean + expire_at: + type: string + github_ssl: + type: object + properties: + enabled: + type: boolean + cert: + type: + - string + - 'null' + key: + type: + - string + - 'null' + ldap: + type: object + properties: + host: + type: + - string + - 'null' + port: + type: integer + base: + type: array + items: + type: string + uid: + type: + - string + - 'null' + bind_dn: + type: + - string + - 'null' + password: + type: + - string + - 'null' + method: + type: string + search_strategy: + type: string + user_groups: + type: array + items: + type: string + admin_group: + type: + - string + - 'null' + virtual_attribute_enabled: + type: boolean + recursive_group_search: + type: boolean + posix_support: + type: boolean + user_sync_emails: + type: boolean + user_sync_keys: + type: boolean + user_sync_interval: + type: integer + team_sync_interval: + type: integer + sync_enabled: + type: boolean + reconciliation: + type: object + properties: + user: + type: + - string + - 'null' + org: + type: + - string + - 'null' + profile: + type: object + properties: + uid: + type: string + name: + type: + - string + - 'null' + mail: + type: + - string + - 'null' + key: + type: + - string + - 'null' + cas: + type: object + properties: + url: + type: + - string + - 'null' + saml: + type: object + properties: + sso_url: + type: + - string + - 'null' + certificate: + type: + - string + - 'null' + certificate_path: + type: + - string + - 'null' + issuer: + type: + - string + - 'null' + idp_initiated_sso: + type: boolean + disable_admin_demote: + type: boolean + github_oauth: + type: object + properties: + client_id: + type: string + client_secret: + type: string + organization_name: + type: string + organization_team: + type: string + smtp: + type: object + properties: + enabled: + type: boolean + address: + type: string + authentication: + type: string + port: + type: string + domain: + type: string + username: + type: string + user_name: + type: string + enable_starttls_auto: + type: boolean + password: + type: string + discard-to-noreply-address: + type: boolean + support_address: + type: string + support_address_type: + type: string + noreply_address: + type: string + ntp: + type: object + properties: + primary_server: + type: string + secondary_server: + type: string + timezone: + type: + - string + - 'null' + snmp: + type: object + properties: + enabled: + type: boolean + community: + type: string + syslog: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + protocol_name: + type: string + assets: + type: + - string + - 'null' + pages: + type: object + properties: + enabled: + type: boolean + collectd: + type: object + properties: + enabled: + type: boolean + server: + type: + - string + - 'null' + port: + type: integer + encryption: + type: + - string + - 'null' + username: + type: + - string + - 'null' + password: + type: + - string + - 'null' + mapping: + type: object + properties: + enabled: + type: boolean + tileserver: + type: + - string + - 'null' + basemap: + type: string + token: + type: + - string + - 'null' + load_balancer: + type: + - string + - 'null' + ghes-get-maintenance: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + uuid: + type: string + format: uuid + status: + type: string + enum: + - 'on' + - 'off' + - scheduled + scheduled_time: + type: string + format: date + connection_services: + type: array + items: + type: object + properties: + name: + type: string + number: + type: integer + can_unset_maintenance: + type: boolean + ip_exception_list: + type: array + items: + type: string + format: ip/cidr + maintenance_mode_message: + type: string + ghes-set-maintenance-request: + title: Set Maintenance mode + type: object + properties: + enabled: + description: Whether to enable maintenance mode. + type: boolean + uuid: + description: The UUID of the node to target. This parameter is incompatible + with maintenance mode scheduling. Only use `uuid` if the value of `when` + is empty or `now`. + type: string + format: uuid + when: + description: The time to enable maintenance mode. If this parameter is empty + or set to `now`, maintenance mode is enabled immediately. Otherwise, maintenance + mode is enabled at the specified time. The format is ISO 8601. + type: string + format: date-time + examples: + - '2006-01-02T15:04:05+00:00' + ip_exception_list: + description: The list of IP addresses to exclude from maintenance mode. + IPv4, IPv6, and CIDR addresses are supported. + type: array + items: + type: string + format: ip/cidr + examples: + - '["1.1.1.1","192.168.1.0/24"]' + maintenance_mode_message: + description: The message to display to users when maintenance mode is enabled. + type: string + required: + - enabled + ghes-set-maintenance-response: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + uuid: + type: string + format: uuid + message: + type: string + error: + type: string + ghes-replication-status-indicator: + type: string + enum: + - UNKNOWN + - OK + - WARNING + - CRITICAL + ghes-replication-status: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + nodes: + type: array + items: + type: object + properties: + hostname: + type: string + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + services: + type: array + items: + type: object + properties: + status: + "$ref": "#/components/schemas/ghes-replication-status-indicator" + name: + type: string + details: + type: string + ghes-version: + type: array + items: + type: object + properties: + hostname: + type: string + format: hostname + version: + type: object + properties: + version: + type: string + pattern: "[0-9]\\.[0-9]{2}\\.[0-9]" + platform: + type: string + enum: + - ami + - azure + - esx + - gce + - hyperv + - kvm + build_id: + type: string + pattern: "[0-9a-f]{8}" + build_date: + type: string + format: date + api-overview: + title: Api Overview + description: Api Overview + type: object + properties: + verifiable_password_authentication: + type: boolean + examples: + - true + packages: + type: array + items: + type: string + examples: + - 192.0.2.1 + domains: + type: object + properties: + website: + type: array + items: + type: string + examples: + - example.com + codespaces: + type: array + items: + type: string + examples: + - example.com + copilot: + type: array + items: + type: string + examples: + - example.com + packages: + type: array + items: + type: string + examples: + - example.com + actions: + type: array + items: + type: string + examples: + - example.com + artifact_attestations: + type: object + properties: + trust_domain: + type: string + examples: + - example + services: + type: array + items: + type: string + examples: + - example.com + installed_version: + type: string + examples: + - 3.15.0 + required: + - verifiable_password_authentication + security-and-analysis: + type: + - object + - 'null' + properties: + advanced_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 + minimal-repository: + title: Minimal Repository + description: Minimal Repository + type: object + properties: + id: + type: integer + format: int64 + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + mirror_url: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + homepage: + type: + - string + - 'null' + language: + type: + - string + - 'null' + 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 + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + role_name: + type: string + examples: + - 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 + - 'null' + properties: + key: + type: string + name: + type: string + spdx_id: + type: string + url: + type: string + node_id: + type: string + forks: + type: integer + examples: + - 0 + open_issues: + type: integer + examples: + - 0 + watchers: + type: integer + examples: + - 0 + allow_forking: + type: boolean + web_commit_signoff_required: + type: boolean + examples: + - false + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + 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 + 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 + - 'null' + url: + type: string + subscription_url: + type: string + examples: + - 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 + examples: + - true + ignored: + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/notifications/threads/1/subscription + thread_url: + type: string + format: uri + examples: + - https://api.github.com/notifications/threads/1 + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/1 + required: + - created_at + - ignored + - reason + - url + - subscribed + organization-custom-repository-role: + title: Organization Custom Repository Role + description: Custom repository roles created by organization owners + type: object + properties: + id: + description: The unique identifier of the custom role. + type: integer + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + organization: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - name + - base_role + - permissions + - organization + - created_at + - updated_at + organization-full: + title: Organization Full + description: Organization Full + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + name: + type: string + examples: + - github + company: + type: string + examples: + - GitHub + blog: + type: string + format: uri + examples: + - https://github.com/blog + location: + type: string + examples: + - San Francisco + email: + type: string + format: email + examples: + - octocat@github.com + twitter_username: + type: + - string + - 'null' + examples: + - github + is_verified: + type: boolean + examples: + - true + has_organization_projects: + type: boolean + examples: + - true + has_repository_projects: + type: boolean + examples: + - true + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + type: + type: string + examples: + - Organization + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + private_gists: + type: + - integer + - 'null' + examples: + - 81 + disk_usage: + type: + - integer + - 'null' + examples: + - 10000 + collaborators: + type: + - integer + - 'null' + description: |- + The number of collaborators on private repositories. + + This field may be null if the number of private repositories is over 50,000. + examples: + - 8 + billing_email: + type: + - string + - 'null' + format: email + examples: + - org@example.com + 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 + - 'null' + members_can_create_repositories: + type: + - boolean + - 'null' + examples: + - true + two_factor_requirement_enabled: + type: + - boolean + - 'null' + examples: + - true + members_allowed_repository_creation_type: + type: string + examples: + - all + members_can_create_public_repositories: + type: boolean + examples: + - true + members_can_create_private_repositories: + type: boolean + examples: + - true + members_can_create_internal_repositories: + type: boolean + examples: + - true + members_can_create_pages: + type: boolean + examples: + - true + members_can_create_public_pages: + type: boolean + examples: + - true + members_can_create_private_pages: + type: boolean + examples: + - true + members_can_fork_private_repositories: + type: + - boolean + - 'null' + examples: + - false + web_commit_signoff_required: + type: boolean + examples: + - false + advanced_security_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/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. + examples: + - false + deprecated: true + dependabot_alerts_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/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. + examples: + - false + 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/enterprise-server@3.15/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. + examples: + - false + deprecated: true + dependency_graph_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/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. + examples: + - false + deprecated: true + secret_scanning_enabled_for_new_repositories: + type: boolean + description: |- + **Endpoint closing down notice.** Please use [code security configurations](https://docs.github.com/enterprise-server@3.15/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. + examples: + - false + 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/enterprise-server@3.15/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. + examples: + - false + 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. + examples: + - false + secret_scanning_push_protection_custom_link: + type: + - string + - 'null' + description: An optional URL string to display to contributors who are blocked + from pushing a secret. + examples: + - https://github.com/test-org/test-repo/blob/main/README.md + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + archived_at: + type: + - string + - 'null' + format: date-time + 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 + 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 + examples: + - 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 + examples: + - 2322142 + active_caches_count: + description: The number of active caches in the repository. + type: integer + examples: + - 3 + required: + - full_name + - active_caches_size_in_bytes + - active_caches_count + 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 + 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" + required: + - enabled_repositories + 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 + 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. + examples: + - octo-org/octo-repo/.github/workflows/deploy.yaml@main + required: + - id + - name + - visibility + - default + - runners_url + - inherited + - allows_public_repositories + 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. + type: string + examples: + - SECRET_TOKEN + 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 + examples: + - 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 + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + id: + type: integer + examples: + - 2 + url: + type: string + examples: + - https://api.github.com/user/keys/2 + title: + type: string + examples: + - ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: + type: string + examples: + - '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. + type: string + examples: + - USERNAME + value: + description: The value of the variable. + type: string + examples: + - octocat + 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 + examples: + - '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 + examples: + - '2019-01-24T22:45:36.000Z' + visibility: + description: Visibility of a variable + enum: + - all + - private + - selected + type: string + selected_repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/org/variables/USERNAME/repositories + required: + - name + - value + - created_at + - updated_at + - visibility + announcement-user-dismissible: + type: + - boolean + - 'null' + description: Whether an announcement can be dismissed by the user. + default: false + examples: + - false + announcement-banner: + title: Announcement Banner + description: Announcement at either the repository, organization, or enterprise + level + type: object + properties: + announcement: + "$ref": "#/components/schemas/announcement-message" + expires_at: + "$ref": "#/components/schemas/announcement-expiration" + user_dismissible: + "$ref": "#/components/schemas/announcement-user-dismissible" + required: + - announcement + - expires_at + - user_dismissible + code-scanning-alert-severity: + type: string + description: Severity of a code scanning alert. + enum: + - critical + - high + - medium + - low + - warning + - note + - error + 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 + dependency_graph: + type: string + description: The enablement status of Dependency Graph + enum: + - enabled + - disabled + - not_set + 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 + 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 + 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 + 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-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" + organization-custom-repository-role-create-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + required: + - name + - base_role + - permissions + organization-custom-repository-role-update-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about who this role is for or what permissions + it grants. + type: + - string + - 'null' + base_role: + type: string + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + 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. + type: string + examples: + - SECRET_TOKEN + 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 + examples: + - 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 + examples: + - '1234567' + key: + description: The Base64 encoded public key. + type: string + examples: + - hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs= + required: + - key_id + - key + package: + title: Package + description: A software package + type: object + properties: + id: + description: Unique identifier of the package. + type: integer + examples: + - 1 + name: + description: The name of the package. + type: string + examples: + - super-linter + package_type: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + examples: + - docker + url: + type: string + examples: + - https://api.github.com/orgs/github/packages/container/super-linter + html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/package/super-linter + version_count: + description: The number of versions of the package. + type: integer + examples: + - 1 + visibility: + type: string + enum: + - private + - public + examples: + - private + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + external-group: + title: ExternalGroup + description: Information about an external group's usage and its members + type: object + required: + - group_id + - group_name + - teams + - members + properties: + group_id: + description: The internal ID of the group + type: integer + examples: + - 1 + group_name: + description: The display name for the group + type: string + examples: + - group-azuread-test + updated_at: + description: The date when the group was last updated_at + type: string + examples: + - 2021-01-03 22:27:15:000 -700 + teams: + description: An array of teams linked to this group + type: array + items: + type: object + required: + - team_id + - team_name + properties: + team_id: + description: The id for a team + type: integer + examples: + - 1 + team_name: + description: The name of the team + type: string + examples: + - team-test + examples: + - team_id: 1 + team_name: team-test + - team_id: 2 + team_name: team-test2 + members: + description: An array of external members linked to this group + type: array + items: + type: object + required: + - member_id + - member_login + - member_name + - member_email + properties: + member_id: + description: The internal user ID of the identity + type: integer + examples: + - 1 + member_login: + description: The handle/login for the user + type: string + examples: + - mona-lisa_eocsaxrs + member_name: + description: The user display name/profile name + type: string + examples: + - Mona Lisa + member_email: + description: An email attached to a user + type: string + examples: + - mona_lisa@github.com + examples: + - member_id: 1 + member_login: mona-lisa_eocsaxrs + member_name: Mona Lisa + member_email: mona_lisa@github.com + - member_id: 2 + member_login: octo-lisa_eocsaxrs + member_name: Octo Lisa + member_email: octo_lisa@github.com + external-groups: + title: ExternalGroups + description: A list of external groups available to be connected to a team + type: object + properties: + groups: + description: An array of external groups available to be mapped to a team + type: array + items: + type: object + required: + - group_id + - group_name + - updated_at + properties: + group_id: + description: The internal ID of the group + type: integer + examples: + - 1 + group_name: + description: The display name of the group + type: string + examples: + - group-azuread-test + updated_at: + description: The time of the last update for this group + type: string + examples: + - 2019-06-03 22:27:15:000 -700 + examples: + - group_id: 1 + group_name: group-azuread-test + updated_at: 2021-01-03 22:27:15:000 -700 + - group_id: 2 + group_name: group-azuread-test2 + updated_at: 2021-06-03 22:27:15:000 -700 + org-hook: + title: Org Hook + description: Org Hook + type: object + properties: + id: + type: integer + examples: + - 1 + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1 + ping_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1/pings + deliveries_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat/hooks/1/deliveries + name: + type: string + examples: + - web + events: + type: array + items: + type: string + examples: + - push + - pull_request + active: + type: boolean + examples: + - true + config: + type: object + properties: + url: + type: string + examples: + - '"http://example.com/2"' + insecure_ssl: + type: string + examples: + - '"0"' + content_type: + type: string + examples: + - '"form"' + secret: + type: string + examples: + - '"********"' + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + type: + type: string + required: + - id + - url + - type + - name + - active + - events + - config + - ping_url + - created_at + - updated_at + org-membership: + title: Org Membership + description: Org Membership + type: object + properties: + url: + type: string + format: uri + examples: + - 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. + enum: + - active + - pending + examples: + - active + role: + type: string + description: The user's membership type in the organization. + enum: + - admin + - member + - billing_manager + examples: + - admin + organization_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/octocat + organization: + "$ref": "#/components/schemas/organization-simple" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 79 + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + guid: + type: string + examples: + - 0b989ba4-242f-11e5-81e1-c7b6966d2516 + state: + type: string + examples: + - pending + lock_repositories: + type: boolean + examples: + - 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 + examples: + - https://api.github.com/orgs/octo-org/migrations/79 + created_at: + type: string + format: date-time + examples: + - '2015-07-06T15:33:38-07:00' + updated_at: + type: string + format: date-time + examples: + - '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 + organization-fine-grained-permission: + title: Organization Fine-Grained Permission + description: A fine-grained permission that protects organization resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + 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 + - 'null' + base_role: + type: + - string + - 'null' + description: The system role from which this role inherits permissions. + enum: + - read + - triage + - write + - maintain + - admin + - + source: + type: + - string + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + organization-custom-organization-role-create-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about the intended usage of this role or + what permissions it grants. + type: string + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + base_role: + description: The system role from which this role can inherit permissions. + type: string + enum: + - read + - triage + - write + - maintain + - admin + required: + - name + - permissions + organization-custom-organization-role-update-schema: + type: object + properties: + name: + description: The name of the custom role. + type: string + description: + description: A short description about the intended use of this role or + the permissions it grants. + type: string + permissions: + description: A list of additional permissions included in this role. + type: array + items: + type: string + base_role: + description: The system role from which this role can inherit permissions. + type: string + enum: + - none + - read + - triage + - write + - maintain + - admin + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + 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 + examples: + - direct + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + 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 + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - 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 + examples: + - direct + inherited_from: + description: Team the user has gotten the role through + type: array + items: + "$ref": "#/components/schemas/team-simple" + name: + type: + - string + - 'null' + email: + type: + - string + - 'null' + login: + type: string + examples: + - octocat + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + starred_at: + type: string + examples: + - '"2020-07-09T00:17:55Z"' + user_view_type: + type: string + examples: + - 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 + examples: + - 1 + name: + description: The name of the package version. + type: string + examples: + - latest + url: + type: string + examples: + - https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 + package_html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/package/super-linter + html_url: + type: string + examples: + - https://github.com/orgs/github/packages/container/super-linter/786068 + license: + type: string + examples: + - MIT + description: + type: string + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + deleted_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + metadata: + type: object + title: Package Version Metadata + properties: + package_type: + type: string + enum: + - npm + - maven + - rubygems + - docker + - nuget + - container + examples: + - docker + 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 + - 'null' + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + 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-pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + configuration_url: + type: string + allow_downstream_configuration: + type: boolean + project: + title: Project + description: Projects are a way to organize columns and cards of work. + type: object + properties: + owner_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test + url: + type: string + format: uri + examples: + - https://api.github.com/projects/1002604 + html_url: + type: string + format: uri + examples: + - https://github.com/api-playground/projects-test/projects/12 + columns_url: + type: string + format: uri + examples: + - https://api.github.com/projects/1002604/columns + id: + type: integer + examples: + - 1002604 + node_id: + type: string + examples: + - MDc6UHJvamVjdDEwMDI2MDQ= + name: + description: Name of the project + type: string + examples: + - Week One Sprint + body: + description: Body of the project + type: + - string + - 'null' + examples: + - This project represents the sprint of the first week in January + number: + type: integer + examples: + - 1 + state: + description: State of the project; either 'open' or 'closed' + type: string + examples: + - open + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2011-04-10T20:09:31Z' + updated_at: + type: string + format: date-time + examples: + - '2014-03-03T18:58:10Z' + organization_permission: + description: The baseline permission that all organization members have + on this project. Only present if owner is an organization. + type: string + enum: + - read + - write + - admin + - none + private: + description: Whether or not this project can be seen by everyone. Only present + if owner is an organization. + type: boolean + required: + - id + - node_id + - number + - name + - body + - state + - url + - html_url + - owner_url + - creator + - columns_url + - created_at + - updated_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 + examples: + - organization + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + 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 + - 'null' + enum: + - org_actors + - org_and_repo_actors + - + description: Who can edit the values of the property + examples: + - org_actors + 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 + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + 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 + type: + - 'null' + - string + - array + 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 + examples: + - 1296269 + repository_name: + type: string + examples: + - Hello-World + repository_full_name: + type: string + examples: + - 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 + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + examples: + - citizen_code_of_conduct + name: + type: string + examples: + - Citizen Code of Conduct + html_url: + type: + - string + - 'null' + format: uri + examples: + - 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 + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + type: boolean + examples: + - true + topics: + type: array + items: + type: string + examples: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + examples: + - true + has_projects: + type: boolean + examples: + - true + has_wiki: + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + type: boolean + examples: + - true + has_discussions: + type: boolean + examples: + - true + 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 + examples: + - public + pushed_at: + type: string + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '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 + examples: + - true + template_repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository" + temp_clone_token: + type: + - string + - 'null' + allow_squash_merge: + type: boolean + examples: + - true + allow_auto_merge: + type: boolean + examples: + - false + delete_branch_on_merge: + type: boolean + examples: + - false + allow_merge_commit: + type: boolean + examples: + - true + allow_update_branch: + type: boolean + examples: + - true + use_squash_pr_title_as_default: + type: boolean + examples: + - false + 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). + examples: + - PR_TITLE + 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. + examples: + - PR_BODY + 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). + examples: + - PR_TITLE + 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. + examples: + - PR_BODY + allow_forking: + type: boolean + examples: + - true + web_commit_signoff_required: + type: boolean + examples: + - false + subscribers_count: + type: integer + examples: + - 42 + network_count: + type: integer + examples: + - 0 + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + repository-fine-grained-permission: + title: Repository Fine-Grained Permission + description: A fine-grained permission that protects repository resources. + type: object + properties: + name: + type: string + description: + type: string + required: + - name + - description + 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 not available for the `repository` target. + 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 + - 'null' + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. 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. + enum: + - always + - pull_request + 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. + 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. + 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-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 the same + syntax as `.gitignore` files. + 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_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id + 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: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string + 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: + - 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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 will appear to users. + 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-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/enterprise-server@3.15/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/enterprise-server@3.15/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: + 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-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + 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 + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + 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 + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + type: + - 'null' + - object + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + 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 + examples: + - '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 + 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 + - 'null' + description: The number that identifies the user. + actor_name: + type: + - string + - 'null' + 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 + examples: + - '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 + - 'null' + enum: + - pass + - fail + 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 + - 'null' + description: The ID of the rule source. + name: + type: + - string + - 'null' + 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 + - 'null' + description: The detailed failure message for the rule. Null if the + rule passed. + 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 + - 'null' + 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 + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + team-organization: + title: Team Organization + description: Team Organization + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + name: + type: string + examples: + - github + company: + type: string + examples: + - GitHub + blog: + type: string + format: uri + examples: + - https://github.com/blog + location: + type: string + examples: + - San Francisco + email: + type: string + format: email + examples: + - octocat@github.com + twitter_username: + type: + - string + - 'null' + examples: + - github + is_verified: + type: boolean + examples: + - true + has_organization_projects: + type: boolean + examples: + - true + has_repository_projects: + type: boolean + examples: + - true + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + type: + type: string + examples: + - Organization + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + private_gists: + type: + - integer + - 'null' + examples: + - 81 + disk_usage: + type: + - integer + - 'null' + examples: + - 10000 + collaborators: + type: + - integer + - 'null' + examples: + - 8 + billing_email: + type: + - string + - 'null' + format: email + examples: + - org@example.com + 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 + - 'null' + members_can_create_repositories: + type: + - boolean + - 'null' + examples: + - true + two_factor_requirement_enabled: + type: + - boolean + - 'null' + examples: + - true + members_allowed_repository_creation_type: + type: string + examples: + - all + members_can_create_public_repositories: + type: boolean + examples: + - true + members_can_create_private_repositories: + type: boolean + examples: + - true + members_can_create_internal_repositories: + type: boolean + examples: + - true + members_can_create_pages: + type: boolean + examples: + - true + members_can_create_public_pages: + type: boolean + examples: + - true + members_can_create_private_pages: + type: boolean + examples: + - true + members_can_fork_private_repositories: + type: + - boolean + - 'null' + examples: + - false + web_commit_signoff_required: + type: boolean + examples: + - false + updated_at: + type: string + format: date-time + archived_at: + type: + - string + - 'null' + format: date-time + 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 + 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 + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + name: + description: Name of the team + type: string + examples: + - Developers + slug: + type: string + examples: + - justice-league + description: + type: + - string + - 'null' + examples: + - A great team. + privacy: + description: The level of privacy this team should have + type: string + enum: + - closed + - secret + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + enum: + - notifications_enabled + - notifications_disabled + examples: + - notifications_enabled + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - push + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + members_count: + type: integer + examples: + - 3 + repos_count: + type: integer + examples: + - 10 + created_at: + type: string + format: date-time + examples: + - '2017-07-14T16:53:42Z' + updated_at: + type: string + format: date-time + examples: + - '2017-08-17T12:37:15Z' + organization: + "$ref": "#/components/schemas/team-organization" + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - created_at + - updated_at + - members_count + - repos_count + - organization + team-discussion: + title: Team Discussion + description: A team discussion is a persistent record of a free-form conversation + within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the discussion. + type: string + examples: + - Please suggest improvements to our workflow in comments. + body_html: + type: string + examples: + - "

Hi! This is an area for us to collaborate as a team

" + body_version: + description: 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. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + comments_count: + type: integer + examples: + - 0 + comments_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1/comments + created_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: + type: string + examples: + - MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: + description: The unique sequence number of a team discussion. + type: integer + examples: + - 42 + pinned: + description: Whether or not this discussion should be pinned for easy retrieval. + type: boolean + examples: + - true + private: + description: Whether or not this discussion should be restricted to team + members and organization owners. + type: boolean + examples: + - true + team_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027 + title: + description: The title of the discussion. + type: string + examples: + - How can we improve our workflow? + updated_at: + type: string + format: date-time + examples: + - '2018-01-25T18:56:31Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2343027/discussions/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - comments_count + - comments_url + - created_at + - last_edited_at + - html_url + - pinned + - private + - node_id + - number + - team_url + - title + - updated_at + - url + team-discussion-comment: + title: Team Discussion Comment + description: A reply to a discussion within a team. + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The main text of the comment. + type: string + examples: + - I agree with this suggestion. + body_html: + type: string + examples: + - "

Do you like apples?

" + body_version: + description: 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. + type: string + examples: + - 0307116bbf7ced493b8d8a346c650b71 + created_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + last_edited_at: + type: + - string + - 'null' + format: date-time + discussion_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1 + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: + type: string + examples: + - MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: + description: The unique sequence number of a team discussion comment. + type: integer + examples: + - 42 + updated_at: + type: string + format: date-time + examples: + - '2018-01-15T23:53:58Z' + url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - created_at + - last_edited_at + - discussion_url + - html_url + - node_id + - number + - updated_at + - url + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDg6UmVhY3Rpb24x + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + content: + description: The reaction to use + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + examples: + - heart + created_at: + type: string + format: date-time + examples: + - '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + 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 + type: string + examples: + - member + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + team-project: + title: Team Project + description: A team's access to a project. + type: object + properties: + owner_url: + type: string + url: + type: string + html_url: + type: string + columns_url: + type: string + id: + type: integer + node_id: + type: string + name: + type: string + body: + type: + - string + - 'null' + number: + type: integer + state: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + updated_at: + type: string + organization_permission: + description: The organization permission for this project. Only present + when owner is an organization. + type: string + private: + description: Whether the project is private or not. Only present when owner + is an organization. + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + - permissions + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - admin + owner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 80 + size: + type: integer + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - true + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + examples: + - true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + examples: + - false + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + examples: + - 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 + project-card: + title: Project Card + description: Project cards represent a scope of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/cards/1478 + id: + description: The project card's ID + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDExOlByb2plY3RDYXJkMTQ3OA== + note: + type: + - string + - 'null' + examples: + - Add payload for delete Project column + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:21:06Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:20:22Z' + archived: + description: Whether or not the card is archived + type: boolean + examples: + - false + column_name: + type: string + project_id: + type: string + column_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + content_url: + type: string + format: uri + examples: + - https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + required: + - id + - node_id + - note + - url + - column_url + - project_url + - creator + - created_at + - updated_at + project-column: + title: Project Column + description: Project columns contain cards of work. + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367 + project_url: + type: string + format: uri + examples: + - https://api.github.com/projects/120 + cards_url: + type: string + format: uri + examples: + - https://api.github.com/projects/columns/367/cards + id: + description: The unique identifier of the project column + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEzOlByb2plY3RDb2x1bW4zNjc= + name: + description: Name of the project column + type: string + examples: + - Remaining tasks + created_at: + type: string + format: date-time + examples: + - '2016-09-05T14:18:44Z' + updated_at: + type: string + format: date-time + examples: + - '2016-09-05T14:22:28Z' + required: + - id + - node_id + - url + - project_url + - cards_url + - name + - created_at + - updated_at + project-collaborator-permission: + title: Project Collaborator Permission + description: Project Collaborator Permission + type: object + properties: + permission: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - permission + - user + 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" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources + artifact: + title: Artifact + description: An artifact + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + name: + description: The name of the artifact. + type: string + examples: + - AdventureWorks.Framework + size_in_bytes: + description: The size in bytes of the artifact. + type: integer + examples: + - 12345 + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/artifacts/5 + archive_download_url: + type: string + examples: + - 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 + - 'null' + format: date-time + expires_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + workflow_run: + type: + - object + - 'null' + properties: + id: + type: integer + examples: + - 10 + repository_id: + type: integer + examples: + - 42 + head_repository_id: + type: integer + examples: + - 42 + head_branch: + type: string + examples: + - main + head_sha: + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + required: + - id + - node_id + - name + - size_in_bytes + - url + - archive_download_url + - expired + - created_at + - expires_at + - updated_at + actions-cache-usage-policy-for-repository: + title: Actions cache usage policy for repository + description: GitHub Actions cache usage policy for repository. + type: object + properties: + repo_cache_size_limit_in_gb: + description: The size limit for the sum of all caches, in gigabytes. + type: integer + examples: + - 14 + required: + - repo_cache_size_limit_in_gb + actions-cache-list: + title: Repository actions caches + description: Repository actions caches + type: object + properties: + total_count: + description: Total number of caches + type: integer + examples: + - 2 + actions_caches: + description: Array of caches + type: array + items: + type: object + properties: + id: + type: integer + examples: + - 2 + ref: + type: string + examples: + - refs/heads/main + key: + type: string + examples: + - Linux-node-958aff96db2d75d67787d1e634ae70b659de937b + version: + type: string + examples: + - 73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0 + last_accessed_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + created_at: + type: string + format: date-time + examples: + - '2019-01-24T22:45:36.000Z' + size_in_bytes: + type: integer + examples: + - 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. + type: integer + examples: + - 21 + run_id: + description: The id of the associated workflow run. + type: integer + examples: + - 5 + run_url: + type: string + examples: + - 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. + examples: + - 1 + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + head_sha: + description: The SHA of the commit that is being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/jobs/21 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + status: + description: The phase of the lifecycle that the job is currently in. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - success + created_at: + description: The time that the job created, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + started_at: + description: The time that the job started, in ISO 8601 format. + format: date-time + type: string + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + name: + description: The name of the job. + type: string + examples: + - test-coverage + 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. + type: string + enum: + - queued + - in_progress + - completed + examples: + - queued + conclusion: + description: The outcome of the job. + type: + - string + - 'null' + examples: + - success + name: + description: The name of the job. + type: string + examples: + - test-coverage + number: + type: integer + examples: + - 1 + started_at: + description: The time that the step started, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + completed_at: + description: The time that the job finished, in ISO 8601 format. + format: date-time + type: + - string + - 'null' + examples: + - '2019-08-08T08:00:00-07:00' + check_run_url: + type: string + examples: + - 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. + examples: + - self-hosted + - foo + - bar + runner_id: + type: + - integer + - 'null' + 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.) + examples: + - 1 + runner_name: + type: + - string + - 'null' + 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.) + examples: + - my runner + runner_group_id: + type: + - integer + - 'null' + 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.) + examples: + - 2 + runner_group_name: + type: + - string + - 'null' + 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.) + examples: + - my runner group + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + examples: + - Build + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + examples: + - 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. + type: string + examples: + - SECRET_TOKEN + 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. + type: string + examples: + - USERNAME + value: + description: The value of the variable. + type: string + examples: + - octocat + 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 + examples: + - '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 + examples: + - '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" + 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 + 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. `enterprise` level access allows sharing across the enterprise. + enum: + - none + - user + - organization + - enterprise + 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 + 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 + simple-commit: + title: Simple Commit + description: A commit. + type: object + properties: + id: + type: string + description: SHA for the commit + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + tree_id: + type: string + description: SHA for the commit's tree + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + timestamp: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + author: + type: + - object + - 'null' + description: Information about the Git author + properties: + name: + description: Name of the commit's author + type: string + examples: + - Monalisa Octocat + email: + description: Git email address of the commit's author + type: string + format: email + examples: + - monalisa.octocat@example.com + required: + - name + - email + committer: + type: + - object + - 'null' + description: Information about the Git committer + properties: + name: + description: Name of the commit's committer + type: string + examples: + - Monalisa Octocat + email: + description: Git email address of the commit's committer + type: string + format: email + examples: + - monalisa.octocat@example.com + required: + - name + - email + required: + - id + - tree_id + - message + - timestamp + - author + - committer + workflow-run: + title: Workflow Run + description: An invocation of a workflow + type: object + properties: + id: + type: integer + description: The ID of the workflow run. + examples: + - 5 + name: + type: + - string + - 'null' + description: The name of the workflow run. + examples: + - Build + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + check_suite_id: + type: integer + description: The ID of the associated check suite. + examples: + - 42 + check_suite_node_id: + type: string + description: The node ID of the associated check suite. + examples: + - MDEwOkNoZWNrU3VpdGU0Mg== + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that points to the version of the + workflow being run. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + path: + description: The full path of the workflow + type: string + examples: + - octocat/octo-repo/.github/workflows/ci.yml@main + run_number: + type: integer + description: The auto incrementing run number for the workflow run. + examples: + - 106 + run_attempt: + type: integer + description: Attempt number of the run, 1 for first attempt and higher if + the workflow was re-run. + examples: + - 1 + referenced_workflows: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/referenced-workflow" + event: + type: string + examples: + - push + status: + type: + - string + - 'null' + examples: + - completed + conclusion: + type: + - string + - 'null' + examples: + - neutral + workflow_id: + type: integer + description: The ID of the parent workflow. + examples: + - 5 + url: + type: string + description: The URL to the workflow run. + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5 + html_url: + type: string + examples: + - 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 + - 'null' + 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/cancel + rerun_url: + description: The URL to rerun the workflow run. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/rerun + previous_attempt_url: + description: The URL to the previous attempted run of this workflow, if + one exists. + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3 + workflow_url: + description: The URL to the workflow. + type: string + examples: + - https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml + head_commit: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-commit" + repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository: + "$ref": "#/components/schemas/minimal-repository" + head_repository_id: + type: integer + examples: + - 5 + display_title: + type: string + 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. + examples: + - Simple 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. + type: integer + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - 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. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO + 8601 format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + state: + description: Whether deployment to the environment(s) was approved or rejected + or pending (with comments) + enum: + - approved + - rejected + - pending + type: string + examples: + - approved + user: + "$ref": "#/components/schemas/simple-user" + comment: + type: string + description: The comment submitted with the deployment review + examples: + - 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 + examples: + - 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 + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging + wait_timer: + type: integer + description: The set duration of the wait timer + examples: + - 30 + wait_timer_started_at: + description: The time that the wait timer began. + format: date-time + type: + - string + - 'null' + examples: + - '2020-11-23T22:00:40Z' + current_user_can_approve: + description: Whether the currently authenticated user can approve the deployment + type: boolean + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + sha: + type: string + examples: + - a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d + ref: + description: The ref to deploy. This can be a branch, tag, or sha. + type: string + examples: + - topic-branch + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + payload: + oneOf: + - type: object + additionalProperties: true + - type: string + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - 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.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - sha + - ref + - task + - environment + - creator + - payload + - description + - statuses_url + - repository_url + - url + - created_at + - updated_at + workflow: + title: Workflow + description: A GitHub Actions workflow + type: object + properties: + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDg6V29ya2Zsb3cxMg== + name: + type: string + examples: + - CI + path: + type: string + examples: + - ruby.yaml + state: + type: string + enum: + - active + - deleted + - disabled_fork + - disabled_inactivity + - disabled_manually + examples: + - active + created_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + updated_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + url: + type: string + examples: + - https://api.github.com/repos/actions/setup-ruby/workflows/5 + html_url: + type: string + examples: + - https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml + badge_url: + type: string + examples: + - https://github.com/actions/setup-ruby/workflows/CI/badge.svg + deleted_at: + type: string + format: date-time + examples: + - '2019-12-06T14:20:20.000Z' + required: + - id + - node_id + - name + - path + - state + - url + - html_url + - badge_url + - created_at + - updated_at + activity: + title: Activity + description: Activity + type: object + properties: + id: + type: integer + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + before: + type: string + description: The SHA of the commit before the activity. + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + after: + type: string + description: The SHA of the commit after the activity. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + ref: + type: string + description: The full Git reference, formatted as `refs/heads/`. + examples: + - refs/heads/main + timestamp: + type: string + format: date-time + description: The time when the activity occurred. + examples: + - '2011-01-26T19:06:43Z' + activity_type: + type: string + enum: + - push + - force_push + - branch_deletion + - branch_creation + - pr_merge + - merge_queue_merge + description: The type of the activity that was performed. + examples: + - force_push + actor: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 3 + key_prefix: + description: The prefix of a key that is linkified. + type: string + examples: + - TICKET- + url_template: + description: A template for the target URL that is generated if a key was + found. + type: string + examples: + - https://example.com/TICKET?query= + is_alphanumeric: + description: Whether this autolink reference matches alphanumeric characters. + If false, this autolink reference only matches numeric characters. + type: boolean + examples: + - true + required: + - id + - key_prefix + - url_template + - is_alphanumeric + check-automated-security-fixes: + title: Check Automated Security Fixes + description: Check Automated Security Fixes + type: object + properties: + enabled: + type: boolean + description: Whether automated security fixes are enabled for the repository. + examples: + - true + paused: + type: boolean + description: Whether automated security fixes are paused for the repository. + examples: + - false + 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 + - 'null' + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins + enabled: + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"' + users_url: + type: string + examples: + - '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"' + teams_url: + type: string + examples: + - '"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 + examples: + - true + require_code_owner_reviews: + type: boolean + examples: + - true + required_approving_review_count: + type: integer + minimum: 0 + maximum: 6 + examples: + - 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 + default: false + examples: + - true + 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: + type: object + properties: + id: + type: integer + node_id: + type: string + url: + type: string + html_url: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + members_url: + type: string + repositories_url: + type: string + parent: + type: + - string + - 'null' + 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 + examples: + - '""' + html_url: + type: string + examples: + - '"https://github.com/testorg-ea8ec76d71c3af4b"' + followers_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"' + following_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"' + gists_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"' + starred_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"' + subscriptions_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"' + organizations_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"' + received_events_url: + type: string + examples: + - '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"' + type: + type: string + examples: + - '"Organization"' + site_admin: + type: boolean + examples: + - false + user_view_type: + type: string + examples: + - 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 + examples: + - '"branch/with/protection"' + protection_url: + type: string + examples: + - '"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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + examples: + - 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 + git-user: + title: Git User + description: Metaproperties for Git author/committer information. + type: object + properties: + name: + type: string + examples: + - '"Chris Wanstrath"' + email: + type: string + examples: + - '"chris@ozmm.org"' + date: + type: string + examples: + - '"2007-10-29T02:42:39.000-07:00"' + verification: + title: Verification + type: object + properties: + verified: + type: boolean + reason: + type: string + payload: + type: + - string + - 'null' + signature: + type: + - string + - 'null' + required: + - verified + - reason + - payload + - signature + diff-entry: + title: Diff Entry + description: Diff Entry + type: object + properties: + sha: + type: string + examples: + - bbcd538c8e72b8c175046e27cc8f907076331401 + filename: + type: string + examples: + - file1.txt + status: + type: string + enum: + - added + - removed + - modified + - renamed + - copied + - changed + - unchanged + examples: + - added + additions: + type: integer + examples: + - 103 + deletions: + type: integer + examples: + - 21 + changes: + type: integer + examples: + - 124 + blob_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + raw_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt + contents_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e + patch: + type: string + examples: + - "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" + previous_filename: + type: string + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + sha: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + node_id: + type: string + examples: + - MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments + commit: + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/git-user" + message: + type: string + examples: + - Fix all the bugs + comment_count: + type: integer + examples: + - 0 + tree: + type: object + properties: + sha: + type: string + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + url: + type: string + format: uri + examples: + - 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: + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object + committer: + oneOf: + - "$ref": "#/components/schemas/simple-user" + - "$ref": "#/components/schemas/empty-object" + type: + - 'null' + - object + parents: + type: array + items: + type: object + properties: + sha: + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/7638417db6d59f3c431d3e1f261cc637155684cd + html_url: + type: string + format: uri + examples: + - 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 + examples: + - '"mas*"' + required_approving_review_count: + type: integer + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks + strict: + type: boolean + examples: + - true + contexts: + type: array + items: + type: string + examples: + - continuous-integration/travis-ci + checks: + type: array + items: + type: object + properties: + context: + type: string + examples: + - continuous-integration/travis-ci + app_id: + type: + - integer + - 'null' + required: + - context + - app_id + contexts_url: + type: string + format: uri + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures + enabled: + type: boolean + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/example/deployments/1 + id: + description: Unique identifier of the deployment + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOkRlcGxveW1lbnQx + task: + description: Parameter to specify a task to execute + type: string + examples: + - deploy + original_environment: + type: string + examples: + - staging + environment: + description: Name for the target deployment environment. + type: string + examples: + - production + description: + type: + - string + - 'null' + examples: + - Deploy request from hubot + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/1/statuses + repository_url: + type: string + format: uri + examples: + - 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.' + type: boolean + examples: + - true + production_environment: + description: 'Specifies if the given environment is one that end-users directly + interact with. Default: false.' + type: boolean + examples: + - true + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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. + type: integer + format: int64 + examples: + - 21 + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + external_id: + type: + - string + - 'null' + examples: + - '42' + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + html_url: + type: + - string + - 'null' + examples: + - https://github.com/github/hello-world/runs/4 + details_url: + type: + - string + - 'null' + examples: + - https://example.com + 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. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + examples: + - queued + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + started_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + output: + type: object + properties: + title: + type: + - string + - 'null' + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + 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. + type: string + examples: + - test-coverage + check_suite: + type: + - object + - 'null' + properties: + id: + type: integer + required: + - id + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - README.md + start_line: + type: integer + examples: + - 2 + end_line: + type: integer + examples: + - 2 + start_column: + type: + - integer + - 'null' + examples: + - 5 + end_column: + type: + - integer + - 'null' + examples: + - 10 + annotation_level: + type: + - string + - 'null' + examples: + - warning + title: + type: + - string + - 'null' + examples: + - Spell Checker + message: + type: + - string + - 'null' + examples: + - Check your spelling for 'banaas'. + raw_details: + type: + - string + - 'null' + examples: + - Do you mean 'bananas' or 'banana'? + blob_href: + type: string + required: + - path + - blob_href + - start_line + - end_line + - start_column + - end_column + - annotation_level + - title + - message + - raw_details + check-suite: + title: CheckSuite + description: A suite of checks performed on the code of a given code change + type: object + properties: + id: + type: integer + format: int64 + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + status: + type: + - string + - 'null' + 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. + enum: + - queued + - in_progress + - completed + - waiting + - requested + - pending + - + examples: + - completed + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - startup_failure + - stale + - + examples: + - neutral + url: + type: + - string + - 'null' + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + after: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + pull_requests: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/pull-request-minimal" + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + repository: + "$ref": "#/components/schemas/minimal-repository" + created_at: + type: + - string + - 'null' + format: date-time + updated_at: + type: + - string + - 'null' + format: date-time + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + 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: + type: + - string + - 'null' + 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: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + 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: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + help: + type: + - string + - 'null' + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + type: + - string + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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" + 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-analysis-sarif-id: + type: string + description: An identifier for the upload. + examples: + - 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 + examples: + - 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 + examples: + - 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 + - 'null' + description: Next deletable analysis in chain, without last analysis deletion + confirmation + format: uri + readOnly: true + confirm_delete_url: + type: + - string + - 'null' + description: Next deletable analysis in chain, with last analysis deletion + confirmation + format: uri + readOnly: true + required: + - next_analysis_url + - confirm_delete_url + 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: + - c-cpp + - csharp + - go + - java-kotlin + - javascript-typescript + - javascript + - python + - ruby + - typescript + - swift + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + updated_at: + description: Timestamp of latest configuration update. + type: + - string + - 'null' + format: date-time + examples: + - '2023-12-06T14:20:20.000Z' + schedule: + description: The frequency of the periodic analysis. + type: + - string + - 'null' + enum: + - weekly + - + 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 + query_suite: + description: CodeQL query suite to be used. + type: string + enum: + - default + - extended + languages: + description: CodeQL languages to be analyzed. + type: array + items: + type: string + enum: + - 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. + 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-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)/.*$" + examples: + - 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/enterprise-server@3.15/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 + - 'null' + description: The REST API URL for getting the analyses associated with the + upload. + format: uri + readOnly: true + errors: + type: + - array + - 'null' + items: + type: string + description: Any errors that ocurred during processing of the delivery. + readOnly: 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 + examples: + - 7 + column: + description: The column number where this errors occurs. + type: integer + examples: + - 3 + source: + description: The contents of the line where the error occurs. + type: string + examples: + - "* user" + kind: + description: The type of error. + type: string + examples: + - Invalid owner + suggestion: + description: Suggested action to fix the error. This will usually + be `null`, but is provided for some common errors. + type: + - string + - 'null' + examples: + - 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 + examples: + - |- + Invalid owner on line 7: + + * user + ^ + path: + description: The path of the file where the error occured. + type: string + examples: + - ".github/CODEOWNERS" + required: + - line + - column + - kind + - message + - path + required: + - errors + collaborator: + title: Collaborator + description: Collaborator + type: object + properties: + login: + type: string + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + email: + type: + - string + - 'null' + name: + type: + - string + - 'null' + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - 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 + examples: + - admin + user_view_type: + type: string + examples: + - 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 + repository-collaborator-permission: + title: Repository Collaborator Permission + description: Repository Collaborator Permission + type: object + properties: + permission: + type: string + role_name: + type: string + examples: + - admin + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + position: + type: + - integer + - 'null' + line: + type: + - integer + - 'null' + commit_id: + type: string + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + 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 + - 'null' + 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 + pull-request-simple: + title: Pull Request Simple + description: Pull Request Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + type: integer + examples: + - 1347 + state: + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + type: string + examples: + - new-feature + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/team" + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + "$ref": "#/components/schemas/repository" + sha: + type: string + user: + anyOf: + - type: 'null' + - "$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: + anyOf: + - type: 'null' + - "$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. + type: boolean + examples: + - false + 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 + simple-commit-status: + title: Simple Commit Status + type: object + properties: + description: + type: + - string + - 'null' + id: + type: integer + node_id: + type: string + state: + type: string + context: + type: string + target_url: + type: + - string + - 'null' + format: uri + required: + type: + - boolean + - 'null' + avatar_url: + type: + - string + - 'null' + 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 + - 'null' + id: + type: integer + node_id: + type: string + state: + type: string + description: + type: + - string + - 'null' + target_url: + type: + - string + - 'null' + context: + type: string + created_at: + type: string + updated_at: + type: string + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - url + - avatar_url + - id + - node_id + - state + - description + - target_url + - context + - created_at + - updated_at + - creator + commit-comparison: + title: Commit Comparison + description: Commit Comparison + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/compare/master...topic + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/master...topic + permalink_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/compare/master...topic.diff + patch_url: + type: string + format: uri + examples: + - 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 + examples: + - ahead + ahead_by: + type: integer + examples: + - 4 + behind_by: + type: integer + examples: + - 5 + total_commits: + type: integer + examples: + - 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + required: + - _links + - git_url + - html_url + - download_url + - name + - path + - sha + - size + - type + - url + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + target: + type: string + examples: + - '"actual/actual.md"' + submodule_git_url: + type: string + examples: + - '"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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + 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 + - 'null' + 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 + 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 + - 'null' + payload: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The execution scope of the vulnerable dependency. + readOnly: true + enum: + - development + - runtime + - + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + dismissed_reason: + type: + - string + - 'null' + description: The reason that the alert was dismissed. + enum: + - fix_started + - inaccurate + - no_bandwidth + - not_used + - tolerable_risk + - + dismissed_comment: + type: + - string + - 'null' + description: An optional comment associated with the alert's dismissal. + maxLength: 280 + fixed_at: + "$ref": "#/components/schemas/alert-fixed-at" + auto_dismissed_at: + "$ref": "#/components/schemas/alert-auto-dismissed-at" + 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. + type: string + examples: + - MY_ARTIFACTORY_PASSWORD + 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 + examples: + - path/to/package-lock.json + ecosystem: + type: string + examples: + - npm + name: + type: string + examples: + - "@actions/core" + version: + type: string + examples: + - 1.0.0 + package_url: + type: + - string + - 'null' + examples: + - pkg:/npm/%40actions/core@1.1.0 + license: + type: + - string + - 'null' + examples: + - MIT + source_repository_url: + type: + - string + - 'null' + examples: + - https://github.com/github/actions + vulnerabilities: + type: array + items: + type: object + properties: + severity: + type: string + examples: + - critical + advisory_ghsa_id: + type: string + examples: + - GHSA-rf4j-j272-fj86 + advisory_summary: + type: string + examples: + - A summary of the advisory. + advisory_url: + type: string + examples: + - 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 + description: The SPDX identifier for the SPDX document. + examples: + - SPDXRef-DOCUMENT + spdxVersion: + type: string + description: The version of the SPDX specification that this document + conforms to. + examples: + - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - '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/' + creationInfo: + type: object + properties: + created: + type: string + description: The date and time the SPDX document was created. + examples: + - '2021-11-03T00:00:00Z' + creators: + type: array + items: + type: string + examples: + - GitHub + description: The tools that were used to generate the SPDX document. + required: + - created + - creators + name: + type: string + description: The name of the SPDX document. + examples: + - github/github + dataLicense: + type: string + description: The license under which the SPDX document is licensed. + examples: + - CC0-1.0 + documentNamespace: + type: string + description: The namespace for the SPDX document. + examples: + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 + packages: + type: array + items: + type: object + properties: + SPDXID: + type: string + description: A unique SPDX identifier for the package. + examples: + - SPDXRef-Package + name: + type: string + description: The name of the package. + examples: + - github/github + versionInfo: + type: string + description: |- + The version of the package. If the package does not have an exact version specified, + a version range is given. + examples: + - 1.0.0 + downloadLocation: + type: string + description: |- + The location where the package can be downloaded, + or NOASSERTION if this has not been determined. + examples: + - NOASSERTION + filesAnalyzed: + type: boolean + description: |- + Whether the package's file content has been subjected to + analysis during the creation of the SPDX document. + examples: + - false + licenseConcluded: + type: string + description: The license of the package as determined while creating + the SPDX document. + examples: + - MIT + licenseDeclared: + type: string + 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. + examples: + - NOASSERTION + supplier: + type: string + description: The distribution source of this package, or NOASSERTION + if this was not determined. + examples: + - NOASSERTION + copyrightText: + type: string + description: The copyright holders of the package, and any dates + present with those notices, if available. + examples: + - Copyright (c) 1985 GitHub.com + externalRefs: + type: array + items: + type: object + properties: + referenceCategory: + type: string + description: The category of reference to an external resource + this reference refers to. + examples: + - PACKAGE-MANAGER + referenceLocator: + type: string + description: A locator for the particular external resource + this reference refers to. + examples: + - pkg:gem/rails@6.0.1 + referenceType: + type: string + description: The category of reference to an external resource + this reference refers to. + examples: + - purl + required: + - referenceCategory + - referenceLocator + - referenceType + required: + - SPDXID + - name + - versionInfo + - downloadLocation + - filesAnalyzed + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + 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: + anyOf: + - type: string + - type: number + - type: boolean + type: + - 'null' + - string + - number + - 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. + pattern: "^pkg" + examples: + - pkg:/npm/%40actions/http-client@1.0.11 + 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. + enum: + - direct + - indirect + examples: + - direct + 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. + enum: + - runtime + - development + examples: + - runtime + dependencies: + type: array + description: Array of package-url (PURLs) of direct child dependencies. + items: + type: string + examples: + - "@actions/http-client" + additionalProperties: false + manifest: + type: object + properties: + name: + type: string + description: The name of the manifest. + examples: + - 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. + examples: + - "/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. + examples: + - 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. + examples: + - yourworkflowname_yourjobname + html_url: + type: string + description: The url for the job. + examples: + - 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 + minLength: 40 + maxLength: 40 + examples: + - ddc951f4b1293222421f2c8df679786153acf689 + ref: + description: The repository branch that triggered this snapshot. + type: string + pattern: "^refs/" + examples: + - refs/heads/main + detector: + type: object + description: A description of the detector used. + properties: + name: + type: string + description: The name of the detector used. + examples: + - docker buildtime detector + version: + type: string + description: The version of the detector used. + examples: + - 1.0.0 + url: + type: string + description: The url of the detector used. + examples: + - 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. + examples: + - '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 + examples: + - https://api.github.com/repos/octocat/example/deployments/42/statuses/1 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDE2OkRlcGxveW1lbnRTdGF0dXMx + state: + description: The state of the status. + enum: + - error + - failure + - inactive + - pending + - success + - queued + - in_progress + type: string + examples: + - success + creator: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + description: + description: A short description of the status. + default: '' + type: string + maxLength: 140 + examples: + - Deployment finished successfully. + environment: + description: The environment of the deployment that the status is for. + default: '' + type: string + examples: + - production + target_url: + description: 'Closing down notice: the URL to associate with this status.' + default: '' + type: string + format: uri + examples: + - https://example.com/deployment/42/output + created_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + updated_at: + type: string + format: date-time + examples: + - '2012-07-20T01:19:13Z' + deployment_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/deployments/42 + repository_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example + environment_url: + description: The URL for accessing your environment. + default: '' + type: string + format: uri + examples: + - https://staging.example.com/ + log_url: + description: The URL to associate with this status. + default: '' + type: string + format: uri + examples: + - https://example.com/deployment/42/output + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + required: + - id + - node_id + - state + - creator + - description + - deployment_url + - target_url + - repository_url + - url + - created_at + - updated_at + wait-timer: + type: integer + 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). + examples: + - 30 + deployment-branch-policy-settings: + type: + - object + - 'null' + 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`. + 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. + type: integer + format: int64 + examples: + - 56780428 + node_id: + type: string + examples: + - MDExOkVudmlyb25tZW50NTY3ODA0Mjg= + name: + description: The name of the environment. + type: string + examples: + - staging + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/environments/staging + html_url: + type: string + examples: + - 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. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + updated_at: + description: The time that the environment was last updated, in ISO 8601 + format. + format: date-time + type: string + examples: + - '2020-11-23T22:00:40Z' + protection_rules: + type: array + description: Built-in deployment protection rules for the environment. + items: + anyOf: + - type: object + properties: + id: + type: integer + examples: + - 3515 + node_id: + type: string + examples: + - MDQ6R2F0ZTM1MTU= + type: + type: string + examples: + - wait_timer + wait_timer: + "$ref": "#/components/schemas/wait-timer" + required: + - id + - node_id + - type + - type: object + properties: + id: + type: integer + examples: + - 3755 + node_id: + type: string + examples: + - MDQ6R2F0ZTM3NTU= + prevent_self_review: + type: boolean + description: Whether deployments to this environment can be approved + by the user who created the deployment. + examples: + - false + type: + type: string + examples: + - 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 + examples: + - 3515 + node_id: + type: string + examples: + - MDQ6R2F0ZTM1MTU= + type: + type: string + examples: + - 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 + description: Whether or not a user who created the job is prevented from approving + their own job. + examples: + - false + 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 + examples: + - 361471 + node_id: + type: string + examples: + - MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= + name: + description: The name pattern that branches or tags must match in order + to deploy to the environment. + type: string + examples: + - release/* + type: + description: Whether this rule targets a branch or tag. + type: string + enum: + - branch + - tag + examples: + - branch + 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 + examples: + - release/* + type: + description: Whether this rule targets a branch or tag + type: string + enum: + - branch + - tag + examples: + - branch + 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 + examples: + - 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 + description: The unique identifier of the deployment protection rule integration. + examples: + - 3515 + slug: + type: string + description: The slugified name of the deployment protection rule integration. + examples: + - my-custom-app + integration_url: + type: string + description: The URL for the endpoint to get details about the app. + examples: + - https://api.github.com/apps/custom-app-slug + node_id: + type: string + description: The node ID for the deployment protection rule integration. + examples: + - MDQ6R2F0ZTM1MTU= + required: + - id + - slug + - integration_url + - node_id + deployment-protection-rule: + title: Deployment protection rule + description: Deployment protection rule + type: object + properties: + id: + type: integer + description: The unique identifier for the deployment protection rule. + examples: + - 3515 + node_id: + type: string + description: The node ID for the deployment protection rule. + examples: + - MDQ6R2F0ZTM1MTU= + enabled: + type: boolean + description: Whether the deployment protection rule is enabled for the environment. + examples: + - true + 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 + - 'null' + 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 + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + tree: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + - 'null' + payload: + type: + - string + - 'null' + required: + - verified + - reason + - signature + - payload + 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 + type: string + minLength: 40 + maxLength: 40 + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + examples: + - MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== + tag: + description: Name of the tag + type: string + examples: + - v0.0.1 + sha: + type: string + examples: + - 940bd336248efae0f9ee5bc7b2d5c985887b16ac + url: + description: URL for the tag + type: string + format: uri + examples: + - https://api.github.com/repositories/42/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac + message: + description: Message describing the purpose of the tag + type: string + examples: + - Initial public release + 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 + properties: + path: + type: string + examples: + - test/file.rb + mode: + type: string + examples: + - '040000' + type: + type: string + examples: + - tree + sha: + type: string + examples: + - 23f6827669e43831def8a7ad935069c8bd418261 + size: + type: integer + examples: + - 12 + url: + type: string + examples: + - https://api.github.com/repos/owner-482f3203ecf01f67e9deb18e/BBB_Private_Repo/git/blobs/23f6827669e43831def8a7ad935069c8bd418261 + examples: + - path: file.rb + mode: '100644' + type: blob + size: 30 + sha: 44b4fc6d56897b048c772eb4087f854f46256132 + url: https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132 + properties: + path: + type: string + mode: + type: string + type: + type: string + size: + type: integer + sha: + type: string + url: + type: string + required: + - path + - mode + - type + - sha + - url + - size + required: + - sha + - url + - tree + - truncated + hook-response: + title: Hook Response + type: object + properties: + code: + type: + - integer + - 'null' + status: + type: + - string + - 'null' + message: + type: + - string + - 'null' + required: + - code + - status + - message + hook: + title: Webhook + description: Webhooks for repositories. + type: object + properties: + type: + type: string + id: + description: Unique identifier of the webhook. + type: integer + examples: + - 42 + name: + description: The name of a valid service, use 'web' for a webhook. + type: string + examples: + - web + active: + description: Determines whether the hook is actually triggered on pushes. + type: boolean + examples: + - true + events: + description: 'Determines what events the hook is triggered for. Default: + [''push''].' + type: array + items: + type: string + examples: + - push + - pull_request + config: + "$ref": "#/components/schemas/webhook-config" + updated_at: + type: string + format: date-time + examples: + - '2011-09-06T20:39:23Z' + created_at: + type: string + format: date-time + examples: + - '2011-09-06T17:26:27Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1 + test_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1/test + ping_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/hooks/1/pings + deliveries_url: + type: string + format: uri + examples: + - 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 + 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. + type: integer + format: int64 + examples: + - 42 + repository: + "$ref": "#/components/schemas/minimal-repository" + invitee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + inviter: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + permissions: + description: The permission associated with the invitation. + type: string + enum: + - read + - write + - admin + - triage + - maintain + examples: + - read + created_at: + type: string + format: date-time + examples: + - '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 + type: string + examples: + - https://api.github.com/user/repository-invitations/1 + html_url: + type: string + examples: + - https://github.com/octocat/Hello-World/invitations + node_id: + type: string + required: + - id + - node_id + - permissions + - inviter + - invitee + - repository + - url + - html_url + - created_at + issue-event-label: + title: Issue Event Label + description: Issue Event Label + type: object + properties: + name: + type: + - string + - 'null' + color: + type: + - string + - 'null' + 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 + - 'null' + dismissal_commit_id: + type: + - string + - 'null' + 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 + examples: + - 1 + node_id: + type: string + examples: + - MDEwOklzc3VlRXZlbnQx + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/events/1 + actor: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + event: + type: string + examples: + - closed + commit_id: + type: + - string + - 'null' + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + commit_url: + type: + - string + - 'null' + examples: + - https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/issue" + label: + "$ref": "#/components/schemas/issue-event-label" + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assigner: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + review_requester: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + requested_reviewer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + dismissed_review: + type: object + properties: + state: + type: string + review_id: + type: integer + dismissal_message: + type: + - string + - 'null' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + lock_reason: + type: + - string + - 'null' + examples: + - '"off-topic"' + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$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 + 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 + - 'null' + commit_url: + type: + - string + - 'null' + 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" + 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 + examples: + - 208045946 + node_id: + type: string + examples: + - MDU6TGFiZWwyMDgwNDU5NDY= + url: + description: URL for the label + type: string + format: uri + examples: + - https://api.github.com/repositories/42/labels/bug + name: + description: The name of the label. + type: string + examples: + - bug + description: + description: Optional description of the label, such as its purpose. + type: + - string + - 'null' + examples: + - Something isn't working + color: + description: '6-character hex code, without the leading #, identifying the + color' + type: string + examples: + - FFFFFF + default: + description: Whether this label comes by default in a new repository. + type: boolean + examples: + - true + required: + - id + - node_id + - url + - name + - description + - color + - default + 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 + type: integer + examples: + - 42 + node_id: + type: string + url: + description: URL for the issue comment + type: string + format: uri + examples: + - https://api.github.com/repositories/42/issues/comments/1 + body: + description: Contents of the issue comment + type: string + examples: + - What version of Safari were you using when you observed this bug? + 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 + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + issue_url: + type: string + format: uri + author_association: + "$ref": "#/components/schemas/author-association" + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + "$ref": "#/components/schemas/reaction-rollup" + 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 + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + committer: + description: Identifying information for the git-user + type: object + properties: + date: + description: Timestamp of the commit + format: date-time + type: string + examples: + - '2014-08-09T08:02:04+12:00' + email: + type: string + description: Git email address of the user + examples: + - monalisa.octocat@example.com + name: + description: Name of the git user + type: string + examples: + - Monalisa Octocat + required: + - email + - name + - date + message: + description: Message describing the purpose of the commit + type: string + examples: + - 'Fix #42' + tree: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + url: + type: string + format: uri + required: + - sha + - url + parents: + type: array + items: + type: object + properties: + sha: + description: SHA for the commit + type: string + examples: + - 7638417db6d59f3c431d3e1f261cc637155684cd + 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 + - 'null' + payload: + type: + - string + - 'null' + required: + - verified + - reason + - signature + - payload + 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 + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: + - string + - 'null' + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - 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. + type: string + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + 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 + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + format: int64 + examples: + - 42 + id: + description: The ID of the pull request review comment. + type: integer + format: int64 + examples: + - 1 + node_id: + description: The node ID of the pull request review comment. + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + description: The relative path of the file to which the comment applies. + type: string + examples: + - config/database.yaml + position: + description: The line index in the diff to which the comment applies. This + field is closing down; use `line` instead. + type: integer + examples: + - 1 + 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. + type: integer + examples: + - 4 + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + description: The SHA of the original commit to which the comment applies. + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + description: The comment ID to reply to. + type: integer + examples: + - 8 + user: + "$ref": "#/components/schemas/simple-user" + body: + description: The text of the comment. + type: string + examples: + - We should probably include a check for null values here. + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + examples: + - 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 + examples: + - 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + required: + - href + html: + type: object + properties: + href: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + required: + - href + pull_request: + type: object + properties: + href: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1 + required: + - href + required: + - self + - html + - pull_request + start_line: + type: + - integer + - 'null' + description: The first line of the range for a multi-line comment. + examples: + - 2 + original_start_line: + type: + - integer + - 'null' + description: The first line of the range for a multi-line comment. + examples: + - 2 + start_side: + type: + - string + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + 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 + examples: + - 2 + 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 + examples: + - 2 + 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 + examples: + - '"

comment body

"' + body_text: + type: string + examples: + - '"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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + commit_url: + type: + - string + - 'null' + created_at: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + state_reason: + type: + - string + - 'null' + 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 + - 'null' + last_used: + type: + - string + - 'null' + 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 + - 'null' + format: uri + git_url: + type: + - string + - 'null' + format: uri + download_url: + type: + - string + - 'null' + format: uri + type: + type: string + content: + type: string + encoding: + type: string + _links: + type: object + properties: + git: + type: + - string + - 'null' + format: uri + html: + type: + - string + - 'null' + format: uri + self: + type: string + format: uri + required: + - git + - html + - self + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + 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 + examples: + - approved + description: + type: string + examples: + - Certificate is approved + domains: + type: array + items: + type: string + description: Array of the domain set and its alternate name (if it is configured) + examples: + - 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 + examples: + - https://api.github.com/repos/github/hello-world/pages + status: + type: + - string + - 'null' + description: The status of the most recent build of the Page. + enum: + - built + - building + - errored + - + examples: + - built + cname: + description: The Pages site's custom domain + type: + - string + - 'null' + examples: + - example.com + protected_domain_state: + type: + - string + - 'null' + description: The state if the domain is verified + enum: + - pending + - verified + - unverified + - + examples: + - pending + pending_domain_unverified_at: + type: + - string + - 'null' + description: The timestamp when a pending domain becomes unverified. + format: date-time + custom_404: + type: boolean + description: Whether the Page has a custom 404 page. + default: false + examples: + - false + html_url: + type: string + description: The web address the Page can be accessed from. + format: uri + examples: + - https://example.com + build_type: + type: + - string + - 'null' + description: The process in which the Page will be built. + enum: + - legacy + - workflow + - + examples: + - legacy + 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. + examples: + - true + https_certificate: + "$ref": "#/components/schemas/pages-https-certificate" + https_enforced: + type: boolean + description: Whether https is enabled on the domain + examples: + - 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 + - 'null' + required: + - message + pusher: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://api.github.com/repos/github/hello-world/pages/builds/latest + status: + type: string + examples: + - 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 + examples: + - 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 + examples: + - hello-world.github.io + preview_url: + type: string + description: The URI to the deployed GitHub Pages preview. + format: uri + examples: + - 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 + repository-pre-receive-hook: + type: object + properties: + id: + type: integer + name: + type: string + enforcement: + type: string + configuration_url: + type: string + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347 + id: + type: integer + format: int64 + examples: + - 1 + node_id: + type: string + examples: + - MDExOlB1bGxSZXF1ZXN0MQ== + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347 + diff_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.diff + patch_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1347.patch + issue_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + commits_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits + review_comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments + review_comment_url: + type: string + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} + comments_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347/comments + statuses_url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e + number: + description: Number uniquely identifying the pull request within its repository. + type: integer + examples: + - 42 + state: + description: State of this Pull Request. Either `open` or `closed`. + enum: + - open + - closed + type: string + examples: + - open + locked: + type: boolean + examples: + - true + title: + description: The title of the pull request. + type: string + examples: + - Amazing new feature + user: + "$ref": "#/components/schemas/simple-user" + body: + type: + - string + - 'null' + examples: + - Please pull these awesome changes + 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 + - 'null' + color: + type: string + default: + type: boolean + required: + - id + - node_id + - url + - name + - description + - color + - default + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + active_lock_reason: + type: + - string + - 'null' + examples: + - too heated + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merged_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + merge_commit_sha: + type: + - string + - 'null' + examples: + - e5bd3914e2e596debea16f433f57875b5b90bcd6 + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_reviewers: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + requested_teams: + type: + - array + - 'null' + 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. + type: boolean + examples: + - false + merged: + type: boolean + mergeable: + type: + - boolean + - 'null' + examples: + - true + rebaseable: + type: + - boolean + - 'null' + examples: + - true + mergeable_state: + type: string + examples: + - clean + merged_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + comments: + type: integer + examples: + - 10 + review_comments: + type: integer + examples: + - 0 + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + examples: + - true + commits: + type: integer + examples: + - 3 + additions: + type: integer + examples: + - 100 + deletions: + type: integer + examples: + - 3 + changed_files: + type: integer + examples: + - 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 + 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 + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + description: The text of the review. + type: string + examples: + - This looks great. + state: + type: string + examples: + - CHANGES_REQUESTED + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 + pull_request_url: + type: string + format: uri + examples: + - 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`. + type: + - string + - 'null' + examples: + - 54bb654c9e6025347f57900a4a5c2313a96b8035 + 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 + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 + pull_request_review_id: + type: + - integer + - 'null' + format: int64 + examples: + - 42 + id: + type: integer + format: int64 + examples: + - 10 + node_id: + type: string + examples: + - MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw + diff_hunk: + type: string + examples: + - "@@ -16,33 +16,40 @@ public class Connection : IConnection..." + path: + type: string + examples: + - file1.txt + position: + type: + - integer + - 'null' + examples: + - 1 + original_position: + type: integer + examples: + - 4 + commit_id: + type: string + examples: + - 6dcb09b5b57875f334f61aebed695e2e4193db5e + original_commit_id: + type: string + examples: + - 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 + in_reply_to_id: + type: integer + examples: + - 8 + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + body: + type: string + examples: + - Great stuff + created_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + updated_at: + type: string + format: date-time + examples: + - '2011-04-14T16:00:49Z' + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 + pull_request_url: + type: string + format: uri + examples: + - 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 + - 'null' + description: The side of the first line of the range for a multi-line comment. + enum: + - LEFT + - RIGHT + - + default: RIGHT + 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 + examples: + - 2 + 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 + type: integer + examples: + - 2 + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + original_start_line: + description: The original first line of the range for a multi-line comment. + type: + - integer + - 'null' + examples: + - 2 + 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-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 + examples: + - Team Environment + label: + type: + - string + - 'null' + state: + description: State of the release asset. + type: string + enum: + - uploaded + - open + content_type: + type: string + size: + type: integer + download_count: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + uploader: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - name + - content_type + - size + - 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 + - 'null' + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + id: + type: integer + node_id: + type: string + tag_name: + description: The name of the tag. + type: string + examples: + - v1.0.0 + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + examples: + - master + name: + type: + - string + - 'null' + body: + type: + - string + - 'null' + draft: + description: true to create a draft (unpublished) release, false to create + a published one. + type: boolean + examples: + - false + prerelease: + description: Whether to identify the release as a prerelease or a full release. + type: boolean + examples: + - false + created_at: + type: string + format: date-time + published_at: + type: + - string + - 'null' + 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 + 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-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 + examples: + - 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-workflows" + - "$ref": "#/components/schemas/repository-rule-ruleset-info" + - allOf: + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + 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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + secret: + type: string + description: The secret that was detected. + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + secret-scanning-alert-resolution-comment: + description: An optional comment when closing an alert. Cannot be updated or + deleted. Must be `null` when changing `state` to `open`. + type: + - string + - 'null' + 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 + examples: + - "/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 + examples: + - 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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_url: + type: string + description: The API URL to get the associated commit resource + 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 + examples: + - "/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 + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/1347 + 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/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. + examples: + - 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. + examples: + - 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. + examples: + - 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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/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. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url + 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. + examples: + - 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 + - 'null' + format: date-time + description: 'The time that the bypass will expire in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + token_type: + type: string + description: The token type this bypass is for. + stargazer: + title: Stargazer + description: Stargazer + type: object + properties: + starred_at: + type: string + format: date-time + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + items: + type: integer + examples: + - 0 + - 3 + - 26 + - 20 + - 39 + - 1 + - 0 + total: + type: integer + examples: + - 89 + week: + type: integer + examples: + - 1336280400 + required: + - days + - total + - week + contributor-activity: + title: Contributor Activity + description: Contributor Activity + type: object + properties: + author: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + total: + type: integer + examples: + - 135 + weeks: + type: array + items: + type: object + properties: + w: + type: integer + a: + type: integer + d: + type: integer + c: + type: integer + examples: + - w: '1367712000' + a: 6898 + d: 77 + c: 10 + 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 + examples: + - true + ignored: + description: Determines if all notifications should be blocked from this + repository. + type: boolean + reason: + type: + - string + - 'null' + created_at: + type: string + format: date-time + examples: + - '2012-10-06T21:34:12Z' + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/example/subscription + repository_url: + type: string + format: uri + examples: + - 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 + examples: + - v0.1 + commit: + type: object + properties: + sha: + type: string + url: + type: string + format: uri + required: + - sha + - url + zipball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/zipball/v0.1 + tarball_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World/tarball/v0.1 + node_id: + type: string + required: + - name + - node_id + - commit + - zipball_url + - tarball_url + tag-protection: + title: Tag protection + description: Tag protection + type: object + properties: + id: + type: integer + examples: + - 2 + created_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + examples: + - '2011-01-26T19:01:12Z' + enabled: + type: boolean + examples: + - true + pattern: + type: string + examples: + - v1.* + required: + - pattern + 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 + group-response: + type: object + required: + - schemas + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:Group + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: + type: + - string + - 'null' + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: + type: + - string + - 'null' + description: A human-readable name for a security group. + examples: + - Engineering + members: + type: array + description: The group members. + items: + type: object + required: + - value + - "$ref" + properties: + value: + type: string + description: The local unique identifier for the member + examples: + - 23a35c27-23d3-4c03-b4c5-6443c09e7173 + "$ref": + type: string + display: + type: string + description: The display name associated with the member + examples: + - Monalisa Octocat + meta: + type: object + description: The metadata associated with the creation/updates to the user. + required: + - resourceType + properties: + resourceType: + type: string + description: A type of a resource + enum: + - User + - Group + examples: + - User + created: + type: string + description: A date and time when the user was created. + examples: + - '2022-03-27T19:59:26.000Z' + lastModified: + type: string + description: A data and time when the user was last modified. + examples: + - '2022-03-27T19:59:26.000Z' + location: + type: string + description: A URL location of an object + scim-enterprise-group-response: + allOf: + - "$ref": "#/components/schemas/group-response" + - type: object + properties: + id: + type: string + description: The internally generated id for the group object. + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + members: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + description: The security group members. + examples: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + "$ref": "#/components/schemas/meta" + scim-enterprise-group-list: + type: object + required: + - schemas + - totalResults + - Resources + - startIndex + - itemsPerPage + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the list + SCIM schemas. + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: + type: integer + description: Number of results found + examples: + - 1 + Resources: + type: array + description: Information about each provisioned group. + items: + "$ref": "#/components/schemas/scim-enterprise-group-response" + startIndex: + type: integer + description: A starting index for the returned page + examples: + - 1 + itemsPerPage: + type: integer + description: Number of objects per page + examples: + - 20 + group: + type: object + required: + - schemas + - externalId + - displayName + - members + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:Group + examples: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: + type: string + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: + type: string + description: A human-readable name for a security group. + examples: + - Engineering + members: + type: array + description: The group members. + items: + type: object + required: + - value + - displayName + properties: + value: + type: string + description: The local unique identifier for the member + examples: + - 23a35c27-23d3-4c03-b4c5-6443c09e7173 + displayName: + type: string + description: The display name associated with the member + examples: + - Monalisa Octocat + patch-schema: + type: object + required: + - Operations + - schemas + properties: + Operations: + type: array + description: patch operations list + items: + type: object + required: + - op + properties: + op: + type: string + enum: + - add + - replace + - remove + path: + type: string + value: + type: string + description: Corresponding 'value' of that field specified by 'path' + schemas: + type: array + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:PatchOp + user-name-response: + type: object + properties: + formatted: + type: string + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + examples: + - Ms. Mona Lisa Octocat + familyName: + type: string + description: The family name of the user. + examples: + - Octocat + givenName: + type: string + description: The given name of the user. + examples: + - Mona + middleName: + type: string + description: The middle name(s) of the user. + examples: + - Lisa + user-emails-response: + type: array + description: The emails for the user. + items: + type: object + required: + - value + properties: + value: + type: string + description: The email address. + examples: + - mlisa@example.com + type: + type: string + description: The type of email address. + examples: + - work + primary: + type: boolean + description: Whether this email address is the primary address. + examples: + - true + user-role: + type: array + description: The roles assigned to the user. + items: + type: object + required: + - value + properties: + display: + type: string + type: + type: string + value: + type: string + description: The role value representing a user role in GitHub. + enum: + - user + - 27d9891d-2c17-4f45-a262-781a0e55c80a + - guest_collaborator + - 1ebc4a02-e56c-43a6-92a5-02ee09b90824 + - enterprise_owner + - 981df190-8801-4618-a08a-d91f6206c954 + - ba4987ab-a1c3-412a-b58c-360fc407cb10 + - billing_manager + - 0e338b8c-cc7f-498a-928d-ea3470d7e7e3 + - e6be2762-e4ad-4108-b72d-1bbe884a0f91 + examples: + - user + primary: + type: boolean + description: Is the role a primary role for the user. + examples: + - false + user-response: + type: object + required: + - schemas + - active + - emails + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:User + examples: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: + type: + - string + - 'null' + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - E012345 + active: + type: boolean + description: Whether the user active in the IdP. + examples: + - true + userName: + type: string + description: The username for the user. + examples: + - E012345 + name: + "$ref": "#/components/schemas/user-name-response" + displayName: + type: + - string + - 'null' + description: A human-readable name for the user. + examples: + - Mona Lisa + emails: + "$ref": "#/components/schemas/user-emails-response" + roles: + "$ref": "#/components/schemas/user-role" + scim-enterprise-user-response: + allOf: + - "$ref": "#/components/schemas/user-response" + - type: object + required: + - id + - meta + properties: + id: + type: string + description: The internally generated id for the user object. + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + groups: + type: array + items: + type: object + properties: + value: + type: string + "$ref": + type: string + display: + type: string + description: Provisioned SCIM groups that the user is a member of. + meta: + "$ref": "#/components/schemas/meta" + scim-enterprise-user-list: + type: object + required: + - schemas + - totalResults + - Resources + - startIndex + - itemsPerPage + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the list + SCIM schemas. + items: + type: string + enum: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + examples: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: + type: integer + description: Number of results found + examples: + - 1 + Resources: + type: array + description: Information about each provisioned account. + items: + "$ref": "#/components/schemas/scim-enterprise-user-response" + startIndex: + type: integer + description: A starting index for the returned page + examples: + - 1 + itemsPerPage: + type: integer + description: Number of objects per page + examples: + - 20 + user-name: + type: object + required: + - familyName + - givenName + properties: + formatted: + type: string + description: The full name, including all middle names, titles, and suffixes + as appropriate, formatted for display. + examples: + - Ms. Mona Lisa Octocat + familyName: + type: string + description: The family name of the user. + examples: + - Octocat + givenName: + type: string + description: The given name of the user. + examples: + - Mona + middleName: + type: string + description: The middle name(s) of the user. + examples: + - Lisa + user-emails: + type: array + description: The emails for the user. + items: + type: object + required: + - value + - type + - primary + properties: + value: + type: string + description: The email address. + examples: + - mlisa@example.com + type: + type: string + description: The type of email address. + examples: + - work + primary: + type: boolean + description: Whether this email address is the primary address. + examples: + - true + user: + type: object + required: + - schemas + - externalId + - userName + - active + - displayName + - emails + properties: + schemas: + type: array + description: The URIs that are used to indicate the namespaces of the SCIM + schemas. + items: + type: string + enum: + - urn:ietf:params:scim:schemas:core:2.0:User + examples: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: + type: string + description: A unique identifier for the resource as defined by the provisioning + client. + examples: + - E012345 + active: + type: boolean + description: Whether the user active in the IdP. + examples: + - true + userName: + type: string + description: The username for the user. + examples: + - E012345 + name: + "$ref": "#/components/schemas/user-name" + displayName: + type: string + description: A human-readable name for the user. + examples: + - Mona Lisa + emails: + "$ref": "#/components/schemas/user-emails" + roles: + "$ref": "#/components/schemas/user-role" + search-result-text-matches: + title: Search Result Text Matches + type: array + items: + type: object + properties: + object_url: + type: string + object_type: + type: + - string + - 'null' + 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 + - 'null' + last_modified_at: + type: string + format: date-time + line_numbers: + type: array + items: + type: string + examples: + - 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + committer: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + assignees: + type: + - array + - 'null' + items: + "$ref": "#/components/schemas/simple-user" + user: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + 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 + state: + type: string + state_reason: + type: + - string + - 'null' + assignee: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + milestone: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/milestone" + comments: + type: integer + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + closed_at: + type: + - string + - 'null' + format: date-time + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + pull_request: + type: object + properties: + merged_at: + type: + - string + - 'null' + format: date-time + diff_url: + type: + - string + - 'null' + format: uri + html_url: + type: + - string + - 'null' + format: uri + patch_url: + type: + - string + - 'null' + format: uri + url: + type: + - string + - 'null' + format: uri + 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 + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + 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 + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + size: + type: integer + stargazers_count: + type: integer + watchers_count: + type: integer + language: + type: + - string + - 'null' + 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 + - 'null' + format: uri + has_issues: + type: boolean + has_projects: + type: boolean + has_pages: + type: boolean + has_wiki: + type: boolean + has_downloads: + type: boolean + has_discussions: + type: boolean + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - 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 + - 'null' + short_description: + type: + - string + - 'null' + description: + type: + - string + - 'null' + created_by: + type: + - string + - 'null' + released: + type: + - string + - 'null' + 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 + - 'null' + logo_url: + type: + - string + - 'null' + format: uri + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + related: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + bio: + type: + - string + - 'null' + email: + type: + - string + - 'null' + format: email + location: + type: + - string + - 'null' + site_admin: + type: boolean + hireable: + type: + - boolean + - 'null' + text_matches: + "$ref": "#/components/schemas/search-result-text-matches" + blog: + type: + - string + - 'null' + company: + type: + - string + - 'null' + suspended_at: + type: + - string + - 'null' + format: date-time + 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 + examples: + - octocat + id: + type: integer + format: int64 + examples: + - 1 + user_view_type: + type: string + node_id: + type: string + examples: + - MDQ6VXNlcjE= + avatar_url: + type: string + format: uri + examples: + - https://github.com/images/error/octocat_happy.gif + gravatar_id: + type: + - string + - 'null' + examples: + - 41d064eb2195891e12d0413f63227ea7 + url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat + html_url: + type: string + format: uri + examples: + - https://github.com/octocat + followers_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/followers + following_url: + type: string + examples: + - https://api.github.com/users/octocat/following{/other_user} + gists_url: + type: string + examples: + - https://api.github.com/users/octocat/gists{/gist_id} + starred_url: + type: string + examples: + - https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/subscriptions + organizations_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/orgs + repos_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/repos + events_url: + type: string + examples: + - https://api.github.com/users/octocat/events{/privacy} + received_events_url: + type: string + format: uri + examples: + - https://api.github.com/users/octocat/received_events + type: + type: string + examples: + - User + site_admin: + type: boolean + name: + type: + - string + - 'null' + examples: + - monalisa octocat + company: + type: + - string + - 'null' + examples: + - GitHub + blog: + type: + - string + - 'null' + examples: + - https://github.com/blog + location: + type: + - string + - 'null' + examples: + - San Francisco + email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + notification_email: + type: + - string + - 'null' + format: email + examples: + - octocat@github.com + hireable: + type: + - boolean + - 'null' + bio: + type: + - string + - 'null' + examples: + - There once was... + twitter_username: + type: + - string + - 'null' + examples: + - monalisa + public_repos: + type: integer + examples: + - 2 + public_gists: + type: integer + examples: + - 1 + followers: + type: integer + examples: + - 20 + following: + type: integer + examples: + - 0 + created_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + updated_at: + type: string + format: date-time + examples: + - '2008-01-14T04:33:35Z' + private_gists: + type: integer + examples: + - 81 + total_private_repos: + type: integer + examples: + - 100 + owned_private_repos: + type: integer + examples: + - 100 + disk_usage: + type: integer + examples: + - 10000 + collaborators: + type: integer + examples: + - 8 + two_factor_authentication: + type: boolean + examples: + - 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 + email: + title: Email + description: Email + type: object + properties: + email: + type: string + format: email + examples: + - octocat@github.com + primary: + type: boolean + examples: + - true + verified: + type: boolean + examples: + - true + visibility: + type: + - string + - 'null' + examples: + - public + required: + - email + - primary + - verified + - visibility + gpg-key: + title: GPG Key + description: A unique encryption key + type: object + properties: + id: + type: integer + format: int64 + examples: + - 3 + name: + type: + - string + - 'null' + examples: + - Octocat's GPG Key + primary_key_id: + type: + - integer + - 'null' + key_id: + type: string + examples: + - 3262EFF25BA0D270 + public_key: + type: string + examples: + - xsBNBFayYZ... + emails: + type: array + items: + type: object + properties: + email: + type: string + verified: + type: boolean + examples: + - email: octocat@users.noreply.github.com + verified: true + subkeys: + type: array + 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 + - 'null' + raw_key: + type: + - string + - 'null' + revoked: + type: boolean + examples: + - 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 + can_sign: + type: boolean + examples: + - true + can_encrypt_comms: + type: boolean + can_encrypt_storage: + type: boolean + can_certify: + type: boolean + examples: + - true + created_at: + type: string + format: date-time + examples: + - '2016-03-24T11:31:04-06:00' + expires_at: + type: + - string + - 'null' + format: date-time + revoked: + type: boolean + examples: + - true + raw_key: + type: + - string + - 'null' + 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 + 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 + examples: + - linkedin + url: + type: string + examples: + - 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 + required: + - key + - id + enterprise-webhooks: + 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/enterprise-server@3.15/admin/overview/about-enterprise-accounts)." + type: object + properties: + description: + description: A short description of the enterprise. + type: + - string + - 'null' + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/octo-business + website_url: + description: The enterprise's website URL. + type: + - string + - 'null' + format: uri + id: + description: Unique identifier of the enterprise + type: integer + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the enterprise. + type: string + examples: + - Octo Business + slug: + description: The slug url identifier for the enterprise. + type: string + examples: + - octo-business + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2019-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '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 + for and sent to a GitHub App. For more information, + see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.15/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 + examples: + - 1 + node_id: + description: The global node ID of the installation. + type: string + examples: + - 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 + organization, or when the event occurs from activity in a repository owned by an organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + 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 + when the event occurs from activity in a repository. + type: object + properties: + id: + description: Unique identifier of the repository + type: integer + format: int64 + examples: + - 42 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + examples: + - Team Environment + full_name: + type: string + examples: + - octocat/Hello-World + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 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 + examples: + - 108 + default_branch: + description: The default branch of the repository. + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + examples: + - 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 + examples: + - true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + examples: + - true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + examples: + - true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + examples: + - 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 + - 'null' + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: + - string + - 'null' + format: date-time + examples: + - '2011-01-26T19:14:43Z' + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + examples: + - true + template_repository: + type: + - object + - 'null' + 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 + examples: + - true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + examples: + - false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + examples: + - 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 + examples: + - 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 + examples: + - 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 + examples: + - '"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 + webhooks_rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/enterprise-server@3.15/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 + exemption-request-push-ruleset-bypass: + title: Push ruleset bypass exemption request data + description: Push rules that are being requested to be bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - push_ruleset_bypass + data: + type: array + description: The data pertaining to the push rules that are being requested + to be bypassed. + items: + type: object + properties: + ruleset_id: + type: integer + description: The ID of the ruleset for the rules that were violated + ruleset_name: + type: string + description: The name of the ruleset for the rules that were violated + total_violations: + type: integer + description: The number of violations + rule_type: + type: string + description: The type of rule that was violated + exemption-request-secret-scanning: + title: Secret scanning push protection exemption request data + description: Secret scanning push protections that are being requested to be + bypassed. + type: object + properties: + type: + type: string + description: The type of request + enum: + - secret_scanning + data: + type: array + description: The data pertaining to the secret scanning push protections + that are being requested to be bypassed. + items: + type: object + properties: + secret_type: + type: string + description: The type of secret that was detected + locations: + type: array + description: The location data of the secret that was detected + items: + type: object + properties: + commit: + type: string + description: The commit SHA where the secret was detected + branch: + type: string + description: The branch where the secret was detected + path: + type: string + description: The path of the file where the secret was detected + exemption-request-secret-scanning-metadata: + title: Secret Scanning Push Protection Exemption Request Metadata + description: Metadata for a secret scanning push protection exemption request. + type: object + properties: + label: + type: string + description: The label for the secret type + reason: + type: string + description: The reason for the exemption request + enum: + - fixed_later + - false_positive + - tests + exemption-response: + title: Exemption response + description: A response to an exemption request by a delegated bypasser. + type: object + properties: + id: + type: integer + description: The ID of the exemption response. + reviewer_id: + type: integer + description: The ID of the user who reviewed the exemption request. + reviewer_login: + type: string + description: The login of the user who reviewed the exemption request. + status: + type: string + description: The status of the exemption response. + enum: + - approved + - rejected + - dismissed + reviewer_comment: + type: + - string + - 'null' + description: The comment the reviewer provided when responding to the exemption + request. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + exemption-request: + title: Exemption Request + description: A request from a user to be exempted from a set of rules. + type: object + properties: + id: + type: integer + description: The ID of the exemption request. + number: + type: integer + description: The number uniquely identifying the exemption request within + it's repository. + repository_id: + type: integer + description: The ID of the repository the exemption request is for. + requester_id: + type: integer + description: The ID of the user who requested the exemption. + requester_login: + type: string + description: The login of the user who requested the exemption. + request_type: + type: string + description: The type of request. + enum: + - push_ruleset_bypass + - secret_scanning + exemption_request_data: + oneOf: + - "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" + - "$ref": "#/components/schemas/exemption-request-secret-scanning" + resource_identifier: + type: string + description: The unique identifier for the request type of the exemption + request. For example, a commit SHA. + examples: + - 827efc6d56897b048c772eb4087f854f46256132 + status: + type: string + description: The status of the exemption request. + enum: + - pending + - rejected + - cancelled + - completed + requester_comment: + type: + - string + - 'null' + description: The comment the requester provided when creating the exemption + request. + metadata: + type: + - object + - 'null' + description: Metadata about the exemption request. + oneOf: + - "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" + expires_at: + type: string + format: date-time + description: The date and time the exemption request will expire. + created_at: + type: string + format: date-time + description: The date and time the exemption request was created. + responses: + type: + - array + - 'null' + description: The responses to the exemption request. + items: + "$ref": "#/components/schemas/exemption-response" + html_url: + type: string + description: The URL to view the exemption request in a browser. + format: uri + examples: + - https://github.com/monalisa/smile/exemptions/1 + simple-check-suite: + description: A suite of checks performed on the code of a given code change + type: object + properties: + after: + type: + - string + - 'null' + examples: + - d6fde92930d4715a2b49857d24b940956b26d2d3 + app: + "$ref": "#/components/schemas/integration" + before: + type: + - string + - 'null' + examples: + - 146e867f55c26428e5f9fade55a9bbf5e95a7912 + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - stale + - startup_failure + - + examples: + - neutral + created_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + examples: + - master + head_sha: + description: The SHA of the head commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + id: + type: integer + examples: + - 5 + node_id: + type: string + examples: + - MDEwOkNoZWNrU3VpdGU1 + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + repository: + "$ref": "#/components/schemas/minimal-repository" + status: + type: string + enum: + - queued + - in_progress + - completed + - pending + - waiting + examples: + - completed + updated_at: + type: string + format: date-time + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-suites/5 + check-run-with-simple-check-suite: + title: CheckRun + description: A check performed on the code of a given code change + type: object + properties: + app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + check_suite: + "$ref": "#/components/schemas/simple-check-suite" + completed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2018-05-04T01:14:52Z' + conclusion: + type: + - string + - 'null' + enum: + - waiting + - pending + - startup_failure + - stale + - success + - failure + - neutral + - cancelled + - skipped + - timed_out + - action_required + - + examples: + - neutral + deployment: + "$ref": "#/components/schemas/deployment-simple" + details_url: + type: string + examples: + - https://example.com + external_id: + type: string + examples: + - '42' + head_sha: + description: The SHA of the commit that is being checked. + type: string + examples: + - '009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d' + html_url: + type: string + examples: + - https://github.com/github/hello-world/runs/4 + id: + description: The id of the check. + type: integer + examples: + - 21 + name: + description: The name of the check. + type: string + examples: + - test-coverage + node_id: + type: string + examples: + - MDg6Q2hlY2tSdW40 + output: + type: object + properties: + annotations_count: + type: integer + annotations_url: + type: string + format: uri + summary: + type: + - string + - 'null' + text: + type: + - string + - 'null' + title: + type: + - string + - 'null' + required: + - title + - summary + - text + - annotations_count + - annotations_url + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request-minimal" + started_at: + type: string + format: date-time + examples: + - '2018-05-04T01:14:52Z' + status: + description: The phase of the lifecycle that the check is currently in. + type: string + enum: + - queued + - in_progress + - completed + - pending + examples: + - queued + url: + type: string + examples: + - https://api.github.com/repos/github/hello-world/check-runs/4 + 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/enterprise-server@3.15/rest/git/refs#get-a-reference) + resource. + type: string + webhooks_deploy_key: + description: The [`deploy key`](https://docs.github.com/enterprise-server@3.15/rest/deploy-keys/deploy-keys#get-a-deploy-key) + resource. + type: object + properties: + added_by: + type: + - string + - 'null' + created_at: + type: string + id: + type: integer + key: + type: string + last_used: + type: + - string + - 'null' + read_only: + type: boolean + title: + type: string + url: + type: string + format: uri + verified: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + webhooks_workflow: + title: Workflow + type: + - object + - 'null' + 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 + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: + type: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + answer_chosen_at: + type: + - string + - 'null' + answer_chosen_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + type: + - string + - 'null' + enum: + - resolved + - outdated + - duplicate + - reopened + - + examples: + - resolved + timeline_url: + type: string + title: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - author_association + - active_lock_reason + - 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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/enterprise-server@3.15/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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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_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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - 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 + 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 + required: + - name + - id + webhooks_milestone_3: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + state: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + repositories: + type: + - array + - 'null' + 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 + 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 + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + description: Date and time when the associated fine-grained personal access + token was last used for authentication. + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + node_id: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: + type: + - string + - 'null' + public: + type: boolean + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + number: + type: integer + short_description: + type: + - string + - 'null' + deleted_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + deleted_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + webhooks_project_changes: + type: object + properties: + archived_at: + type: object + properties: + from: + type: + - string + - 'null' + format: date-time + to: + type: + - string + - 'null' + format: date-time + 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: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + 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 + name: + type: string + color: + type: + - string + - 'null' + description: + type: + - string + - 'null' + 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 + title: + type: string + duration: + type: + - number + - 'null' + start_date: + type: + - string + - 'null' + required: + - id + - title + 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. + - `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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + webhooks_review_comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + webhooks_release: + title: Release + description: The [release](https://docs.github.com/enterprise-server@3.15/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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - content_type + - size + - download_count + - created_at + - updated_at + assets_url: + type: string + format: uri + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: uri + required: + - url + - assets_url + - upload_url + - html_url + - id + - node_id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + - assets + - tarball_url + - zipball_url + - body + webhooks_release_1: + title: Release + description: The [release](https://docs.github.com/enterprise-server@3.15/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 + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + 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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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: + - open + secret-scanning-alert-resolution-webhook: + type: + - string + - 'null' + description: The reason for resolving the alert. + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + 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/enterprise-server@3.15/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets)." + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - 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 + 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 + 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 + - 'null' + 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 + - 'null' + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-exemption-request-cancelled: + title: Exemption request cancellation 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - sender + webhook-exemption-request-completed: + title: Exemption request 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - sender + webhook-exemption-request-created: + title: Exemption request 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - sender + webhook-exemption-request-response-dismissed: + title: Exemption response dismissed event + type: object + properties: + action: + type: string + enum: + - response_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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - exemption_response + - sender + webhook-exemption-request-response-submitted: + title: Exemption response submitted event + type: object + properties: + action: + type: string + enum: + - response_submitted + 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" + exemption_request: + "$ref": "#/components/schemas/exemption-request" + exemption_response: + "$ref": "#/components/schemas/exemption-response" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - exemption_request + - exemption_response + - sender + webhook-cache-sync: + type: object + properties: + after: + type: string + before: + type: string + cache_location: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + 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" + required: + - cache_location + - ref + - before + - after + 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" + 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" + 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" + 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" + 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/enterprise-server@3.15/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: The client ID of the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + - 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/enterprise-server@3.15/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: Client ID of the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + 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/enterprise-server@3.15/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + 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 + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + client_id: + description: The Client ID for the GitHub app + type: + - string + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + enum: + - requested + - in_progress + - completed + - queued + - + 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: + 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 + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + 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 + - 'null' + 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: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-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 + - 'null' + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + 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: + - 'null' + fixed_at: + type: + - 'null' + 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 + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: + - string + - 'null' + enum: + - open + - dismissed + - + tool: + type: + - object + - 'null' + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + required: + - name + - version + updated_at: + type: + - string + - 'null' + 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-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: + 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 + - 'null' + format: date-time + dismissed_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + 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 + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + 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 + - 'null' + dismissed_by: + type: + - object + - 'null' + 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 + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + 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 + - 'null' + 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: + 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 + - 'null' + 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 + - 'null' + 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: + 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: + - 'null' + dismissed_by: + type: + - 'null' + 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: + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + 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 + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + 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 + - 'null' + 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-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 + - 'null' + 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 + - 'null' + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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-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-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/enterprise-server@3.15/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - 'null' + 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: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + deployment_callback_url: + description: The URL to review the deployment protection rule. + type: string + format: uri + deployment: + "$ref": "#/components/schemas/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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + 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: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + completed_at: + type: + - string + - 'null' + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - skipped + - + 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/enterprise-server@3.15/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + environment: + type: string + id: + type: integer + node_id: + type: string + original_environment: + type: string + payload: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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/enterprise-server@3.15/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - startup_failure + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - 'null' + 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: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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-enterprise-anonymous-access-disabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_disabled + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + webhook-enterprise-anonymous-access-enabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_enabled + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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: + type: + - 'null' + languages_url: + type: string + license: + type: + - object + - 'null' + merges_url: + type: string + milestones_url: + type: string + mirror_url: + type: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + avatar_url: + type: string + created_at: + type: string + description: + type: + - 'null' + 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: + type: + - 'null' + 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: + type: + - 'null' + 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/enterprise-server@3.15/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: + anyOf: + - type: 'null' + - "$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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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-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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + assignee: + type: + - object + - 'null' + assignees: + type: array + items: + type: + - object + - 'null' + author_association: + type: string + body: + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + labels_url: + type: string + locked: + type: boolean + milestone: + type: + - object + - 'null' + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: + - object + - 'null' + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: + - object + - 'null' + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + 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_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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.15/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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: + title: Sub-issues Summary + type: object + properties: + total: + type: integer + completed: + type: integer + percent_completed: + type: integer + required: + - total + - completed + - percent_completed + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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-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/enterprise-server@3.15/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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + 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 + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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 + - 'null' + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + 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 + 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 + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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-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-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` + 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: + "$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 + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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-meta-deleted: + title: meta deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + hook: + description: 'The modified 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: + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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-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 + - 'null' + failed_at: + type: + - string + - 'null' + format: date-time + failed_reason: + type: + - string + - 'null' + id: + type: number + invitation_teams_url: + type: string + format: uri + inviter: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + description: + type: + - string + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + namespace: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + labels: + type: + - object + - 'null' + manifest: + type: + - object + - 'null' + 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 + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + type: + - object + - 'null' + bugs: + type: + - object + - 'null' + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + type: + - object + - 'null' + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + type: + - object + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + namespace: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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/enterprise-server@3.15/rest/pages/pages#list-github-pages-builds) + itself. + type: object + properties: + commit: + type: + - string + - 'null' + created_at: + type: string + duration: + type: integer + error: + type: object + properties: + message: + type: + - string + - 'null' + required: + - message + pusher: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + archived: + description: Whether or not the card is archived + type: boolean + column_id: + type: + - integer + - 'null' + column_url: + type: string + format: uri + content_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + archived: + type: boolean + column_id: + type: integer + column_url: + type: string + created_at: + type: string + creator: + type: + - object + - 'null' + 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 + - 'null' + 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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/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 + - 'null' + to: + type: + - string + - 'null' + public: + type: object + properties: + from: + type: boolean + to: + type: boolean + short_description: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + 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. + 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: + oneOf: + - type: string + - type: integer + - "$ref": "#/components/schemas/projects-v2-single-select-option" + - "$ref": "#/components/schemas/projects-v2-iteration-setting" + type: + - 'null' + - string + - integer + - object + to: + oneOf: + - type: string + - type: integer + - "$ref": "#/components/schemas/projects-v2-single-select-option" + - "$ref": "#/components/schemas/projects-v2-iteration-setting" + type: + - 'null' + - string + - integer + - object + required: + - field_value + - type: object + properties: + body: + type: object + properties: + from: + type: + - string + - 'null' + to: + type: + - string + - 'null' + 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 + - 'null' + to: + type: + - string + - 'null' + 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-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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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_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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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-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-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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + required: + - action + - thread + - pull_request + - repository + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + merged_at: + type: + - string + - 'null' + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + 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 + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + required: + - action + - thread + - pull_request + - repository + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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 + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + 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 + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + due_on: + type: + - string + - 'null' + 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 + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + homepage: + type: + - string + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + description: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + manifest: + type: + - object + - 'null' + 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 + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + bugs: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + 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 + type: + - 'null' + - string + - object + 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 + - 'null' + items: + type: object + properties: + id: + oneOf: + - type: string + - type: object + - type: integer + type: + - 'null' + - string + - object + - integer + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + about_url: + type: string + name: + type: string + type: + type: string + url: + type: string + vendor: + type: string + updated_at: + type: + - string + - 'null' + 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: + type: + - 'null' + 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 + - 'null' + 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 + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + 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 + - 'null' + 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 + 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/enterprise-server@3.15/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 + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + 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 + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + created_at: + type: + - string + - 'null' + 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 + name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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-anonymous-access-disabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_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 + webhook-repository-anonymous-access-enabled: + type: object + properties: + action: + type: string + enum: + - anonymous_access_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 + 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 + - 'null' + 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 + - 'null' + required: + - from + homepage: + type: object + properties: + from: + type: + - string + - 'null' + required: + - from + topics: + type: object + properties: + from: + type: + - array + - 'null' + 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-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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: 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 + - 'null' + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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-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-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-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-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 + - 'null' + 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 + - 'null' + 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 + 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 + - 'null' + 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.' + type: + - 'null' + required: + - action + - starred_at + - repository + - sender + webhook-status: + title: status event + type: object + properties: + avatar_url: + type: + - string + - 'null' + 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 + - 'null' + url: + type: + - string + - 'null' + format: uri + required: + - sha + - url + name: + type: string + protected: + type: boolean + required: + - name + - commit + - protected + commit: + type: object + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + verified: + type: boolean + required: + - verified + - reason + - signature + - payload + required: + - author + - committer + - message + - tree + - url + - comment_count + - verification + committer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + updated_at: + type: string + required: + - id + - sha + - name + - target_url + - context + - description + - state + - commit + - branches + - created_at + - updated_at + - repository + - sender + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + 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-user-created: + 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" + user: + "$ref": "#/components/schemas/webhooks_user" + required: + - action + webhook-user-deleted: + 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" + user: + "$ref": "#/components/schemas/webhooks_user" + required: + - action + 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 + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + format: uri + id: + type: integer + labels: + description: Custom labels for the job. Specified by the [`"runs-on"` + attribute](https://docs.github.com/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + name: + type: string + node_id: + type: string + run_attempt: + type: integer + run_id: + type: integer + run_url: + type: string + runner_group_id: + type: + - number + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - number + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + status: + type: string + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + type: + - object + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - + - 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/enterprise-server@3.15/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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - + - cancelled + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - number + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + status: + type: string + enum: + - in_progress + - completed + - queued + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - integer + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + format: date-time + status: + type: string + enum: + - queued + - in_progress + - completed + - waiting + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + conclusion: + type: + - string + - 'null' + 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 + - 'null' + runner_group_name: + type: + - string + - 'null' + runner_id: + type: + - integer + - 'null' + runner_name: + type: + - string + - 'null' + started_at: + type: string + format: date-time + head_branch: + type: + - string + - 'null' + description: The name of the current branch. + workflow_name: + type: + - string + - 'null' + description: The name of the workflow. + status: + type: string + enum: + - queued + - in_progress + - completed + - waiting + steps: + type: array + items: + title: Workflow Step + type: object + properties: + completed_at: + type: + - string + - 'null' + conclusion: + type: + - string + - 'null' + enum: + - failure + - skipped + - success + - cancelled + - + name: + type: string + number: + type: integer + started_at: + type: + - string + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: + type: + - object + - 'null' + required: + - url + - id + - number + - head + - base + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-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 + 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. + examples: + - Simple 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: + type: + - object + - 'null' + required: + - url + - id + - number + - head + - base + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + 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 + - 'null' + 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 + - 'null' + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + 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 + 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} + global-hook-items: + value: + - type: Global + id: 1 + name: web + active: true + events: + - organization + - user + config: + url: https://example.com + content_type: json + insecure_ssl: '0' + secret: "********" + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + global-hook: + value: + type: Global + id: 1 + name: web + active: true + events: + - organization + - user + config: + url: https://example.com + content_type: json + insecure_ssl: '0' + secret: "********" + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + global-hook-2: + value: + type: Global + id: 1 + name: web + active: true + events: + - organization + config: + url: https://example.com + content_type: form + insecure_ssl: '0' + updated_at: '2017-12-07T00:14:59Z' + created_at: '2017-12-07T00:14:59Z' + url: https://api.github.com/admin/hooks/1 + ping_url: https://api.github.com/admin/hooks/1/pings + enterprise-public-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 + last_used: '2020-06-11T22:31:57Z' + user_id: 1 + repository_id: 2 + - key: 9Og8iYjAyymI9LvABpJerYrMxURPc8r+dB7TJyvv1234 + id: 3 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + verified: false + read_only: false + last_used: '2020-06-11T22:31:57Z' + user_id: 1 + repository_id: 2 + ldap-mapping-team: + value: + ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com + 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: + ldap-mapping-user: + value: + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: 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 + 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 + pre-receive-environment-items: + value: + - id: 1 + name: Default + image_url: githubenterprise://internal + url: https://github.example.com/api/v3/admin/pre-receive-environments/1 + html_url: https://github.example.com/admin/pre-receive-environments/1 + default_environment: true + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 14 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest + state: not_started + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + - id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-environment: + value: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: not_started + downloaded_at: + message: + pre-receive-environment-default-response: + value: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-environment-download-status-default-response: + value: + url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest + state: not_started + downloaded_at: + message: + pre-receive-environment-download-status: + value: + url: https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + pre-receive-hook-items: + value: + - id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: false + pre-receive-hook: + value: + id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 2 + name: DevTools Hook Env + image_url: https://my_file_server/path/to/devtools_env.tar.gz + url: https://github.example.com/api/v3/admin/pre-receive-environments/2 + html_url: https://github.example.com/admin/pre-receive-environments/2 + default_environment: false + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: false + pre-receive-hook-2: + value: + id: 1 + name: Check Commits + enforcement: disabled + script: scripts/commmit_check.sh + script_repository: + id: 595 + full_name: DevIT/hooks + url: https://github.example.com/api/v3/repos/DevIT/hooks + html_url: https://github.example.com/DevIT/hooks + environment: + id: 1 + name: Default + image_url: githubenterprise://internal + url: https://github.example.com/api/v3/admin/pre-receive-environments/1 + html_url: https://github.example.com/admin/pre-receive-environments/1 + default_environment: true + created_at: '2016-05-20T11:35:45-05:00' + hooks_count: 1 + download: + url: https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest + state: success + downloaded_at: '2016-05-26T07:42:53-05:00' + message: + allow_downstream_configuration: true + classic-personal-access-tokens: + value: + - id: 2 + url: https://enterprise.octocat.com/api/v3/authorizations/2 + app: + name: My personal access token + url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens + client_id: '00000000000000000000' + token: ghp_16C7e42F292c6912E7710c838347Ae178B4a + hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 + token_last_eight: Ae178B4a + note: My personal access token + note_url: + created_at: '2019-04-24T21:49:02Z' + updated_at: '2019-04-24T21:49:02Z' + scopes: + - admin:business + - admin:gpg_key + - admin:org + - admin:org_hook + - admin:pre_receive_hook + - admin:public_key + - admin:repo_hook + - delete_repo + - gist + - notifications + - repo + - user + - write:discussion + fingerprint: + 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 + authorization: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + 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: + 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: + 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----- + 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: + 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: + suspended_by: + 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: + suspended_by: + 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: + 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 + application-grant-items: + value: + - id: 1 + url: https://api.github.com/applications/grants/1 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + created_at: '2011-09-06T17:26:27Z' + updated_at: '2011-09-06T20:39:23Z' + scopes: + - public_repo + application-grant: + value: + id: 1 + url: https://api.github.com/applications/grants/1 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + created_at: '2011-09-06T17:26:27Z' + updated_at: '2011-09-06T20:39:23Z' + scopes: + - public_repo + 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: [] + authorization-items: + value: + - id: 2 + url: https://enterprise.octocat.com/api/v3/authorizations/2 + app: + name: My personal access token + url: https://docs.github.com/enterprise/rest/enterprise-admin/users#list-personal-access-tokens + client_id: '00000000000000000000' + token: ghp_16C7e42F292c6912E7710c838347Ae178B4a + hashed_token: 23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45 + token_last_eight: Ae178B4a + note: My personal access token + note_url: + created_at: '2019-04-24T21:49:02Z' + updated_at: '2019-04-24T21:49:02Z' + scopes: + - admin:business + - admin:gpg_key + - admin:org + - admin:org_hook + - admin:pre_receive_hook + - admin:public_key + - admin:repo_hook + - delete_repo + - gist + - notifications + - repo + - user + - write:discussion + fingerprint: + authorization-response-if-returning-an-existing-token-2: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: '' + authorization-response-if-returning-an-existing-token: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + authorization-3: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2012-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + authorization-2: + value: + id: 1 + url: https://api.github.com/authorizations/1 + scopes: + - public_repo + token: ghu_16C7e42F292c6912E7710c838347Ae178B4a + token_last_eight: Ae178B4a + hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 + app: + url: http://my-github-app.com + name: my github app + client_id: abcde12345fghij67890 + note: optional note + note_url: http://optional/note/url + updated_at: '2011-09-06T20:39:23Z' + created_at: '2011-09-06T17:26:27Z' + expires_at: '2011-10-06T17:26:27Z' + fingerprint: jklmnop12345678 + 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/ + 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 + 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 + announcement: + summary: Announcement banner + value: + announcement: Very **important** announcement about _something_. + expires_at: '2021-01-01T00:00:00.000+00:00' + user_dismissible: false + license-info: + value: + seats: 1400 + seats_used: 1316 + seats_available: 84 + kind: standard + days_until_expiration: 365 + expire_at: 2016/02/06 12:41:52 -0600 + enterprise-overview: + value: + repos: + total_repos: 212 + root_repos: 194 + fork_repos: 18 + org_repos: 51 + total_pushes: 3082 + total_wikis: 15 + hooks: + total_hooks: 27 + active_hooks: 23 + inactive_hooks: 4 + pages: + total_pages: 36 + orgs: + total_orgs: 33 + disabled_orgs: 0 + total_teams: 60 + total_team_members: 314 + users: + total_users: 254 + admin_users: 45 + suspended_users: 21 + pulls: + total_pulls: 86 + merged_pulls: 60 + mergeable_pulls: 21 + unmergeable_pulls: 3 + issues: + total_issues: 179 + open_issues: 83 + closed_issues: 96 + milestones: + total_milestones: 7 + open_milestones: 6 + closed_milestones: 1 + gists: + total_gists: 178 + private_gists: 151 + public_gists: 25 + comments: + total_commit_comments: 6 + total_gist_comments: 28 + total_issue_comments: 366 + total_pull_request_comments: 30 + enterprise-security-products-overview: + value: + total_repos: 150 + nonarchived_repos: 130 + secret_scanning_enabled_repos: 150 + secret_scanning_push_protection_enabled_repos: 120 + code_scanning_enabled_repos: 140 + code_scanning_pr_reviews_enabled_repos: 100 + code_scanning_default_setup_enabled_repos: 50 + code_scanning_default_setup_eligible_repos: 30 + dependabot_alerts_enabled_repos: 130 + dependabot_security_updates_enabled_repos: 120 + dependabot_version_updates_enabled_repos: 121 + advanced_security_enabled_repos: 150 + active_committers: 30 + purchased_committers: 90 + maximum_committers: 80 + actions-cache-usage-org-enterprise: + value: + total_active_caches_size_in_bytes: 3344284 + total_active_caches_count: 5 + actions-cache-usage-policy-enterprise: + value: + repo_cache_size_limit_in_gb: 10 + max_repo_cache_size_limit_in_gb: 15 + actions-enterprise-permissions: + value: + enabled_organizations: all + allowed_actions: selected + selected_actions_url: https://api.github.com/enterprises/2/actions/permissions/selected-actions + organization-targets: + value: + total_count: 1 + organizations: + - login: octocat + id: 161335 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + url: https://api.github.com/orgs/octo-org + repos_url: https://api.github.com/orgs/octo-org/repos + events_url: https://api.github.com/orgs/octo-org/events + hooks_url: https://api.github.com/orgs/octo-org/hooks + issues_url: https://api.github.com/orgs/octo-org/issues + members_url: https://api.github.com/orgs/octo-org/members{/member} + public_members_url: https://api.github.com/orgs/octo-org/public_members{/member} + avatar_url: https://github.com/images/error/octocat_happy.gif + description: A great organization + 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-enterprise: + value: + total_count: 3 + runner_groups: + - id: 1 + name: Default + visibility: all + default: true + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners + allows_public_repositories: false + restricted_to_workflows: false + selected_workflows: [] + workflow_restrictions_read_only: false + - id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners + 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 + - id: 3 + name: expensive-hardware + visibility: private + default: false + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners + 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-enterprise: + value: + id: 2 + name: octo-runner-group + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + allows_public_repositories: false + restricted_to_workflows: true + selected_workflows: + - octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main + workflow_restrictions_read_only: false + runner-group-update-enterprise: + value: + id: 2 + name: Expensive hardware runners + visibility: selected + default: false + selected_organizations_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations + runners_url: https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners + 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-paginated: + value: + total_count: 2 + runners: + - id: 23 + name: linux_runner + os: linux + status: online + busy: true + 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 + 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-airgap: + value: + - os: osx + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-osx-x64-2.277.1.tar.gz + filename: actions-runner-osx-x64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: f1fa173889dc9036cd529417e652e1729e5a3f4d35ec0151806d7480fda6b89b + - os: linux + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-x64-2.277.1.tar.gz + filename: actions-runner-linux-x64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: 02d710fc9e0008e641274bb7da7fde61f7c9aa1cbb541a2990d3450cc88f4e98 + - os: linux + architecture: arm + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm-2.277.1.tar.gz + filename: actions-runner-linux-arm-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIyYTEzZDRmZC01ZDhkLTRjNzgtYjg2MS0zYTMxZGQ3MmYzNjQiLCJzaWQiOiI0MzZiNTg3YS04ODMyLTRiMTMtOWM2Ny05OWRkMjA2ZTQzNmMiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MzE1NzEsImV4cCI6MTYxNzkzNTc3MX0.PMhU7-MOnZRDj5k5a4ieeFlQCmKPl2pQvpVRhGZq-9ByKF5s9G0rsnGBxDcolTYlbvEAmSSkeAEwF486F7P0kMVEb-GI14WbErqqMSyaPL81c3W7UHxMJLaSBnDs9ftHMv_IkJmRzaROS8q1ObzUW-ErlltxCdj2zF_5ruK9G2RR566AOAtiA3AHV6k7-FCY5--sDYJN_YXPgpwI0fPN1TM92fdPm93hJnoXuCJNpBYp1vl5W4gwGtU_Pa07ESdqqFN1YJJHUloedNhiIOczGfGVSapRc8vyGm9P_VCM_yKD8JI-MkOXl8JI5fCfhmjmKsw-vSAh9NW67RGvmehmpw + sha256_checksum: 2f2bda21e2fd8fed6938b33182a293f6b1f74e4c5d09acd6d9a0fe3f979f5c85 + - os: win + architecture: x64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-win-x64-2.277.1.zip + filename: actions-runner-win-x64-2.277.1.zip + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: 7215c75a462eeb6a839fa8ed298d79f620617d44d47d37c583114fc3f3b27b30 + - os: linux + architecture: arm64 + download_url: https://github.com/actions/runner/releases/download/v2.277.1/actions-runner-linux-arm64-2.277.1.tar.gz + filename: actions-runner-linux-arm64-2.277.1.tar.gz + temp_download_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IkJmSjdCUXpLdXhjWDc4WnJ5NUxnUW53ZFRrMCJ9.eyJuYW1laWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJzY3AiOiJBY3Rpb25zUnVudGltZS5QYWNrYWdlRG93bmxvYWQiLCJJZGVudGl0eVR5cGVDbGFpbSI6IlN5c3RlbTpTZXJ2aWNlSWRlbnRpdHkiLCJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9zaWQiOiJERERERERERC1ERERELUREREQtRERERC1EREREREREREREREQiLCJodHRwOi8vc2NoZW1hcy5taWNyb3NvZnQuY29tL3dzLzIwMDgvMDYvaWRlbnRpdHkvY2xhaW1zL3ByaW1hcnlzaWQiOiJkZGRkZGRkZC1kZGRkLWRkZGQtZGRkZC1kZGRkZGRkZGRkZGQiLCJhdWkiOiIwZTZkODAxYi02NzVlLTQ1YzAtOWM4NC1jYTkzNjdlZjc1NjciLCJzaWQiOiI4ZTE5MDliZC1kYzU1LTQ2MWYtOTk2Mi1hZTI0OTEzNzU4OWIiLCJpc3MiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJhdWQiOiJ2c3Rva2VuLmNvZGVkZXYubXMiLCJuYmYiOjE2MTc5MDQxNzUsImV4cCI6MTYxNzkwODM3NX0.YNsRXL9pBuIfLVndnyVQOpru77Br8hgYIX7LPsOaMfKk4K88YG89a2VIXUWPyHRiOaC-4J0lIPei8ujezEtnMfNZCwHdWq0Niiy-2-ywcfGPmcz-RHz_ZglkPFbzKaiZWJcFKCGHCP0Ta3kdXumJQqiVJEIyppxIY-caR_Wsw2L4BZHOefJq-odsJ0guPgm9fVuU9FxVRkucho1UH_bzt0tAMl1gEWOLBLZ88U9LKCzHWaxheFeBV4DTt1lAcSm213gKP1eMbgAGn5heWhR4RMRBzZc2HO3Lf1syu4E8fW8a-esRAxEYPfqPHwN9LNj2jaU3D3nPwa8lHQLLtA1PNA + sha256_checksum: a6aa6dd0ba217118ef2b4ea24e9e0a85b02b13c38052a5de0776d6ced3a79c64 + 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 + 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 + audit-log: + value: + - actor_ip: 88.123.45.123 + from: pull_requests#merge + device_cookie: + actor: mona-admin + actor_id: 7 + repo: octo-org/octo-repo + repo_id: 17 + business: github + business_id: 1 + org: octo-org + org_id: 8 + action: pull_request.merge + "@timestamp": 1635940599755 + created_at: 1635940599755 + operation_type: modify + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: POST + request_id: e4dabc4d-ba16-4bca-1234-649be7ae1188 + server_id: 5d17aab5-fd9f-abcd-a820-16bed246441b + request_category: other + controller_action: merge + url: https://example.com/octo-org/octo-repo/pull/1/merge + client_id: 322299977.1635936 + referrer: https://example.com/octo-org/octo-repo/pull/1 + actor_session: 1 + pull_request_id: 1 + category_type: Resource Management + - actor_ip: 88.123.45.123 + from: pull_request_review_events#create + device_cookie: + actor: mona-admin + actor_id: 7 + business_id: 1 + org_id: 8 + action: pull_request_review.submit + "@timestamp": 1635940593079 + created_at: 1635940593079 + operation_type: modify + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: PUT + request_id: c0f63bb7-17b6-4796-940c-12345c5a581b + server_id: 2abc1234-f651-43e3-9696-e942ad5f8c89 + request_category: other + controller_action: create + url: https://example.com/octo-org/octo-repo/pull/1/reviews + client_id: 322299977.1635936 + referrer: https://example.com/octo-org/octo-repo/pull/1/files + actor_session: 1 + spammy: false + pull_request_id: 1 + body: + allowed: true + id: 1 + state: 40 + issue_id: 1 + review_id: 1 + category_type: Resource Management + - actor_ip: 88.123.45.123 + from: pull_requests#create + device_cookie: + actor: mona + actor_id: 9 + user_id: 9 + repo: octo-org/octo-repo + repo_id: 17 + business: github + business_id: 1 + org: octo-org + org_id: 8 + action: pull_request.create + "@timestamp": 1635940554161 + created_at: 1635940554161 + operation_type: create + actor_location: + country_code: GB + country_name: United Kingdom + region: ENG + region_name: England + city: Louth + postal_code: LN11 + location: + lat: 53.4457 + lon: 0.141 + data: + user_agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) ... + method: POST + request_id: 2773abeb-477f-4ebf-a017-f8e8a206c305 + server_id: 796e3115-4ce8-4606-8fd0-99ea57a2e12b + request_category: other + controller_action: create + url: https://example.com/octo-org/octo-repo/pull/create?base=octo-org%3Amain&head=mona%3Apatch-1 + client_id: 386351111.163594 + referrer: https://example.com/octo-org/octo-repo/compare/main...mona:patch-1 + actor_session: 2 + pull_request_id: 1 + category_type: Resource Management + 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: + 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 + enterprise-security-analysis-settings: + value: + advanced_security_enabled_for_new_repositories: true + dependabot_alerts_enabled_for_new_repositories: true + secret_scanning_enabled_for_new_repositories: true + secret_scanning_push_protection_enabled_for_new_repositories: true + secret_scanning_push_protection_custom_link: https://github.com/test-org/test-repo/blob/main/README.md + secret_scanning_non_provider_patterns_enabled_for_new_repositories: true + 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 + 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: + 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: + 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} + 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 + - number: 1 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 + html_url: https://github.com/owner/repo/security/secret-scanning/1 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/locations + state: open + resolution: + resolved_at: + resolved_by: + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + 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: + 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 + advanced-security-active-committers: + value: + total_advanced_security_committers: 2 + total_count: 2 + maximum_advanced_security_committers: 4 + purchased_advanced_security_committers: 4 + repositories: + - name: octocat-org/Hello-World + advanced_security_committers: 2 + advanced_security_committers_breakdown: + - user_login: octocat + last_pushed_date: '2021-11-03' + last_pushed_email: octocat@github.com + - user_login: octokitten + last_pushed_date: '2021-10-25' + last_pushed_email: octokitten@github.com + - name: octocat-org/server + advanced_security_committers: 1 + advanced_security_committers_breakdown: + - user_login: octokitten + last_pushed_date: '2021-10-26' + last_pushed_email: octokitten@github.com + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-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 + 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: + 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 + 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 + 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: + 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 + 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: + 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: + 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: + 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 + *.o + + # Libraries + *.lib + *.a + + # Shared objects (inc. Windows DLLs) + *.dll + *.so + *.so.* + *.dylib + + # Executables + *.exe + *.out + *.app + 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: + 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 + 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 + 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 + 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 + 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: |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 + ghes-get-ssh: + value: + - key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCwcd9tu20xsJVBMWbIs+JDVQTvkLtrJ8A7eblSwC+zECver22QExC9d6zHy10MAyk1Ck7Bu6/0Z+rr/31vMcAOmNOLjExzWxBCXbtDf3758Qfw7FuvkaTE1sHztwSFi/yNhZSw7uPEWeGQiRY4UldSKG9zZvrZmxpnP8mNZzPriQ== + fingeprint: bd:26:d3:a2:ad:97:c0:7c:2d:57:a4:64:f3:fb:44:45 + - key: ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQCg73sgCdLL9rWcmVTmvcOgAWZaokZTeNnMFEoaZWZcVtsP4Ed+ICuSbT1wDuyL/XXzr0O2u2bKwx8Np/3UGHb4R9Re+qiz//l5OCBd3KonO2GFICQwKGmVeZ+ki89aN2JDKgfemHbvclHYBD/r56lnbt/kinw7JqGPp+ndzH8nBw== + fingeprint: e1:1e:a0:f1:3f:a9:70:2d:99:dd:02:9d:39:1c:8b:a4 + ghes-set-ssh: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: SSH key added successfully + modified: true + ghes-delete-ssh: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: SSH key removed successfully + ghes-checks-system-requirements: + value: + status: OK + nodes: + - hostname: ghe-local-app + status: OK + roles_status: + - status: OK + role: ConsulServer + - status: OK + role: JobServer + - status: OK + role: WebServer + - hostname: ghe-local-app2 + status: OK + roles_status: + - status: OK + role: ConsulServer + - status: OK + role: GitServer + ghes-cluster-status: + value: + status: OK + nodes: + - hostname: ghe-local-app + status: OK + services: + - status: OK + name: es + details: Elasticsearch cluster is in sync (0 shards initializing, 0 shards + unassigned) + - status: OK + name: git-replication + details: Git replication is in sync + - status: OK + name: kafka-lite-admin-healthcheck + details: '' + - status: OK + name: kafka-lite-broker-is-reachable + details: '' + - status: OK + name: memcache + details: '' + - status: OK + name: metrics + details: '' + - status: OK + name: mysql-replication + details: Replication is running + - status: OK + name: mysql-failover + details: '' + - status: OK + name: pages + details: Pages replication is in sync + - status: OK + name: redis + details: Redis is OK + - status: OK + name: storage + details: Storage replication is in sync + - hostname: ghe-local-app2 + status: OK + services: + - status: OK + name: kafka-lite-admin-healthcheck + details: '' + - status: OK + name: kafka-lite-broker-is-reachable + details: '' + ghes-license-info: + value: + - advancedSecurityEnabled: true + advancedSecuritySeats: 0 + clusterSupport: false + company: GitHub + croquetSupport: true + customTerms: true + evaluation: false + expireAt: '2025-01-02T07:59:59Z' + insightsEnabled: true + insightsExpireAt: '2025-01-02T07:59:59.999Z' + learningLabEvaluationExpires: '2023-01-02T07:59:59Z' + learningLabSeats: 100 + perpetual: false + referenceNumber: 32a145 + seats: 0 + sshAllowed: true + supportKey": '' + unlimitedSeating: true + ghes-license-check: + value: + - status: valid + ghes-config-nodes: + value: + topology: Cluster + nodes: + - hostname: data1 + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + cluster_roles: + - ConsulServer + - ElasticsearchServer + - GitServer + - StorageServer + - hostname: data2 + uuid: 228406d4-f97c-11ed-ab01-062281bbcf03 + cluster_roles: + - ElasticsearchServer + - StorageServer + - PagesServer + ghes-get-settings: + value: + private_mode: false + public_pages: false + subdomain_isolation: true + signup_enabled: false + github_hostname: ghe.local + identicons_host: dotcom + http_proxy: + auth_mode: default + expire_sessions: false + admin_password: + configuration_id: 1401777404 + configuration_run_count: 4 + avatar: + enabled: false + uri: '' + customer: + name: GitHub + email: stannis@themannis.biz + uuid: af6cac80-e4e1-012e-d822-1231380e52e9 + secret_key_data: | + -----BEGIN PGP PRIVATE KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + lQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx... + -----END PGP PRIVATE KEY BLOCK----- + public_key_data: | + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1.4.10 (GNU/Linux) + mI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7.... + -----END PGP PUBLIC KEY BLOCK----- + license: + seats: 0 + evaluation: false + perpetual: false + unlimited_seating: true + support_key: ssh-rsa AAAAB3N.... + ssh_allowed: true + cluster_support: false + expire_at: '2016-04-27T00:00:00-07:00' + github_ssl: + enabled: false + cert: + key: + ldap: + host: + port: 0 + base: [] + uid: + bind_dn: + password: + method: Plain + search_strategy: detect + user_groups: [] + admin_group: + virtual_attribute_enabled: false + recursive_group_search: false + posix_support: true + user_sync_emails: false + user_sync_keys: false + user_sync_interval: 4 + team_sync_interval: 4 + sync_enabled: false + reconciliation: + user: + org: + profile: + uid: uid + name: + mail: + key: + cas: + url: + saml: + sso_url: + certificate: + certificate_path: + issuer: + idp_initiated_sso: false + disable_admin_demote: false + github_oauth: + client_id: '12313412' + client_secret: kj123131132 + organization_name: Homestar Runners + organization_team: homestarrunners/characters + smtp: + enabled: true + address: smtp.example.com + authentication: plain + port: '1234' + domain: blah + username: foo + user_name: mr_foo + enable_starttls_auto: true + password: bar + discard-to-noreply-address: true + support_address: enterprise@github.com + support_address_type: email + noreply_address: noreply@github.com + ntp: + primary_server: 0.pool.ntp.org + secondary_server: 1.pool.ntp.org + timezone: + snmp: + enabled: false + community: '' + syslog: + enabled: false + server: + protocol_name: udp + assets: + pages: + enabled: true + collectd: + enabled: false + server: + port: 0 + encryption: + username: + password: + mapping: + enabled: true + tileserver: + basemap: company.map-qsz2zrvs + token: + load_balancer: + ghes-get-maintenance: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + status: scheduled + scheduled_time: '2006-01-02T15:04:05+00:00' + connection_services: + - name: git operations + number: 15 + - name: mysql queries + number: 6 + - name: resque jobs + number: 10 + - name: aqueduct jobs + number: 0 + can_unset_maintenance: true + ip_exception_list: + - 1.1.1.1 + maintenance_mode_message: Scheduled maintenance for upgrading. + ghes-set-maintenance: + value: + - hostname: ghe-local-primary + uuid: 1b6cf518-f97c-11ed-8544-061d81f7eedb + message: maintenance mode scheduled with exception list [1.1.1.1] + ghes-replication-status: + value: + status: OK + nodes: + - hostname: ghe-local-primary + status: OK + services: [] + - hostname: ghe-local-replica + status: OK + services: + - status: OK + name: redis + details: replication is in sync + - status: OK + name: elasticsearch + details: cluster is in sync (0 shards initializing, 0 shards unassigned) + - status: OK + name: git + details: replication is in sync + - status: OK + name: pages + details: replication is in sync + - status: OK + name: alambic + details: replication is in sync + - status: OK + name: git-hooks + details: replication is in sync + - status: OK + name: consul + details: replication is in sync + - status: OK + name: mysql + details: replication is in sync + ghes-version: + value: + - hostname: ghe-local-primary + version: + version: 3.9.0 + platform: azure + build_id: fc542058b5 + build_date: '2023-05-02' + api-overview: + value: + verifiable_password_authentication: true + packages: + - 192.0.2.1 + domains: + website: + - "*.example.com" + codespaces: + - "*.example.com" + copilot: + - "*.example.com" + packages: + - "*.example.com" + installed_version: 3.15.0 + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/rrubenich + 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: + 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: |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~~~~ + ~~~~~~==~==~~~==~==~~~~~~ + ~~~~~~==~==~==~==~~~~~~ + :~==~==~==~==~~ + 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-custom-repository-role-example: + value: + id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + 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' + 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 + 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_fork_private_repositories: false + web_commit_signoff_required: false + updated_at: '2014-03-03T18:58:10Z' + 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 + 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 + 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 + 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: + 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 + 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 + 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 + 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: + 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 + 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 + 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 + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: enabled + secret_scanning_delegated_bypass_options: + reviewers: + - security_configuration_id: 17 + reviewer_id: 5678 + reviewer_type: TEAM + secret_scanning_validity_checks: 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 + dependabot_alerts: enabled + dependabot_security_updates: enabled + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + 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: + 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 + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: 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 + 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-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 + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + 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: 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 + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: enabled + secret_scanning_push_protection: enabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + 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-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 + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: enabled + secret_scanning: disabled + secret_scanning_push_protection: disabled + secret_scanning_delegated_bypass: disabled + secret_scanning_validity_checks: disabled + secret_scanning_non_provider_patterns: 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 + organization-custom-repository-role-list-example: + value: + total_count: 2 + custom_roles: + - id: 8030 + name: Security Engineer + description: Able to contribute code and maintain the security pipeline + base_role: maintain + permissions: + - delete_alerts_code_scanning + 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: Community manager + description: Able to handle all the community interactions without being + able to contribute code + base_role: read + permissions: + - mark_as_duplicate + - manage_settings_pages + - manage_settings_wiki + - set_social_preview + - edit_repo_metadata + - toggle_discussion_comment_minimize + 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-05T12:01:11Z' + updated_at: '2022-07-05T12:20:11Z' + 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' + - id: '22249084964' + type: PushEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octo-org/octo-repo + url: https://api.github.com/repos/octo-org/oct-repo + payload: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octo-org/oct-repo/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + external-group: + value: + group_id: '123' + group_name: Octocat admins + updated_at: '2021-01-24T11:31:04-06:00' + teams: + - team_id: 1 + team_name: team-test + - team_id: 2 + team_name: team-test2 + members: + - member_id: 1 + member_login: mona-lisa_eocsaxrs + member_name: Mona Lisa + member_email: mona_lisa@github.com + - member_id: 2 + member_login: octo-lisa_eocsaxrs + member_name: Octo Lisa + member_email: octo_lisa@github.com + external-groups: + value: + groups: + - group_id: '123' + group_name: Octocat admins + updated_at: '2021-01-24T11:31:04-06:00' + - group_id: '456' + group_name: Octocat docs members + updated_at: '2021-03-24T11:31:04-06:00' + 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 + 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: + suspended_by: + 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: + suspended_by: + 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 + 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 + 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: + 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= + 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: + 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' + 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: + 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' + 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: + 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 + organization-fine-grained-permission-example: + value: + - name: read_organization_custom_org_role + description: View organization roles + - name: write_organization_custom_org_role + description: Manage custom organization roles + 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' + 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: + 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: + 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: + org-pre-receive-hook-items: + value: + - id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 + allow_downstream_configuration: true + org-pre-receive-hook: + value: + id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/admin/pre-receive-hooks/42 + allow_downstream_configuration: true + org-pre-receive-hook-2: + value: + id: 42 + name: Check Commits + enforcement: enabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + allow_downstream_configuration: false + project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: true + project-2: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + 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 + - 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: + 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 + repository-fine-grained-permission-example: + value: + - name: add_assignee + description: Assign or remove a user + - name: remove_assignee + description: Remove an assigned user + - name: add_label + description: Add or remove a label + 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 + 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 + 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 + 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 + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + team-discussion-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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion: + 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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 0 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Our first team post + updated_at: '2018-01-25T18:56:31Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-2: + 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 + body: Hi! This is an area for us to collaborate as a team. + body_html: "

Hi! This is an area for us to collaborate as a team

" + body_version: 0d495416a700fb06133c612575d92bfb + comments_count: 1 + comments_url: https://api.github.com/teams/2343027/discussions/1/comments + created_at: '2018-01-25T18:56:31Z' + last_edited_at: '2018-01-26T18:22:20Z' + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: 1 + pinned: false + private: false + team_url: https://api.github.com/teams/2343027 + title: Welcome to our first team post + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2343027/discussions/1 + reactions: + url: https://api.github.com/teams/2343027/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-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 + body: Do you like apples? + body_html: "

Do you like apples?

" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment: + 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 + body: Do you like apples? + body_html: "

Do you like apples?

" + body_version: 5eb32b219cdc6a5a9b29ba5d6caa9c51 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-15T23:53:58Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + team-discussion-comment-2: + 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 + body: Do you like pineapples? + body_html: "

Do you like pineapples?

" + body_version: e6907b24d9c93cc0c5024a7af5888116 + created_at: '2018-01-15T23:53:58Z' + last_edited_at: '2018-01-26T18:22:20Z' + discussion_url: https://api.github.com/teams/2403582/discussions/1 + html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: 1 + updated_at: '2018-01-26T18:22:20Z' + url: https://api.github.com/teams/2403582/discussions/1/comments/1 + reactions: + url: https://api.github.com/teams/2403582/discussions/1/reactions + total_count: 5 + "+1": 3 + "-1": 1 + laugh: 0 + confused: 0 + heart: 1 + hooray: 0 + eyes: 1 + rocket: 1 + 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' + 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-project-items: + value: + - owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + team-project: + value: + owner_url: https://api.github.com/orgs/octocat + url: https://api.github.com/projects/1002605 + html_url: https://github.com/orgs/api-playground/projects/1 + columns_url: https://api.github.com/projects/1002605/columns + id: 1002605 + node_id: MDc6UHJvamVjdDEwMDI2MDU= + name: Organization Roadmap + body: High-level roadmap for the upcoming year. + number: 1 + state: open + 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: '2011-04-11T20:09:31Z' + updated_at: '2014-03-04T18:58:10Z' + organization_permission: write + private: false + permissions: + read: true + write: true + admin: false + 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: + 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 + project-card: + value: + url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + 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: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-column: + value: + url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + project-card-items: + value: + - url: https://api.github.com/projects/columns/cards/1478 + id: 1478 + node_id: MDExOlByb2plY3RDYXJkMTQ3OA== + note: Add payload for delete Project column + 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: '2016-09-05T14:21:06Z' + updated_at: '2016-09-05T14:20:22Z' + archived: false + column_url: https://api.github.com/projects/columns/367 + content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: https://api.github.com/projects/120 + project-3: + value: + owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + project-collaborator-permission: + value: + permission: 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 + project-column-items: + value: + - url: https://api.github.com/projects/columns/367 + project_url: https://api.github.com/projects/120 + cards_url: https://api.github.com/projects/columns/367/cards + id: 367 + node_id: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: To Do + created_at: '2016-09-05T14:18:44Z' + updated_at: '2016-09-05T14:22:28Z' + 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: + 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 + 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' + 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' + 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' + 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-usage-policy: + value: + repo_cache_size_limit_in_gb: 14 + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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 + 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 + 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 + 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: + 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 + 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: + 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: + 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: + 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 + + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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: + 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 + 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 + fixed_at: + 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 + fixed_at: '2020-02-14T12:29:18Z' + 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: + 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: '' + 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: + version: 2.4.0 + deletable: true + warning: '' + code-scanning-analysis-sarif: + summary: application/json+sarif 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-default-setup: + value: + state: configured + languages: + - ruby + - python + query_suite: default + updated_at: '2023-01-19T11:21:34Z' + schedule: weekly + code-scanning-default-setup-update: + value: + state: configured + 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 + dependabot_alerts: enabled + dependabot_security_updates: not_set + code_scanning_default_setup: 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 + 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`? + + ***/*.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" + 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-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: + payload: + 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: + 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 + 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 + 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 @@ + ..... + 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: + 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 + 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 + 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 + 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 + 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: + 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: + _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: + _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: + _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 + 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 + file-commit: + value: + 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 + 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 + 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: + - 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: + 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 + 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: + 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: + 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: + 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: + 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: + - SPDXID: SPDXRef-Package + name: rubygems:rails + versionInfo: 1.0.0 + downloadLocation: NOASSERTION + filesAnalyzed: false + licenseConcluded: NOASSERTION + licenseDeclared: NOASSERTION + 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 + 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: trues + 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 + 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 + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '22237752260' + type: WatchEvent + actor: + id: 583231 + login: octocat + display_login: octocat + gravatar_id: '' + url: https://api.github.com/users/octocat + avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 + repo: + id: 1296269 + name: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + action: started + public: true + created_at: '2022-06-08T23:29:25Z' + minimal-repository-items-2: + value: + - id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World + full_name: octocat/Hello-World + owner: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/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== + 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 + 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 + 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 + 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: + status: unused + message: + 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: + status: unused + message: + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + single_file: 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 + 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: + label: + name: label + color: red + 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: + 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 + deploy-key-items: + value: + enabled: + - 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' + 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' + 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 + 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== + 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: + 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: + 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 + repository-pre-receive-hook-items: + value: + - id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + repository-pre-receive-hook: + value: + id: 42 + name: Check Commits + enforcement: disabled + configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42 + repository-pre-receive-hook-2: + value: + id: 42 + name: Check Commits + enforcement: enabled + configuration_url: https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42 + project-items-2: + value: + - owner_url: https://api.github.com/repos/api-playground/projects-test + url: https://api.github.com/projects/1002604 + html_url: https://github.com/api-playground/projects-test/projects/1 + columns_url: https://api.github.com/projects/1002604/columns + id: 1002604 + node_id: MDc6UHJvamVjdDEwMDI2MDQ= + name: Projects Documentation + body: Developer documentation project for the developer site. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + 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 + 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: + 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: + 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 + 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: + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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 + 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' + 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 + - number: 1 + created_at: '2020-11-06T18:18:30Z' + url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 + html_url: https://github.com/owner/repo/security/secret-scanning/1 + locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/1/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 + 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 + secret_type: mailchimp_api_key + secret_type_display_name: Mailchimp API Key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + push_protection_bypassed: false + validity: unknown + 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 + resolution_comment: Example comment + validity: unknown + 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 + 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: + 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: + 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= + tag-protection-items: + value: + - id: 2 + pattern: v1.* + tag-protection: + value: + enabled: true + topic: + value: + names: + - octocat + - atom + - electron + - api + 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: + 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 + 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 + scim-enterprise-group-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + id: 24b28bbb-5fc4-4686-a153-a020debb1155 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + resourceType: Group + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 + startIndex: 1 + itemsPerPage: 20 + scim-enterprise-group: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:Group + id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc + externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 + displayName: Engineering + members: + - value: 879db59-3bdf-4490-ad68-ab880a2694745 + "$+ref": https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745 + displayName: User 1 + - value: 0db508eb-91e2-46e4-809c-30dcbda0c685 + "$+ref": https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685 + displayName: User 2 + meta: + resourceType: Group + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 + scim-enterprise-user-list: + value: + schemas: + - urn:ietf:params:scim:api:messages:2.0:ListResponse + totalResults: 1 + Resources: + - schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + id: 7fce0092-d52e-4f76-b727-3955bd72c939 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + startIndex: 1 + itemsPerPage: 20 + in-user: + summary: User + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + in-user-owner: + summary: Enterprise Owner + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: Enterprise Owner + primary: false + scim-enterprise-user: + value: + schemas: + - urn:ietf:params:scim:schemas:core:2.0:User + id: 7fce0092-d52e-4f76-b727-3955bd72c939 + externalId: E012345 + active: true + userName: E012345 + name: + formatted: Ms. Mona Lisa Octocat + familyName: Octocat + givenName: Mona + middleName: Lisa + displayName: Mona Lisa + emails: + - value: mlisa@example.com + type: work + primary: true + roles: + - value: User + primary: false + meta: + resourceType: User + created: '2012-03-27T19:59:26.000Z' + lastModified: '2018-03-27T19:59:26.000Z' + location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939 + 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: + value: + total_count: 280 + incomplete_results: false + 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 + 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: + 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... + 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... + 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... + 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 + 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-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: + - email: mona@github.com + primary: false + verified: false + visibility: + 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: + 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: + 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 + 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 + 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 + 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 + 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 + 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: + 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= + 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: + 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' + 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 + project: + value: + owner_url: https://api.github.com/users/octocat + url: https://api.github.com/projects/1002603 + html_url: https://github.com/users/octocat/projects/1 + columns_url: https://api.github.com/projects/1002603/columns + id: 1002603 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + name: My Projects + body: A board to manage my personal projects. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + 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 + social-account-items: + value: + - provider: twitter + url: https://twitter.com/github + ssh-signing-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' + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + ssh-signing-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' + 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: + 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 + 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 + 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 + 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 + ldap_dn: uid=asdf,ou=users,dc=github,dc=com + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: 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: octocat/Hello-World + url: https://api.github.com/repos/octocat/Hello-World + payload: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: false + 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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-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 + project-items-3: + value: + - owner_url: https://api.github.com/users/octocat + url: https://api.github.com/projects/1002603 + html_url: https://github.com/users/octocat/projects/1 + columns_url: https://api.github.com/projects/1002603/columns + id: 1002603 + node_id: MDc6UHJvamVjdDEwMDI2MDM= + name: My Projects + body: A board to manage my personal projects. + number: 1 + state: open + 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: '2011-04-10T20:09:31Z' + updated_at: '2014-03-03T18:58:10Z' + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + avatar_url: https://avatars.githubusercontent.com/u/9919? + 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: + push_id: 10115855396 + size: 1 + distinct_size: 1 + ref: refs/heads/master + head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + before: 883efe034920928c47fe18598c01249d1a9fdabd + commits: + - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + author: + email: octocat@github.com + name: Monalisa Octocat + message: commit + distinct: true + url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 + public: true + created_at: '2022-06-09T12:47:28Z' + - id: '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: + ref_type: repository + master_branch: master + description: + pusher_type: user + public: false + created_at: '2022-06-07T07:50:26Z' + org: + id: 9919 + login: github + gravatar_id: '' + url: https://api.github.com/orgs/github + avatar_url: https://avatars.githubusercontent.com/u/9919? + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + team_discussions: 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 + team_discussions: 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 + 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: + 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 + 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 + secret_type: mailchimp_api_key + secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 + 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 + 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: + 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/enterprise-server@3.15/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/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 1 + 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 + direction: + name: direction + description: The direction to sort the results by. + in: query + required: false + schema: + type: string + enum: + - asc + - desc + default: desc + key-ids: + name: key_ids + description: The unique identifier of the key. + 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 + 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 + pre-receive-environment-id: + name: pre_receive_environment_id + description: The unique identifier of the pre-receive environment. + in: path + required: true + schema: + type: integer + pre-receive-hook-id: + name: pre_receive_hook_id + description: The unique identifier of the pre-receive hook. + in: path + required: true + schema: + type: integer + token-id: + name: token_id + description: The unique identifier of the token. + in: path + required: true + schema: + type: integer + pagination-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + required: false + schema: + type: string + ghsa_id: + name: ghsa_id + description: The GHSA (GitHub Security Advisory) identifier of the advisory. + in: path + required: true + schema: + type: string + 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 + delivery-id: + name: delivery_id + in: path + required: true + schema: + type: integer + 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 + grant-id: + name: grant_id + description: The unique identifier of the grant. + in: path + required: true + schema: + type: integer + 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 + oauth-client-id: + name: client_id + in: path + required: true + description: The client ID of the OAuth app. + schema: + type: string + examples: + default: + value: abcde12345fghij67890 + authorization-id: + name: authorization_id + description: The unique identifier of the authorization. + in: path + required: true + schema: + type: integer + enterprise: + name: enterprise + description: The slug version of the enterprise name. You can also substitute + this value with the enterprise id. + in: path + required: true + schema: + type: string + org-id: + name: org_id + description: The unique identifier of the organization. + in: path + required: true + schema: + type: integer + visible-to-organization: + name: visible_to_organization + description: Only return runner groups that are allowed to be used by this organization. + 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 + audit-log-enterprise-phrase: + name: phrase + description: A search phrase. For more information, see [Searching the audit + log](https://docs.github.com/enterprise-server@3.15/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/searching-the-audit-log-for-your-enterprise#searching-the-audit-log). + in: query + required: false + schema: + type: string + audit-log-include: + name: include + description: |- + The event types to include: + + - `web` - returns web (non-Git) events. + - `git` - returns Git events. + - `all` - returns both web and Git events. + + The default is `web`. + in: query + required: false + schema: + type: string + enum: + - web + - git + - all + audit-log-after: + name: after + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events after this cursor. + in: query + required: false + schema: + type: string + audit-log-before: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/rest/guides/using-pagination-in-the-rest-api#using-link-headers). + If specified, the query only searches for events before this cursor. + in: query + required: false + schema: + type: string + audit-log-order: + name: order + description: |- + The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. + + The default is `desc`. + in: query + required: false + schema: + type: string + enum: + - desc + - asc + 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-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-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. + schema: + type: string + enum: + - created + - updated + default: created + pagination-first: + name: first + description: |- + **Deprecated**. The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + Instead, use `per_page` in combination with `after` to fetch the first page of results. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + pagination-last: + name: last + description: |- + **Deprecated**. The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + Instead, use `per_page` in combination with `before` to fetch the last page of results. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + 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 experimental patterns, pass the token name(s) + in the parameter. See "[Supported secret scanning patterns](https://docs.github.com/enterprise-server@3.15/enterprise-cloud@latest/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-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-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-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 + enterprise-security-product: + name: security_product + in: path + description: The security feature to enable or disable. + required: true + schema: + type: string + enum: + - advanced_security + - advanced_security_user_namespace + - dependabot_alerts + - secret_scanning + - secret_scanning_push_protection + - secret_scanning_non_provider_patterns + enterprise-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 enterprise. + `disable_all` means to disable the specified security feature for all repositories in the enterprise. + required: true + schema: + type: string + enum: + - enable_all + - disable_all + 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 + license-apply: + name: apply + description: Whether to instantly apply changes from the license. Otherwise + the new license can be applied using the [`/manage/v1/config/apply`](https://docs.github.com/enterprise-server@3.15/rest/enterprise-admin/manage-ghes#start-configuration-apply-process) + endpoint. + in: query + required: false + schema: + type: boolean + uuid: + name: uuid + description: The UUID which identifies a node. + in: query + required: false + schema: + type: string + cluster-roles: + name: cluster_roles + description: The cluster roles from the cluster configuration file. + in: query + required: false + 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 + 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/enterprise-server@3.15/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 + 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 + 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/enterprise-server@3.15/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 + audit-log-phrase: + name: phrase + description: A search phrase. For more information, see [Searching the audit + log](https://docs.github.com/enterprise-server@3.15/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization#searching-the-audit-log). + 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 + role-id: + name: role_id + description: The unique identifier of the role. + in: path + required: true + schema: + type: integer + group-id: + name: group_id + description: The unique identifier of the group. + in: path + required: true + schema: + type: integer + members-per-page: + name: per_page + description: The number of results per page for the "members" array (max 100). + For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/rest/using-the-rest-api/using-pagination-in-the-rest-api)." + in: query + schema: + type: integer + default: 30 + members-page: + name: page + description: The page number of the "members" array results to fetch. For more + information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.15/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 + team-slug: + name: team_slug + description: The slug of the team name. + 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/enterprise-server@3.15/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 + examples: + - 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 + examples: + - Hello-World + personal-access-token-permission: + name: permission + description: The permission to use to filter the results. + in: query + required: false + schema: + type: string + examples: + - 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 + 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 + 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 + examples: + - 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 insights 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 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/enterprise-server@3.15/rest/repos/rule-suites#list-repository-rule-suites) + for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-server@3.15/rest/orgs/rule-suites#list-organization-rule-suites) + for organizations. + in: path + required: true + schema: + type: integer + secret-scanning-pagination-before-org-repo: + name: before + description: A cursor, as given in the [Link header](https://docs.github.com/enterprise-server@3.15/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/enterprise-server@3.15/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 + discussion-number: + name: discussion_number + description: The number that identifies the discussion. + in: path + required: true + schema: + type: integer + comment-number: + name: comment_number + description: The number that identifies the comment. + in: path + required: true + schema: + type: integer + reaction-id: + name: reaction_id + description: The unique identifier of the reaction. + in: path + required: true + schema: + type: integer + project-id: + name: project_id + description: The unique identifier of the project. + 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 + card-id: + name: card_id + description: The unique identifier of the card. + in: path + required: true + schema: + type: integer + column-id: + name: column_id + description: The unique identifier of the column. + in: path + required: true + schema: + type: integer + 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/enterprise-server@3.15/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/enterprise-server@3.15/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/enterprise-server@3.15/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" + 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" + 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. + 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" + 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 + invitation-id: + name: invitation_id + description: The unique identifier of the invitation. + 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 + 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 + tag-protection-id: + name: tag_protection_id + description: The unique identifier of the tag protection. + in: path + required: true + schema: + type: integer + 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 + excluded-attributes: + name: excludedAttributes + description: Excludes the specified attribute from being returned in the results. + Using this parameter can speed up response time. + in: query + required: false + schema: + type: string + examples: + - members + start-index: + name: startIndex + description: 'Used for pagination: the starting index of the first result to + return when paginating through values.' + in: query + required: false + schema: + type: integer + default: 1 + format: int32 + examples: + - 1 + count: + name: count + description: 'Used for pagination: the number of results to return per page.' + in: query + required: false + schema: + type: integer + default: 30 + format: int32 + examples: + - 1 + scim-group-id: + name: scim_group_id + description: A unique identifier of the SCIM group. + in: path + required: true + schema: + type: string + examples: + - 7fce0092-d52e-4f76-b727-3955bd72c939 + scim-user-id: + name: scim_user_id + description: The unique identifier of the SCIM user. + in: path + required: true + schema: + type: string + 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 + 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 + 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 + 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 + 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: + 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" + gone: + description: Gone + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-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" + 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" + 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 + - 'null' + message: + type: string + documentation_url: + type: string + moved_permanently: + description: Moved permanently + 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. + package_es_list_error: + description: The value of `per_page` multiplied by `page` cannot be greater + than 10000. + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + temporary_redirect: + description: Temporary Redirect + 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_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" + found: + description: Found + dependency_review_forbidden: + description: Response if GitHub Advanced Security is not enabled for this repository + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + unacceptable: + description: Unacceptable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + scim_bad_request: + description: Bad request + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + authorization_failure: + description: Authorization failure + permission_denied: + description: Permission denied + scim_too_many_requests: + description: Too many requests + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + scim_internal_error: + description: Internal server error + content: + application/json: + schema: + "$ref": "#/components/schemas/scim-error" + application/scim+json: + schema: + "$ref": "#/components/schemas/scim-error" + duplicate_record_detected: + description: Duplicate record detected