@octokit/openapi 13.0.0 → 13.1.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 +4679 -575
- package/generated/api.github.com.json +1752 -87
- package/generated/ghec.deref.json +8161 -705
- package/generated/ghec.json +2645 -556
- package/generated/ghes-3.10.deref.json +83 -82
- package/generated/ghes-3.10.json +73 -54
- package/generated/ghes-3.7.deref.json +67 -63
- package/generated/ghes-3.7.json +57 -36
- package/generated/ghes-3.8.deref.json +78 -74
- package/generated/ghes-3.8.json +68 -47
- package/generated/ghes-3.9.deref.json +81 -77
- package/generated/ghes-3.9.json +71 -50
- package/generated/github.ae.deref.json +258 -72
- package/generated/github.ae.json +162 -36
- 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.1.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",
|
|
@@ -128293,7 +128292,6 @@
|
|
|
128293
128292
|
"forks",
|
|
128294
128293
|
"forks_count",
|
|
128295
128294
|
"git_url",
|
|
128296
|
-
"has_downloads",
|
|
128297
128295
|
"has_issues",
|
|
128298
128296
|
"has_projects",
|
|
128299
128297
|
"has_wiki",
|
|
@@ -130556,7 +130554,7 @@
|
|
|
130556
130554
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
130557
130555
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
130558
130556
|
"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",
|
|
130557
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
130560
130558
|
"status": "completed",
|
|
130561
130559
|
"conclusion": "success",
|
|
130562
130560
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -130736,7 +130734,7 @@
|
|
|
130736
130734
|
"/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": {
|
|
130737
130735
|
"post": {
|
|
130738
130736
|
"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.\
|
|
130737
|
+
"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
130738
|
"tags": [
|
|
130741
130739
|
"actions"
|
|
130742
130740
|
],
|
|
@@ -131878,7 +131876,7 @@
|
|
|
131878
131876
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
131879
131877
|
"get": {
|
|
131880
131878
|
"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.\
|
|
131879
|
+
"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
131880
|
"tags": [
|
|
131883
131881
|
"actions"
|
|
131884
131882
|
],
|
|
@@ -132103,7 +132101,7 @@
|
|
|
132103
132101
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
132104
132102
|
"get": {
|
|
132105
132103
|
"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.\
|
|
132104
|
+
"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
132105
|
"tags": [
|
|
132108
132106
|
"actions"
|
|
132109
132107
|
],
|
|
@@ -132234,7 +132232,7 @@
|
|
|
132234
132232
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
132235
132233
|
"post": {
|
|
132236
132234
|
"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.\
|
|
132235
|
+
"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
132236
|
"tags": [
|
|
132239
132237
|
"actions"
|
|
132240
132238
|
],
|
|
@@ -133540,7 +133538,7 @@
|
|
|
133540
133538
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
133541
133539
|
"post": {
|
|
133542
133540
|
"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.\
|
|
133541
|
+
"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
133542
|
"tags": [
|
|
133545
133543
|
"actions"
|
|
133546
133544
|
],
|
|
@@ -134846,7 +134844,7 @@
|
|
|
134846
134844
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
134847
134845
|
"get": {
|
|
134848
134846
|
"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.\
|
|
134847
|
+
"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
134848
|
"tags": [
|
|
134851
134849
|
"actions"
|
|
134852
134850
|
],
|
|
@@ -135008,7 +135006,7 @@
|
|
|
135008
135006
|
},
|
|
135009
135007
|
"delete": {
|
|
135010
135008
|
"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.\
|
|
135009
|
+
"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
135010
|
"tags": [
|
|
135013
135011
|
"actions"
|
|
135014
135012
|
],
|
|
@@ -135063,7 +135061,7 @@
|
|
|
135063
135061
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": {
|
|
135064
135062
|
"get": {
|
|
135065
135063
|
"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.\
|
|
135064
|
+
"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
135065
|
"tags": [
|
|
135068
135066
|
"actions"
|
|
135069
135067
|
],
|
|
@@ -135216,7 +135214,7 @@
|
|
|
135216
135214
|
},
|
|
135217
135215
|
"post": {
|
|
135218
135216
|
"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.\
|
|
135217
|
+
"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
135218
|
"tags": [
|
|
135221
135219
|
"actions"
|
|
135222
135220
|
],
|
|
@@ -135433,7 +135431,7 @@
|
|
|
135433
135431
|
},
|
|
135434
135432
|
"put": {
|
|
135435
135433
|
"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.\
|
|
135434
|
+
"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
135435
|
"tags": [
|
|
135438
135436
|
"actions"
|
|
135439
135437
|
],
|
|
@@ -135650,7 +135648,7 @@
|
|
|
135650
135648
|
},
|
|
135651
135649
|
"delete": {
|
|
135652
135650
|
"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.\
|
|
135651
|
+
"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
135652
|
"tags": [
|
|
135655
135653
|
"actions"
|
|
135656
135654
|
],
|
|
@@ -135800,7 +135798,7 @@
|
|
|
135800
135798
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": {
|
|
135801
135799
|
"delete": {
|
|
135802
135800
|
"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.\
|
|
135801
|
+
"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
135802
|
"tags": [
|
|
135805
135803
|
"actions"
|
|
135806
135804
|
],
|
|
@@ -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
|
],
|
|
@@ -143831,7 +143829,7 @@
|
|
|
143831
143829
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
143832
143830
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
143833
143831
|
"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",
|
|
143832
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
143835
143833
|
"status": "completed",
|
|
143836
143834
|
"conclusion": "success",
|
|
143837
143835
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -171697,7 +171695,7 @@
|
|
|
171697
171695
|
},
|
|
171698
171696
|
"patch": {
|
|
171699
171697
|
"summary": "Update a check run",
|
|
171700
|
-
"description": "**Note:** The
|
|
171698
|
+
"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
171699
|
"tags": [
|
|
171702
171700
|
"checks"
|
|
171703
171701
|
],
|
|
@@ -178560,7 +178558,7 @@
|
|
|
178560
178558
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
178561
178559
|
"get": {
|
|
178562
178560
|
"summary": "List check runs in a check suite",
|
|
178563
|
-
"description": "
|
|
178561
|
+
"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
178562
|
"tags": [
|
|
178565
178563
|
"checks"
|
|
178566
178564
|
],
|
|
@@ -193836,7 +193834,7 @@
|
|
|
193836
193834
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
193837
193835
|
"get": {
|
|
193838
193836
|
"summary": "List check runs for a Git reference",
|
|
193839
|
-
"description": "**Note:** The
|
|
193837
|
+
"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
193838
|
"tags": [
|
|
193841
193839
|
"checks"
|
|
193842
193840
|
],
|
|
@@ -194893,7 +194891,7 @@
|
|
|
194893
194891
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
194894
194892
|
"get": {
|
|
194895
194893
|
"summary": "List check suites for a Git reference",
|
|
194896
|
-
"description": "
|
|
194894
|
+
"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
194895
|
"tags": [
|
|
194898
194896
|
"checks"
|
|
194899
194897
|
],
|
|
@@ -209226,11 +209224,11 @@
|
|
|
209226
209224
|
"content": {
|
|
209227
209225
|
"application/json": {
|
|
209228
209226
|
"schema": {
|
|
209229
|
-
"title": "Deployment branch policy name pattern",
|
|
209227
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
209230
209228
|
"type": "object",
|
|
209231
209229
|
"properties": {
|
|
209232
209230
|
"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).",
|
|
209231
|
+
"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
209232
|
"type": "string",
|
|
209235
209233
|
"example": "release/*"
|
|
209236
209234
|
}
|
|
@@ -209320,7 +209318,7 @@
|
|
|
209320
209318
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
209321
209319
|
"get": {
|
|
209322
209320
|
"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 `
|
|
209321
|
+
"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
209322
|
"tags": [
|
|
209325
209323
|
"repos"
|
|
209326
209324
|
],
|
|
@@ -218205,7 +218203,6 @@
|
|
|
218205
218203
|
"forks",
|
|
218206
218204
|
"forks_count",
|
|
218207
218205
|
"git_url",
|
|
218208
|
-
"has_downloads",
|
|
218209
218206
|
"has_issues",
|
|
218210
218207
|
"has_projects",
|
|
218211
218208
|
"has_wiki",
|
|
@@ -223043,7 +223040,7 @@
|
|
|
223043
223040
|
},
|
|
223044
223041
|
{
|
|
223045
223042
|
"name": "hook_id",
|
|
223046
|
-
"description": "The unique identifier of the hook.",
|
|
223043
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223047
223044
|
"in": "path",
|
|
223048
223045
|
"required": true,
|
|
223049
223046
|
"schema": {
|
|
@@ -223316,7 +223313,7 @@
|
|
|
223316
223313
|
},
|
|
223317
223314
|
{
|
|
223318
223315
|
"name": "hook_id",
|
|
223319
|
-
"description": "The unique identifier of the hook.",
|
|
223316
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223320
223317
|
"in": "path",
|
|
223321
223318
|
"required": true,
|
|
223322
223319
|
"schema": {
|
|
@@ -223754,7 +223751,7 @@
|
|
|
223754
223751
|
},
|
|
223755
223752
|
{
|
|
223756
223753
|
"name": "hook_id",
|
|
223757
|
-
"description": "The unique identifier of the hook.",
|
|
223754
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223758
223755
|
"in": "path",
|
|
223759
223756
|
"required": true,
|
|
223760
223757
|
"schema": {
|
|
@@ -223835,7 +223832,7 @@
|
|
|
223835
223832
|
},
|
|
223836
223833
|
{
|
|
223837
223834
|
"name": "hook_id",
|
|
223838
|
-
"description": "The unique identifier of the hook.",
|
|
223835
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223839
223836
|
"in": "path",
|
|
223840
223837
|
"required": true,
|
|
223841
223838
|
"schema": {
|
|
@@ -223937,7 +223934,7 @@
|
|
|
223937
223934
|
},
|
|
223938
223935
|
{
|
|
223939
223936
|
"name": "hook_id",
|
|
223940
|
-
"description": "The unique identifier of the hook.",
|
|
223937
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
223941
223938
|
"in": "path",
|
|
223942
223939
|
"required": true,
|
|
223943
223940
|
"schema": {
|
|
@@ -224091,7 +224088,7 @@
|
|
|
224091
224088
|
},
|
|
224092
224089
|
{
|
|
224093
224090
|
"name": "hook_id",
|
|
224094
|
-
"description": "The unique identifier of the hook.",
|
|
224091
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224095
224092
|
"in": "path",
|
|
224096
224093
|
"required": true,
|
|
224097
224094
|
"schema": {
|
|
@@ -224419,7 +224416,7 @@
|
|
|
224419
224416
|
},
|
|
224420
224417
|
{
|
|
224421
224418
|
"name": "hook_id",
|
|
224422
|
-
"description": "The unique identifier of the hook.",
|
|
224419
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224423
224420
|
"in": "path",
|
|
224424
224421
|
"required": true,
|
|
224425
224422
|
"schema": {
|
|
@@ -224790,7 +224787,7 @@
|
|
|
224790
224787
|
},
|
|
224791
224788
|
{
|
|
224792
224789
|
"name": "hook_id",
|
|
224793
|
-
"description": "The unique identifier of the hook.",
|
|
224790
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224794
224791
|
"in": "path",
|
|
224795
224792
|
"required": true,
|
|
224796
224793
|
"schema": {
|
|
@@ -224994,7 +224991,7 @@
|
|
|
224994
224991
|
},
|
|
224995
224992
|
{
|
|
224996
224993
|
"name": "hook_id",
|
|
224997
|
-
"description": "The unique identifier of the hook.",
|
|
224994
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
224998
224995
|
"in": "path",
|
|
224999
224996
|
"required": true,
|
|
225000
224997
|
"schema": {
|
|
@@ -225075,7 +225072,7 @@
|
|
|
225075
225072
|
},
|
|
225076
225073
|
{
|
|
225077
225074
|
"name": "hook_id",
|
|
225078
|
-
"description": "The unique identifier of the hook.",
|
|
225075
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
225079
225076
|
"in": "path",
|
|
225080
225077
|
"required": true,
|
|
225081
225078
|
"schema": {
|
|
@@ -299169,7 +299166,7 @@
|
|
|
299169
299166
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
299170
299167
|
"get": {
|
|
299171
299168
|
"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).",
|
|
299169
|
+
"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
299170
|
"tags": [
|
|
299174
299171
|
"reactions"
|
|
299175
299172
|
],
|
|
@@ -441720,7 +441717,7 @@
|
|
|
441720
441717
|
"format": "uri"
|
|
441721
441718
|
},
|
|
441722
441719
|
"conclusion": {
|
|
441723
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
441720
|
+
"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
441721
|
"type": "string",
|
|
441725
441722
|
"nullable": true,
|
|
441726
441723
|
"enum": [
|
|
@@ -444074,7 +444071,7 @@
|
|
|
444074
444071
|
"format": "uri"
|
|
444075
444072
|
},
|
|
444076
444073
|
"conclusion": {
|
|
444077
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
444074
|
+
"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
444075
|
"type": "string",
|
|
444079
444076
|
"nullable": true,
|
|
444080
444077
|
"enum": [
|
|
@@ -446421,7 +446418,7 @@
|
|
|
446421
446418
|
"format": "uri"
|
|
446422
446419
|
},
|
|
446423
446420
|
"conclusion": {
|
|
446424
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
446421
|
+
"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
446422
|
"type": "string",
|
|
446426
446423
|
"nullable": true,
|
|
446427
446424
|
"enum": [
|
|
@@ -448399,7 +448396,7 @@
|
|
|
448399
448396
|
]
|
|
448400
448397
|
},
|
|
448401
448398
|
"dismissed_reason": {
|
|
448402
|
-
"description": "The reason for dismissing or closing the alert.
|
|
448399
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
448403
448400
|
"type": "string",
|
|
448404
448401
|
"nullable": true,
|
|
448405
448402
|
"enum": [
|
|
@@ -450291,7 +450288,7 @@
|
|
|
450291
450288
|
]
|
|
450292
450289
|
},
|
|
450293
450290
|
"dismissed_reason": {
|
|
450294
|
-
"description": "The reason for dismissing or closing the alert.
|
|
450291
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
450295
450292
|
"type": "string",
|
|
450296
450293
|
"nullable": true,
|
|
450297
450294
|
"enum": [
|
|
@@ -454047,7 +454044,7 @@
|
|
|
454047
454044
|
]
|
|
454048
454045
|
},
|
|
454049
454046
|
"dismissed_reason": {
|
|
454050
|
-
"description": "The reason for dismissing or closing the alert.
|
|
454047
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
454051
454048
|
"type": "string",
|
|
454052
454049
|
"nullable": true,
|
|
454053
454050
|
"enum": [
|
|
@@ -490085,7 +490082,7 @@
|
|
|
490085
490082
|
"format": "date-time"
|
|
490086
490083
|
},
|
|
490087
490084
|
"conclusion": {
|
|
490088
|
-
"description": "The result of the completed check run.
|
|
490085
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
490089
490086
|
"type": "string",
|
|
490090
490087
|
"nullable": true,
|
|
490091
490088
|
"enum": [
|
|
@@ -589469,6 +589466,10 @@
|
|
|
589469
589466
|
"type": "string",
|
|
589470
589467
|
"format": "uri"
|
|
589471
589468
|
},
|
|
589469
|
+
"has_discussions": {
|
|
589470
|
+
"description": "Whether the repository has discussions enabled.",
|
|
589471
|
+
"type": "boolean"
|
|
589472
|
+
},
|
|
589472
589473
|
"has_downloads": {
|
|
589473
589474
|
"description": "Whether downloads are enabled.",
|
|
589474
589475
|
"type": "boolean",
|
|
@@ -589825,6 +589826,10 @@
|
|
|
589825
589826
|
},
|
|
589826
589827
|
"watchers_count": {
|
|
589827
589828
|
"type": "integer"
|
|
589829
|
+
},
|
|
589830
|
+
"web_commit_signoff_required": {
|
|
589831
|
+
"description": "Whether to require commit signoff.",
|
|
589832
|
+
"type": "boolean"
|
|
589828
589833
|
}
|
|
589829
589834
|
},
|
|
589830
589835
|
"required": [
|
|
@@ -884841,7 +884846,6 @@
|
|
|
884841
884846
|
"forks",
|
|
884842
884847
|
"forks_count",
|
|
884843
884848
|
"git_url",
|
|
884844
|
-
"has_downloads",
|
|
884845
884849
|
"has_issues",
|
|
884846
884850
|
"has_projects",
|
|
884847
884851
|
"has_wiki",
|
|
@@ -911043,7 +911047,7 @@
|
|
|
911043
911047
|
}
|
|
911044
911048
|
},
|
|
911045
911049
|
"x-github": {
|
|
911046
|
-
"githubCloudOnly":
|
|
911050
|
+
"githubCloudOnly": true,
|
|
911047
911051
|
"category": "webhooks",
|
|
911048
911052
|
"subcategory": "user",
|
|
911049
911053
|
"supported-webhook-types": [
|
|
@@ -912735,7 +912739,7 @@
|
|
|
912735
912739
|
}
|
|
912736
912740
|
},
|
|
912737
912741
|
"x-github": {
|
|
912738
|
-
"githubCloudOnly":
|
|
912742
|
+
"githubCloudOnly": true,
|
|
912739
912743
|
"category": "webhooks",
|
|
912740
912744
|
"subcategory": "user",
|
|
912741
912745
|
"supported-webhook-types": [
|