@octokit/openapi 13.0.0 → 13.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/api.github.com.deref.json +5235 -766
- package/generated/api.github.com.json +1925 -135
- package/generated/ghec.deref.json +8357 -536
- package/generated/ghec.json +3039 -825
- package/generated/ghes-3.10.deref.json +153 -133
- package/generated/ghes-3.10.json +116 -103
- package/generated/ghes-3.7.deref.json +136 -105
- package/generated/ghes-3.7.json +99 -76
- package/generated/ghes-3.8.deref.json +148 -125
- package/generated/ghes-3.8.json +111 -96
- package/generated/ghes-3.9.deref.json +151 -128
- package/generated/ghes-3.9.json +114 -99
- package/generated/github.ae.deref.json +327 -112
- package/generated/github.ae.json +204 -74
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "13.
|
|
4
|
+
"version": "13.2.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": {
|
|
@@ -741,7 +741,7 @@
|
|
|
741
741
|
"parameters": [
|
|
742
742
|
{
|
|
743
743
|
"name": "hook_id",
|
|
744
|
-
"description": "The unique identifier of the hook.",
|
|
744
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
745
745
|
"in": "path",
|
|
746
746
|
"required": true,
|
|
747
747
|
"schema": {
|
|
@@ -856,7 +856,7 @@
|
|
|
856
856
|
"parameters": [
|
|
857
857
|
{
|
|
858
858
|
"name": "hook_id",
|
|
859
|
-
"description": "The unique identifier of the hook.",
|
|
859
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
860
860
|
"in": "path",
|
|
861
861
|
"required": true,
|
|
862
862
|
"schema": {
|
|
@@ -1027,7 +1027,7 @@
|
|
|
1027
1027
|
"parameters": [
|
|
1028
1028
|
{
|
|
1029
1029
|
"name": "hook_id",
|
|
1030
|
-
"description": "The unique identifier of the hook.",
|
|
1030
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
1031
1031
|
"in": "path",
|
|
1032
1032
|
"required": true,
|
|
1033
1033
|
"schema": {
|
|
@@ -1064,7 +1064,7 @@
|
|
|
1064
1064
|
"parameters": [
|
|
1065
1065
|
{
|
|
1066
1066
|
"name": "hook_id",
|
|
1067
|
-
"description": "The unique identifier of the hook.",
|
|
1067
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
1068
1068
|
"in": "path",
|
|
1069
1069
|
"required": true,
|
|
1070
1070
|
"schema": {
|
|
@@ -17837,7 +17837,7 @@
|
|
|
17837
17837
|
},
|
|
17838
17838
|
"post": {
|
|
17839
17839
|
"summary": "Create a new authorization",
|
|
17840
|
-
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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.7/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.7/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).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#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.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo 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.\n\nYou 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.7/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed.
|
|
17840
|
+
"description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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.7/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/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/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.7/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).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#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.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo 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.\n\nYou 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.7/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations 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.7/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.",
|
|
17841
17841
|
"tags": [
|
|
17842
17842
|
"oauth-authorizations"
|
|
17843
17843
|
],
|
|
@@ -80089,7 +80089,7 @@
|
|
|
80089
80089
|
},
|
|
80090
80090
|
{
|
|
80091
80091
|
"name": "hook_id",
|
|
80092
|
-
"description": "The unique identifier of the hook.",
|
|
80092
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
80093
80093
|
"in": "path",
|
|
80094
80094
|
"required": true,
|
|
80095
80095
|
"schema": {
|
|
@@ -80276,7 +80276,7 @@
|
|
|
80276
80276
|
},
|
|
80277
80277
|
{
|
|
80278
80278
|
"name": "hook_id",
|
|
80279
|
-
"description": "The unique identifier of the hook.",
|
|
80279
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
80280
80280
|
"in": "path",
|
|
80281
80281
|
"required": true,
|
|
80282
80282
|
"schema": {
|
|
@@ -80609,7 +80609,7 @@
|
|
|
80609
80609
|
},
|
|
80610
80610
|
{
|
|
80611
80611
|
"name": "hook_id",
|
|
80612
|
-
"description": "The unique identifier of the hook.",
|
|
80612
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
80613
80613
|
"in": "path",
|
|
80614
80614
|
"required": true,
|
|
80615
80615
|
"schema": {
|
|
@@ -80681,7 +80681,7 @@
|
|
|
80681
80681
|
},
|
|
80682
80682
|
{
|
|
80683
80683
|
"name": "hook_id",
|
|
80684
|
-
"description": "The unique identifier of the hook.",
|
|
80684
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
80685
80685
|
"in": "path",
|
|
80686
80686
|
"required": true,
|
|
80687
80687
|
"schema": {
|
|
@@ -80774,7 +80774,7 @@
|
|
|
80774
80774
|
},
|
|
80775
80775
|
{
|
|
80776
80776
|
"name": "hook_id",
|
|
80777
|
-
"description": "The unique identifier of the hook.",
|
|
80777
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
80778
80778
|
"in": "path",
|
|
80779
80779
|
"required": true,
|
|
80780
80780
|
"schema": {
|
|
@@ -80920,7 +80920,7 @@
|
|
|
80920
80920
|
},
|
|
80921
80921
|
{
|
|
80922
80922
|
"name": "hook_id",
|
|
80923
|
-
"description": "The unique identifier of the hook.",
|
|
80923
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
80924
80924
|
"in": "path",
|
|
80925
80925
|
"required": true,
|
|
80926
80926
|
"schema": {
|
|
@@ -81239,7 +81239,7 @@
|
|
|
81239
81239
|
},
|
|
81240
81240
|
{
|
|
81241
81241
|
"name": "hook_id",
|
|
81242
|
-
"description": "The unique identifier of the hook.",
|
|
81242
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
81243
81243
|
"in": "path",
|
|
81244
81244
|
"required": true,
|
|
81245
81245
|
"schema": {
|
|
@@ -81601,7 +81601,7 @@
|
|
|
81601
81601
|
},
|
|
81602
81602
|
{
|
|
81603
81603
|
"name": "hook_id",
|
|
81604
|
-
"description": "The unique identifier of the hook.",
|
|
81604
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
81605
81605
|
"in": "path",
|
|
81606
81606
|
"required": true,
|
|
81607
81607
|
"schema": {
|
|
@@ -81796,7 +81796,7 @@
|
|
|
81796
81796
|
},
|
|
81797
81797
|
{
|
|
81798
81798
|
"name": "hook_id",
|
|
81799
|
-
"description": "The unique identifier of the hook.",
|
|
81799
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
81800
81800
|
"in": "path",
|
|
81801
81801
|
"required": true,
|
|
81802
81802
|
"schema": {
|
|
@@ -89484,7 +89484,7 @@
|
|
|
89484
89484
|
},
|
|
89485
89485
|
"exclude": {
|
|
89486
89486
|
"type": "array",
|
|
89487
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
89487
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
89488
89488
|
"items": {
|
|
89489
89489
|
"type": "string",
|
|
89490
89490
|
"enum": [
|
|
@@ -122972,7 +122972,6 @@
|
|
|
122972
122972
|
"forks",
|
|
122973
122973
|
"forks_count",
|
|
122974
122974
|
"git_url",
|
|
122975
|
-
"has_downloads",
|
|
122976
122975
|
"has_issues",
|
|
122977
122976
|
"has_projects",
|
|
122978
122977
|
"has_wiki",
|
|
@@ -123074,7 +123073,6 @@
|
|
|
123074
123073
|
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
|
|
123075
123074
|
"svn_url": "https://svn.github.com/octocat/Hello-World",
|
|
123076
123075
|
"homepage": "https://github.com",
|
|
123077
|
-
"language": null,
|
|
123078
123076
|
"forks_count": 9,
|
|
123079
123077
|
"forks": 9,
|
|
123080
123078
|
"stargazers_count": 80,
|
|
@@ -123459,7 +123457,6 @@
|
|
|
123459
123457
|
"hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks",
|
|
123460
123458
|
"svn_url": "https://svn.github.com/octocat/Hello-World",
|
|
123461
123459
|
"homepage": "https://github.com",
|
|
123462
|
-
"language": null,
|
|
123463
123460
|
"forks_count": 9,
|
|
123464
123461
|
"stargazers_count": 80,
|
|
123465
123462
|
"watchers_count": 80,
|
|
@@ -128293,7 +128290,6 @@
|
|
|
128293
128290
|
"forks",
|
|
128294
128291
|
"forks_count",
|
|
128295
128292
|
"git_url",
|
|
128296
|
-
"has_downloads",
|
|
128297
128293
|
"has_issues",
|
|
128298
128294
|
"has_projects",
|
|
128299
128295
|
"has_wiki",
|
|
@@ -130393,7 +130389,8 @@
|
|
|
130393
130389
|
"enum": [
|
|
130394
130390
|
"queued",
|
|
130395
130391
|
"in_progress",
|
|
130396
|
-
"completed"
|
|
130392
|
+
"completed",
|
|
130393
|
+
"waiting"
|
|
130397
130394
|
]
|
|
130398
130395
|
},
|
|
130399
130396
|
"conclusion": {
|
|
@@ -130556,7 +130553,7 @@
|
|
|
130556
130553
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
130557
130554
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
130558
130555
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
130559
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
130556
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
130560
130557
|
"status": "completed",
|
|
130561
130558
|
"conclusion": "success",
|
|
130562
130559
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -130736,7 +130733,7 @@
|
|
|
130736
130733
|
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
|
|
130737
130734
|
"post": {
|
|
130738
130735
|
"summary": "Re-run a job from a workflow run",
|
|
130739
|
-
"description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
130736
|
+
"description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
130740
130737
|
"tags": [
|
|
130741
130738
|
"actions"
|
|
130742
130739
|
],
|
|
@@ -131878,7 +131875,7 @@
|
|
|
131878
131875
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
131879
131876
|
"get": {
|
|
131880
131877
|
"summary": "List self-hosted runners for a repository",
|
|
131881
|
-
"description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
131878
|
+
"description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
131882
131879
|
"tags": [
|
|
131883
131880
|
"actions"
|
|
131884
131881
|
],
|
|
@@ -132103,7 +132100,7 @@
|
|
|
132103
132100
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
132104
132101
|
"get": {
|
|
132105
132102
|
"summary": "List runner applications for a repository",
|
|
132106
|
-
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
132103
|
+
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
132107
132104
|
"tags": [
|
|
132108
132105
|
"actions"
|
|
132109
132106
|
],
|
|
@@ -132234,7 +132231,7 @@
|
|
|
132234
132231
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
132235
132232
|
"post": {
|
|
132236
132233
|
"summary": "Create a registration token for a repository",
|
|
132237
|
-
"description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
132234
|
+
"description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```",
|
|
132238
132235
|
"tags": [
|
|
132239
132236
|
"actions"
|
|
132240
132237
|
],
|
|
@@ -133540,7 +133537,7 @@
|
|
|
133540
133537
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
133541
133538
|
"post": {
|
|
133542
133539
|
"summary": "Create a remove token for a repository",
|
|
133543
|
-
"description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
133540
|
+
"description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```",
|
|
133544
133541
|
"tags": [
|
|
133545
133542
|
"actions"
|
|
133546
133543
|
],
|
|
@@ -134846,7 +134843,7 @@
|
|
|
134846
134843
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
134847
134844
|
"get": {
|
|
134848
134845
|
"summary": "Get a self-hosted runner for a repository",
|
|
134849
|
-
"description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
134846
|
+
"description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
134850
134847
|
"tags": [
|
|
134851
134848
|
"actions"
|
|
134852
134849
|
],
|
|
@@ -135008,7 +135005,7 @@
|
|
|
135008
135005
|
},
|
|
135009
135006
|
"delete": {
|
|
135010
135007
|
"summary": "Delete a self-hosted runner from a repository",
|
|
135011
|
-
"description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
135008
|
+
"description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
135012
135009
|
"tags": [
|
|
135013
135010
|
"actions"
|
|
135014
135011
|
],
|
|
@@ -135063,7 +135060,7 @@
|
|
|
135063
135060
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
|
|
135064
135061
|
"get": {
|
|
135065
135062
|
"summary": "List labels for a self-hosted runner for a repository",
|
|
135066
|
-
"description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
135063
|
+
"description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
135067
135064
|
"tags": [
|
|
135068
135065
|
"actions"
|
|
135069
135066
|
],
|
|
@@ -135216,7 +135213,7 @@
|
|
|
135216
135213
|
},
|
|
135217
135214
|
"post": {
|
|
135218
135215
|
"summary": "Add custom labels to a self-hosted runner for a repository",
|
|
135219
|
-
"description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
135216
|
+
"description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
135220
135217
|
"tags": [
|
|
135221
135218
|
"actions"
|
|
135222
135219
|
],
|
|
@@ -135433,7 +135430,7 @@
|
|
|
135433
135430
|
},
|
|
135434
135431
|
"put": {
|
|
135435
135432
|
"summary": "Set custom labels for a self-hosted runner for a repository",
|
|
135436
|
-
"description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
135433
|
+
"description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
135437
135434
|
"tags": [
|
|
135438
135435
|
"actions"
|
|
135439
135436
|
],
|
|
@@ -135650,7 +135647,7 @@
|
|
|
135650
135647
|
},
|
|
135651
135648
|
"delete": {
|
|
135652
135649
|
"summary": "Remove all custom labels from a self-hosted runner for a repository",
|
|
135653
|
-
"description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
135650
|
+
"description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
135654
135651
|
"tags": [
|
|
135655
135652
|
"actions"
|
|
135656
135653
|
],
|
|
@@ -135800,7 +135797,7 @@
|
|
|
135800
135797
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
|
|
135801
135798
|
"delete": {
|
|
135802
135799
|
"summary": "Remove a custom label from a self-hosted runner for a repository",
|
|
135803
|
-
"description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
135800
|
+
"description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.",
|
|
135804
135801
|
"tags": [
|
|
135805
135802
|
"actions"
|
|
135806
135803
|
],
|
|
@@ -143035,7 +143032,8 @@
|
|
|
143035
143032
|
"enum": [
|
|
143036
143033
|
"queued",
|
|
143037
143034
|
"in_progress",
|
|
143038
|
-
"completed"
|
|
143035
|
+
"completed",
|
|
143036
|
+
"waiting"
|
|
143039
143037
|
]
|
|
143040
143038
|
},
|
|
143041
143039
|
"conclusion": {
|
|
@@ -143204,7 +143202,7 @@
|
|
|
143204
143202
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
143205
143203
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
143206
143204
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
143207
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
143205
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
143208
143206
|
"status": "completed",
|
|
143209
143207
|
"conclusion": "success",
|
|
143210
143208
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -143429,7 +143427,7 @@
|
|
|
143429
143427
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
143430
143428
|
"post": {
|
|
143431
143429
|
"summary": "Cancel a workflow run",
|
|
143432
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
143430
|
+
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
143433
143431
|
"tags": [
|
|
143434
143432
|
"actions"
|
|
143435
143433
|
],
|
|
@@ -143662,7 +143660,8 @@
|
|
|
143662
143660
|
"enum": [
|
|
143663
143661
|
"queued",
|
|
143664
143662
|
"in_progress",
|
|
143665
|
-
"completed"
|
|
143663
|
+
"completed",
|
|
143664
|
+
"waiting"
|
|
143666
143665
|
]
|
|
143667
143666
|
},
|
|
143668
143667
|
"conclusion": {
|
|
@@ -143831,7 +143830,7 @@
|
|
|
143831
143830
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
143832
143831
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
143833
143832
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
143834
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
143833
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
143835
143834
|
"status": "completed",
|
|
143836
143835
|
"conclusion": "success",
|
|
143837
143836
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -171697,7 +171696,7 @@
|
|
|
171697
171696
|
},
|
|
171698
171697
|
"patch": {
|
|
171699
171698
|
"summary": "Update a check run",
|
|
171700
|
-
"description": "**Note:** The
|
|
171699
|
+
"description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**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.",
|
|
171701
171700
|
"tags": [
|
|
171702
171701
|
"checks"
|
|
171703
171702
|
],
|
|
@@ -178560,7 +178559,7 @@
|
|
|
178560
178559
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
178561
178560
|
"get": {
|
|
178562
178561
|
"summary": "List check runs in a check suite",
|
|
178563
|
-
"description": "
|
|
178562
|
+
"description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**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.",
|
|
178564
178563
|
"tags": [
|
|
178565
178564
|
"checks"
|
|
178566
178565
|
],
|
|
@@ -193836,7 +193835,7 @@
|
|
|
193836
193835
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
193837
193836
|
"get": {
|
|
193838
193837
|
"summary": "List check runs for a Git reference",
|
|
193839
|
-
"description": "**Note:** The
|
|
193838
|
+
"description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**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.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.7/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.7/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
|
|
193840
193839
|
"tags": [
|
|
193841
193840
|
"checks"
|
|
193842
193841
|
],
|
|
@@ -194893,7 +194892,7 @@
|
|
|
194893
194892
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
194894
194893
|
"get": {
|
|
194895
194894
|
"summary": "List check suites for a Git reference",
|
|
194896
|
-
"description": "
|
|
194895
|
+
"description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**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`.",
|
|
194897
194896
|
"tags": [
|
|
194898
194897
|
"checks"
|
|
194899
194898
|
],
|
|
@@ -209226,11 +209225,11 @@
|
|
|
209226
209225
|
"content": {
|
|
209227
209226
|
"application/json": {
|
|
209228
209227
|
"schema": {
|
|
209229
|
-
"title": "Deployment branch policy name pattern",
|
|
209228
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
209230
209229
|
"type": "object",
|
|
209231
209230
|
"properties": {
|
|
209232
209231
|
"name": {
|
|
209233
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
|
|
209232
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
|
|
209234
209233
|
"type": "string",
|
|
209235
209234
|
"example": "release/*"
|
|
209236
209235
|
}
|
|
@@ -209320,7 +209319,7 @@
|
|
|
209320
209319
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
209321
209320
|
"get": {
|
|
209322
209321
|
"summary": "Get a deployment branch policy",
|
|
209323
|
-
"description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `
|
|
209322
|
+
"description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint.",
|
|
209324
209323
|
"tags": [
|
|
209325
209324
|
"repos"
|
|
209326
209325
|
],
|
|
@@ -218205,7 +218204,6 @@
|
|
|
218205
218204
|
"forks",
|
|
218206
218205
|
"forks_count",
|
|
218207
218206
|
"git_url",
|
|
218208
|
-
"has_downloads",
|
|
218209
218207
|
"has_issues",
|
|
218210
218208
|
"has_projects",
|
|
218211
218209
|
"has_wiki",
|
|
@@ -222264,7 +222262,7 @@
|
|
|
222264
222262
|
"operationId": "repos/list-webhooks",
|
|
222265
222263
|
"externalDocs": {
|
|
222266
222264
|
"description": "API method documentation",
|
|
222267
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
222265
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#list-repository-webhooks"
|
|
222268
222266
|
},
|
|
222269
222267
|
"parameters": [
|
|
222270
222268
|
{
|
|
@@ -222545,8 +222543,8 @@
|
|
|
222545
222543
|
"x-github": {
|
|
222546
222544
|
"githubCloudOnly": false,
|
|
222547
222545
|
"enabledForGitHubApps": true,
|
|
222548
|
-
"category": "
|
|
222549
|
-
"subcategory": "
|
|
222546
|
+
"category": "repos",
|
|
222547
|
+
"subcategory": "webhooks"
|
|
222550
222548
|
},
|
|
222551
222549
|
"x-octokit": {}
|
|
222552
222550
|
},
|
|
@@ -222559,7 +222557,7 @@
|
|
|
222559
222557
|
"operationId": "repos/create-webhook",
|
|
222560
222558
|
"externalDocs": {
|
|
222561
222559
|
"description": "API method documentation",
|
|
222562
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
222560
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#create-a-repository-webhook"
|
|
222563
222561
|
},
|
|
222564
222562
|
"parameters": [
|
|
222565
222563
|
{
|
|
@@ -223004,8 +223002,8 @@
|
|
|
223004
223002
|
"x-github": {
|
|
223005
223003
|
"githubCloudOnly": false,
|
|
223006
223004
|
"enabledForGitHubApps": true,
|
|
223007
|
-
"category": "
|
|
223008
|
-
"subcategory": "
|
|
223005
|
+
"category": "repos",
|
|
223006
|
+
"subcategory": "webhooks"
|
|
223009
223007
|
},
|
|
223010
223008
|
"x-octokit": {}
|
|
223011
223009
|
}
|
|
@@ -223020,7 +223018,7 @@
|
|
|
223020
223018
|
"operationId": "repos/get-webhook",
|
|
223021
223019
|
"externalDocs": {
|
|
223022
223020
|
"description": "API method documentation",
|
|
223023
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
223021
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#get-a-repository-webhook"
|
|
223024
223022
|
},
|
|
223025
223023
|
"parameters": [
|
|
223026
223024
|
{
|
|
@@ -223043,7 +223041,7 @@
|
|
|
223043
223041
|
},
|
|
223044
223042
|
{
|
|
223045
223043
|
"name": "hook_id",
|
|
223046
|
-
"description": "The unique identifier of the hook.",
|
|
223044
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223047
223045
|
"in": "path",
|
|
223048
223046
|
"required": true,
|
|
223049
223047
|
"schema": {
|
|
@@ -223279,8 +223277,8 @@
|
|
|
223279
223277
|
"x-github": {
|
|
223280
223278
|
"githubCloudOnly": false,
|
|
223281
223279
|
"enabledForGitHubApps": true,
|
|
223282
|
-
"category": "
|
|
223283
|
-
"subcategory": "
|
|
223280
|
+
"category": "repos",
|
|
223281
|
+
"subcategory": "webhooks"
|
|
223284
223282
|
},
|
|
223285
223283
|
"x-octokit": {}
|
|
223286
223284
|
},
|
|
@@ -223293,7 +223291,7 @@
|
|
|
223293
223291
|
"operationId": "repos/update-webhook",
|
|
223294
223292
|
"externalDocs": {
|
|
223295
223293
|
"description": "API method documentation",
|
|
223296
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
223294
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#update-a-repository-webhook"
|
|
223297
223295
|
},
|
|
223298
223296
|
"parameters": [
|
|
223299
223297
|
{
|
|
@@ -223316,7 +223314,7 @@
|
|
|
223316
223314
|
},
|
|
223317
223315
|
{
|
|
223318
223316
|
"name": "hook_id",
|
|
223319
|
-
"description": "The unique identifier of the hook.",
|
|
223317
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223320
223318
|
"in": "path",
|
|
223321
223319
|
"required": true,
|
|
223322
223320
|
"schema": {
|
|
@@ -223717,8 +223715,8 @@
|
|
|
223717
223715
|
"x-github": {
|
|
223718
223716
|
"githubCloudOnly": false,
|
|
223719
223717
|
"enabledForGitHubApps": true,
|
|
223720
|
-
"category": "
|
|
223721
|
-
"subcategory": "
|
|
223718
|
+
"category": "repos",
|
|
223719
|
+
"subcategory": "webhooks"
|
|
223722
223720
|
},
|
|
223723
223721
|
"x-octokit": {}
|
|
223724
223722
|
},
|
|
@@ -223731,7 +223729,7 @@
|
|
|
223731
223729
|
"operationId": "repos/delete-webhook",
|
|
223732
223730
|
"externalDocs": {
|
|
223733
223731
|
"description": "API method documentation",
|
|
223734
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
223732
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#delete-a-repository-webhook"
|
|
223735
223733
|
},
|
|
223736
223734
|
"parameters": [
|
|
223737
223735
|
{
|
|
@@ -223754,7 +223752,7 @@
|
|
|
223754
223752
|
},
|
|
223755
223753
|
{
|
|
223756
223754
|
"name": "hook_id",
|
|
223757
|
-
"description": "The unique identifier of the hook.",
|
|
223755
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223758
223756
|
"in": "path",
|
|
223759
223757
|
"required": true,
|
|
223760
223758
|
"schema": {
|
|
@@ -223796,8 +223794,8 @@
|
|
|
223796
223794
|
"x-github": {
|
|
223797
223795
|
"githubCloudOnly": false,
|
|
223798
223796
|
"enabledForGitHubApps": true,
|
|
223799
|
-
"category": "
|
|
223800
|
-
"subcategory": "
|
|
223797
|
+
"category": "repos",
|
|
223798
|
+
"subcategory": "webhooks"
|
|
223801
223799
|
},
|
|
223802
223800
|
"x-octokit": {}
|
|
223803
223801
|
}
|
|
@@ -223812,7 +223810,7 @@
|
|
|
223812
223810
|
"operationId": "repos/get-webhook-config-for-repo",
|
|
223813
223811
|
"externalDocs": {
|
|
223814
223812
|
"description": "API method documentation",
|
|
223815
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
223813
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
|
|
223816
223814
|
},
|
|
223817
223815
|
"parameters": [
|
|
223818
223816
|
{
|
|
@@ -223835,7 +223833,7 @@
|
|
|
223835
223833
|
},
|
|
223836
223834
|
{
|
|
223837
223835
|
"name": "hook_id",
|
|
223838
|
-
"description": "The unique identifier of the hook.",
|
|
223836
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223839
223837
|
"in": "path",
|
|
223840
223838
|
"required": true,
|
|
223841
223839
|
"schema": {
|
|
@@ -223900,8 +223898,8 @@
|
|
|
223900
223898
|
"x-github": {
|
|
223901
223899
|
"githubCloudOnly": false,
|
|
223902
223900
|
"enabledForGitHubApps": true,
|
|
223903
|
-
"category": "
|
|
223904
|
-
"subcategory": "
|
|
223901
|
+
"category": "repos",
|
|
223902
|
+
"subcategory": "webhooks"
|
|
223905
223903
|
},
|
|
223906
223904
|
"x-octokit": {}
|
|
223907
223905
|
},
|
|
@@ -223914,7 +223912,7 @@
|
|
|
223914
223912
|
"operationId": "repos/update-webhook-config-for-repo",
|
|
223915
223913
|
"externalDocs": {
|
|
223916
223914
|
"description": "API method documentation",
|
|
223917
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
223915
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
|
|
223918
223916
|
},
|
|
223919
223917
|
"parameters": [
|
|
223920
223918
|
{
|
|
@@ -223937,7 +223935,7 @@
|
|
|
223937
223935
|
},
|
|
223938
223936
|
{
|
|
223939
223937
|
"name": "hook_id",
|
|
223940
|
-
"description": "The unique identifier of the hook.",
|
|
223938
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223941
223939
|
"in": "path",
|
|
223942
223940
|
"required": true,
|
|
223943
223941
|
"schema": {
|
|
@@ -224052,8 +224050,8 @@
|
|
|
224052
224050
|
"x-github": {
|
|
224053
224051
|
"githubCloudOnly": false,
|
|
224054
224052
|
"enabledForGitHubApps": true,
|
|
224055
|
-
"category": "
|
|
224056
|
-
"subcategory": "
|
|
224053
|
+
"category": "repos",
|
|
224054
|
+
"subcategory": "webhooks"
|
|
224057
224055
|
},
|
|
224058
224056
|
"x-octokit": {}
|
|
224059
224057
|
}
|
|
@@ -224068,7 +224066,7 @@
|
|
|
224068
224066
|
"operationId": "repos/list-webhook-deliveries",
|
|
224069
224067
|
"externalDocs": {
|
|
224070
224068
|
"description": "API method documentation",
|
|
224071
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
224069
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
|
|
224072
224070
|
},
|
|
224073
224071
|
"parameters": [
|
|
224074
224072
|
{
|
|
@@ -224091,7 +224089,7 @@
|
|
|
224091
224089
|
},
|
|
224092
224090
|
{
|
|
224093
224091
|
"name": "hook_id",
|
|
224094
|
-
"description": "The unique identifier of the hook.",
|
|
224092
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224095
224093
|
"in": "path",
|
|
224096
224094
|
"required": true,
|
|
224097
224095
|
"schema": {
|
|
@@ -224380,8 +224378,8 @@
|
|
|
224380
224378
|
"x-github": {
|
|
224381
224379
|
"githubCloudOnly": false,
|
|
224382
224380
|
"enabledForGitHubApps": true,
|
|
224383
|
-
"category": "
|
|
224384
|
-
"subcategory": "
|
|
224381
|
+
"category": "repos",
|
|
224382
|
+
"subcategory": "webhooks"
|
|
224385
224383
|
},
|
|
224386
224384
|
"x-octokit": {}
|
|
224387
224385
|
}
|
|
@@ -224396,7 +224394,7 @@
|
|
|
224396
224394
|
"operationId": "repos/get-webhook-delivery",
|
|
224397
224395
|
"externalDocs": {
|
|
224398
224396
|
"description": "API method documentation",
|
|
224399
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
224397
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
|
|
224400
224398
|
},
|
|
224401
224399
|
"parameters": [
|
|
224402
224400
|
{
|
|
@@ -224419,7 +224417,7 @@
|
|
|
224419
224417
|
},
|
|
224420
224418
|
{
|
|
224421
224419
|
"name": "hook_id",
|
|
224422
|
-
"description": "The unique identifier of the hook.",
|
|
224420
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224423
224421
|
"in": "path",
|
|
224424
224422
|
"required": true,
|
|
224425
224423
|
"schema": {
|
|
@@ -224751,8 +224749,8 @@
|
|
|
224751
224749
|
"x-github": {
|
|
224752
224750
|
"githubCloudOnly": false,
|
|
224753
224751
|
"enabledForGitHubApps": true,
|
|
224754
|
-
"category": "
|
|
224755
|
-
"subcategory": "
|
|
224752
|
+
"category": "repos",
|
|
224753
|
+
"subcategory": "webhooks"
|
|
224756
224754
|
},
|
|
224757
224755
|
"x-octokit": {}
|
|
224758
224756
|
}
|
|
@@ -224767,7 +224765,7 @@
|
|
|
224767
224765
|
"operationId": "repos/redeliver-webhook-delivery",
|
|
224768
224766
|
"externalDocs": {
|
|
224769
224767
|
"description": "API method documentation",
|
|
224770
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
224768
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
|
|
224771
224769
|
},
|
|
224772
224770
|
"parameters": [
|
|
224773
224771
|
{
|
|
@@ -224790,7 +224788,7 @@
|
|
|
224790
224788
|
},
|
|
224791
224789
|
{
|
|
224792
224790
|
"name": "hook_id",
|
|
224793
|
-
"description": "The unique identifier of the hook.",
|
|
224791
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224794
224792
|
"in": "path",
|
|
224795
224793
|
"required": true,
|
|
224796
224794
|
"schema": {
|
|
@@ -224955,8 +224953,8 @@
|
|
|
224955
224953
|
"x-github": {
|
|
224956
224954
|
"githubCloudOnly": false,
|
|
224957
224955
|
"enabledForGitHubApps": true,
|
|
224958
|
-
"category": "
|
|
224959
|
-
"subcategory": "
|
|
224956
|
+
"category": "repos",
|
|
224957
|
+
"subcategory": "webhooks"
|
|
224960
224958
|
},
|
|
224961
224959
|
"x-octokit": {}
|
|
224962
224960
|
}
|
|
@@ -224971,7 +224969,7 @@
|
|
|
224971
224969
|
"operationId": "repos/ping-webhook",
|
|
224972
224970
|
"externalDocs": {
|
|
224973
224971
|
"description": "API method documentation",
|
|
224974
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
224972
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#ping-a-repository-webhook"
|
|
224975
224973
|
},
|
|
224976
224974
|
"parameters": [
|
|
224977
224975
|
{
|
|
@@ -224994,7 +224992,7 @@
|
|
|
224994
224992
|
},
|
|
224995
224993
|
{
|
|
224996
224994
|
"name": "hook_id",
|
|
224997
|
-
"description": "The unique identifier of the hook.",
|
|
224995
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224998
224996
|
"in": "path",
|
|
224999
224997
|
"required": true,
|
|
225000
224998
|
"schema": {
|
|
@@ -225036,8 +225034,8 @@
|
|
|
225036
225034
|
"x-github": {
|
|
225037
225035
|
"githubCloudOnly": false,
|
|
225038
225036
|
"enabledForGitHubApps": true,
|
|
225039
|
-
"category": "
|
|
225040
|
-
"subcategory": "
|
|
225037
|
+
"category": "repos",
|
|
225038
|
+
"subcategory": "webhooks"
|
|
225041
225039
|
},
|
|
225042
225040
|
"x-octokit": {}
|
|
225043
225041
|
}
|
|
@@ -225052,7 +225050,7 @@
|
|
|
225052
225050
|
"operationId": "repos/test-push-webhook",
|
|
225053
225051
|
"externalDocs": {
|
|
225054
225052
|
"description": "API method documentation",
|
|
225055
|
-
"url": "https://docs.github.com/enterprise-server@3.7/rest/webhooks
|
|
225053
|
+
"url": "https://docs.github.com/enterprise-server@3.7/rest/repos/webhooks#test-the-push-repository-webhook"
|
|
225056
225054
|
},
|
|
225057
225055
|
"parameters": [
|
|
225058
225056
|
{
|
|
@@ -225075,7 +225073,7 @@
|
|
|
225075
225073
|
},
|
|
225076
225074
|
{
|
|
225077
225075
|
"name": "hook_id",
|
|
225078
|
-
"description": "The unique identifier of the hook.",
|
|
225076
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
225079
225077
|
"in": "path",
|
|
225080
225078
|
"required": true,
|
|
225081
225079
|
"schema": {
|
|
@@ -225117,8 +225115,8 @@
|
|
|
225117
225115
|
"x-github": {
|
|
225118
225116
|
"githubCloudOnly": false,
|
|
225119
225117
|
"enabledForGitHubApps": true,
|
|
225120
|
-
"category": "
|
|
225121
|
-
"subcategory": "
|
|
225118
|
+
"category": "repos",
|
|
225119
|
+
"subcategory": "webhooks"
|
|
225122
225120
|
},
|
|
225123
225121
|
"x-octokit": {}
|
|
225124
225122
|
}
|
|
@@ -281896,6 +281894,32 @@
|
|
|
281896
281894
|
}
|
|
281897
281895
|
}
|
|
281898
281896
|
}
|
|
281897
|
+
},
|
|
281898
|
+
"404": {
|
|
281899
|
+
"description": "Resource not found",
|
|
281900
|
+
"content": {
|
|
281901
|
+
"application/json": {
|
|
281902
|
+
"schema": {
|
|
281903
|
+
"title": "Basic Error",
|
|
281904
|
+
"description": "Basic Error",
|
|
281905
|
+
"type": "object",
|
|
281906
|
+
"properties": {
|
|
281907
|
+
"message": {
|
|
281908
|
+
"type": "string"
|
|
281909
|
+
},
|
|
281910
|
+
"documentation_url": {
|
|
281911
|
+
"type": "string"
|
|
281912
|
+
},
|
|
281913
|
+
"url": {
|
|
281914
|
+
"type": "string"
|
|
281915
|
+
},
|
|
281916
|
+
"status": {
|
|
281917
|
+
"type": "string"
|
|
281918
|
+
}
|
|
281919
|
+
}
|
|
281920
|
+
}
|
|
281921
|
+
}
|
|
281922
|
+
}
|
|
281899
281923
|
}
|
|
281900
281924
|
},
|
|
281901
281925
|
"x-github": {
|
|
@@ -299169,7 +299193,7 @@
|
|
|
299169
299193
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
299170
299194
|
"get": {
|
|
299171
299195
|
"summary": "List reactions for a pull request review comment",
|
|
299172
|
-
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
299196
|
+
"description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
299173
299197
|
"tags": [
|
|
299174
299198
|
"reactions"
|
|
299175
299199
|
],
|
|
@@ -441720,7 +441744,7 @@
|
|
|
441720
441744
|
"format": "uri"
|
|
441721
441745
|
},
|
|
441722
441746
|
"conclusion": {
|
|
441723
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
441747
|
+
"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`.",
|
|
441724
441748
|
"type": "string",
|
|
441725
441749
|
"nullable": true,
|
|
441726
441750
|
"enum": [
|
|
@@ -444074,7 +444098,7 @@
|
|
|
444074
444098
|
"format": "uri"
|
|
444075
444099
|
},
|
|
444076
444100
|
"conclusion": {
|
|
444077
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
444101
|
+
"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.",
|
|
444078
444102
|
"type": "string",
|
|
444079
444103
|
"nullable": true,
|
|
444080
444104
|
"enum": [
|
|
@@ -446421,7 +446445,7 @@
|
|
|
446421
446445
|
"format": "uri"
|
|
446422
446446
|
},
|
|
446423
446447
|
"conclusion": {
|
|
446424
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
446448
|
+
"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.",
|
|
446425
446449
|
"type": "string",
|
|
446426
446450
|
"nullable": true,
|
|
446427
446451
|
"enum": [
|
|
@@ -448399,7 +448423,7 @@
|
|
|
448399
448423
|
]
|
|
448400
448424
|
},
|
|
448401
448425
|
"dismissed_reason": {
|
|
448402
|
-
"description": "The reason for dismissing or closing the alert.
|
|
448426
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
448403
448427
|
"type": "string",
|
|
448404
448428
|
"nullable": true,
|
|
448405
448429
|
"enum": [
|
|
@@ -450291,7 +450315,7 @@
|
|
|
450291
450315
|
]
|
|
450292
450316
|
},
|
|
450293
450317
|
"dismissed_reason": {
|
|
450294
|
-
"description": "The reason for dismissing or closing the alert.
|
|
450318
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
450295
450319
|
"type": "string",
|
|
450296
450320
|
"nullable": true,
|
|
450297
450321
|
"enum": [
|
|
@@ -454047,7 +454071,7 @@
|
|
|
454047
454071
|
]
|
|
454048
454072
|
},
|
|
454049
454073
|
"dismissed_reason": {
|
|
454050
|
-
"description": "The reason for dismissing or closing the alert.
|
|
454074
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
454051
454075
|
"type": "string",
|
|
454052
454076
|
"nullable": true,
|
|
454053
454077
|
"enum": [
|
|
@@ -490085,7 +490109,7 @@
|
|
|
490085
490109
|
"format": "date-time"
|
|
490086
490110
|
},
|
|
490087
490111
|
"conclusion": {
|
|
490088
|
-
"description": "The result of the completed check run.
|
|
490112
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
490089
490113
|
"type": "string",
|
|
490090
490114
|
"nullable": true,
|
|
490091
490115
|
"enum": [
|
|
@@ -589469,6 +589493,10 @@
|
|
|
589469
589493
|
"type": "string",
|
|
589470
589494
|
"format": "uri"
|
|
589471
589495
|
},
|
|
589496
|
+
"has_discussions": {
|
|
589497
|
+
"description": "Whether the repository has discussions enabled.",
|
|
589498
|
+
"type": "boolean"
|
|
589499
|
+
},
|
|
589472
589500
|
"has_downloads": {
|
|
589473
589501
|
"description": "Whether downloads are enabled.",
|
|
589474
589502
|
"type": "boolean",
|
|
@@ -589825,6 +589853,10 @@
|
|
|
589825
589853
|
},
|
|
589826
589854
|
"watchers_count": {
|
|
589827
589855
|
"type": "integer"
|
|
589856
|
+
},
|
|
589857
|
+
"web_commit_signoff_required": {
|
|
589858
|
+
"description": "Whether to require commit signoff.",
|
|
589859
|
+
"type": "boolean"
|
|
589828
589860
|
}
|
|
589829
589861
|
},
|
|
589830
589862
|
"required": [
|
|
@@ -712680,7 +712712,7 @@
|
|
|
712680
712712
|
"pull-request-edited": {
|
|
712681
712713
|
"post": {
|
|
712682
712714
|
"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.7/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.7/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-server@3.7/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
|
|
712683
|
-
"description": "The title or body of a pull request was edited.",
|
|
712715
|
+
"description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
|
|
712684
712716
|
"operationId": "pull-request/edited",
|
|
712685
712717
|
"externalDocs": {
|
|
712686
712718
|
"url": "https://docs.github.com/enterprise-server@3.7/webhooks/webhook-events-and-payloads#pull_request"
|
|
@@ -884841,7 +884873,6 @@
|
|
|
884841
884873
|
"forks",
|
|
884842
884874
|
"forks_count",
|
|
884843
884875
|
"git_url",
|
|
884844
|
-
"has_downloads",
|
|
884845
884876
|
"has_issues",
|
|
884846
884877
|
"has_projects",
|
|
884847
884878
|
"has_wiki",
|
|
@@ -911043,7 +911074,7 @@
|
|
|
911043
911074
|
}
|
|
911044
911075
|
},
|
|
911045
911076
|
"x-github": {
|
|
911046
|
-
"githubCloudOnly":
|
|
911077
|
+
"githubCloudOnly": true,
|
|
911047
911078
|
"category": "webhooks",
|
|
911048
911079
|
"subcategory": "user",
|
|
911049
911080
|
"supported-webhook-types": [
|
|
@@ -912735,7 +912766,7 @@
|
|
|
912735
912766
|
}
|
|
912736
912767
|
},
|
|
912737
912768
|
"x-github": {
|
|
912738
|
-
"githubCloudOnly":
|
|
912769
|
+
"githubCloudOnly": true,
|
|
912739
912770
|
"category": "webhooks",
|
|
912740
912771
|
"subcategory": "user",
|
|
912741
912772
|
"supported-webhook-types": [
|