@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": {
|
|
@@ -732,7 +732,7 @@
|
|
|
732
732
|
"parameters": [
|
|
733
733
|
{
|
|
734
734
|
"name": "hook_id",
|
|
735
|
-
"description": "The unique identifier of the hook.",
|
|
735
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
736
736
|
"in": "path",
|
|
737
737
|
"required": true,
|
|
738
738
|
"schema": {
|
|
@@ -847,7 +847,7 @@
|
|
|
847
847
|
"parameters": [
|
|
848
848
|
{
|
|
849
849
|
"name": "hook_id",
|
|
850
|
-
"description": "The unique identifier of the hook.",
|
|
850
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
851
851
|
"in": "path",
|
|
852
852
|
"required": true,
|
|
853
853
|
"schema": {
|
|
@@ -1018,7 +1018,7 @@
|
|
|
1018
1018
|
"parameters": [
|
|
1019
1019
|
{
|
|
1020
1020
|
"name": "hook_id",
|
|
1021
|
-
"description": "The unique identifier of the hook.",
|
|
1021
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
1022
1022
|
"in": "path",
|
|
1023
1023
|
"required": true,
|
|
1024
1024
|
"schema": {
|
|
@@ -1055,7 +1055,7 @@
|
|
|
1055
1055
|
"parameters": [
|
|
1056
1056
|
{
|
|
1057
1057
|
"name": "hook_id",
|
|
1058
|
-
"description": "The unique identifier of the hook.",
|
|
1058
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
1059
1059
|
"in": "path",
|
|
1060
1060
|
"required": true,
|
|
1061
1061
|
"schema": {
|
|
@@ -52969,7 +52969,7 @@
|
|
|
52969
52969
|
},
|
|
52970
52970
|
{
|
|
52971
52971
|
"name": "hook_id",
|
|
52972
|
-
"description": "The unique identifier of the hook.",
|
|
52972
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
52973
52973
|
"in": "path",
|
|
52974
52974
|
"required": true,
|
|
52975
52975
|
"schema": {
|
|
@@ -53156,7 +53156,7 @@
|
|
|
53156
53156
|
},
|
|
53157
53157
|
{
|
|
53158
53158
|
"name": "hook_id",
|
|
53159
|
-
"description": "The unique identifier of the hook.",
|
|
53159
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
53160
53160
|
"in": "path",
|
|
53161
53161
|
"required": true,
|
|
53162
53162
|
"schema": {
|
|
@@ -53489,7 +53489,7 @@
|
|
|
53489
53489
|
},
|
|
53490
53490
|
{
|
|
53491
53491
|
"name": "hook_id",
|
|
53492
|
-
"description": "The unique identifier of the hook.",
|
|
53492
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
53493
53493
|
"in": "path",
|
|
53494
53494
|
"required": true,
|
|
53495
53495
|
"schema": {
|
|
@@ -53561,7 +53561,7 @@
|
|
|
53561
53561
|
},
|
|
53562
53562
|
{
|
|
53563
53563
|
"name": "hook_id",
|
|
53564
|
-
"description": "The unique identifier of the hook.",
|
|
53564
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
53565
53565
|
"in": "path",
|
|
53566
53566
|
"required": true,
|
|
53567
53567
|
"schema": {
|
|
@@ -53654,7 +53654,7 @@
|
|
|
53654
53654
|
},
|
|
53655
53655
|
{
|
|
53656
53656
|
"name": "hook_id",
|
|
53657
|
-
"description": "The unique identifier of the hook.",
|
|
53657
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
53658
53658
|
"in": "path",
|
|
53659
53659
|
"required": true,
|
|
53660
53660
|
"schema": {
|
|
@@ -53800,7 +53800,7 @@
|
|
|
53800
53800
|
},
|
|
53801
53801
|
{
|
|
53802
53802
|
"name": "hook_id",
|
|
53803
|
-
"description": "The unique identifier of the hook.",
|
|
53803
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
53804
53804
|
"in": "path",
|
|
53805
53805
|
"required": true,
|
|
53806
53806
|
"schema": {
|
|
@@ -54119,7 +54119,7 @@
|
|
|
54119
54119
|
},
|
|
54120
54120
|
{
|
|
54121
54121
|
"name": "hook_id",
|
|
54122
|
-
"description": "The unique identifier of the hook.",
|
|
54122
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
54123
54123
|
"in": "path",
|
|
54124
54124
|
"required": true,
|
|
54125
54125
|
"schema": {
|
|
@@ -54480,7 +54480,7 @@
|
|
|
54480
54480
|
},
|
|
54481
54481
|
{
|
|
54482
54482
|
"name": "hook_id",
|
|
54483
|
-
"description": "The unique identifier of the hook.",
|
|
54483
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
54484
54484
|
"in": "path",
|
|
54485
54485
|
"required": true,
|
|
54486
54486
|
"schema": {
|
|
@@ -54675,7 +54675,7 @@
|
|
|
54675
54675
|
},
|
|
54676
54676
|
{
|
|
54677
54677
|
"name": "hook_id",
|
|
54678
|
-
"description": "The unique identifier of the hook.",
|
|
54678
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
54679
54679
|
"in": "path",
|
|
54680
54680
|
"required": true,
|
|
54681
54681
|
"schema": {
|
|
@@ -62197,7 +62197,7 @@
|
|
|
62197
62197
|
},
|
|
62198
62198
|
"exclude": {
|
|
62199
62199
|
"type": "array",
|
|
62200
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
62200
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
62201
62201
|
"items": {
|
|
62202
62202
|
"type": "string",
|
|
62203
62203
|
"enum": [
|
|
@@ -92905,7 +92905,6 @@
|
|
|
92905
92905
|
"forks",
|
|
92906
92906
|
"forks_count",
|
|
92907
92907
|
"git_url",
|
|
92908
|
-
"has_downloads",
|
|
92909
92908
|
"has_issues",
|
|
92910
92909
|
"has_projects",
|
|
92911
92910
|
"has_wiki",
|
|
@@ -97958,7 +97957,6 @@
|
|
|
97958
97957
|
"forks",
|
|
97959
97958
|
"forks_count",
|
|
97960
97959
|
"git_url",
|
|
97961
|
-
"has_downloads",
|
|
97962
97960
|
"has_issues",
|
|
97963
97961
|
"has_projects",
|
|
97964
97962
|
"has_wiki",
|
|
@@ -99601,7 +99599,7 @@
|
|
|
99601
99599
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
99602
99600
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
99603
99601
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
99604
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
99602
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
99605
99603
|
"status": "completed",
|
|
99606
99604
|
"conclusion": "success",
|
|
99607
99605
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -100257,7 +100255,7 @@
|
|
|
100257
100255
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
100258
100256
|
"get": {
|
|
100259
100257
|
"summary": "List self-hosted runners for a repository",
|
|
100260
|
-
"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.\
|
|
100258
|
+
"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.",
|
|
100261
100259
|
"tags": [
|
|
100262
100260
|
"actions"
|
|
100263
100261
|
],
|
|
@@ -100482,7 +100480,7 @@
|
|
|
100482
100480
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
100483
100481
|
"get": {
|
|
100484
100482
|
"summary": "List runner applications for a repository",
|
|
100485
|
-
"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.\
|
|
100483
|
+
"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.",
|
|
100486
100484
|
"tags": [
|
|
100487
100485
|
"actions"
|
|
100488
100486
|
],
|
|
@@ -100603,7 +100601,7 @@
|
|
|
100603
100601
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
100604
100602
|
"post": {
|
|
100605
100603
|
"summary": "Create a registration token for a repository",
|
|
100606
|
-
"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.\
|
|
100604
|
+
"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```",
|
|
100607
100605
|
"tags": [
|
|
100608
100606
|
"actions"
|
|
100609
100607
|
],
|
|
@@ -101826,7 +101824,7 @@
|
|
|
101826
101824
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
101827
101825
|
"post": {
|
|
101828
101826
|
"summary": "Create a remove token for a repository",
|
|
101829
|
-
"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.\
|
|
101827
|
+
"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```",
|
|
101830
101828
|
"tags": [
|
|
101831
101829
|
"actions"
|
|
101832
101830
|
],
|
|
@@ -103049,7 +103047,7 @@
|
|
|
103049
103047
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
103050
103048
|
"get": {
|
|
103051
103049
|
"summary": "Get a self-hosted runner for a repository",
|
|
103052
|
-
"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.\
|
|
103050
|
+
"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.",
|
|
103053
103051
|
"tags": [
|
|
103054
103052
|
"actions"
|
|
103055
103053
|
],
|
|
@@ -103211,7 +103209,7 @@
|
|
|
103211
103209
|
},
|
|
103212
103210
|
"delete": {
|
|
103213
103211
|
"summary": "Delete a self-hosted runner from a repository",
|
|
103214
|
-
"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.\
|
|
103212
|
+
"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.",
|
|
103215
103213
|
"tags": [
|
|
103216
103214
|
"actions"
|
|
103217
103215
|
],
|
|
@@ -110551,7 +110549,7 @@
|
|
|
110551
110549
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
110552
110550
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
110553
110551
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
110554
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
110552
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
110555
110553
|
"status": "completed",
|
|
110556
110554
|
"conclusion": "success",
|
|
110557
110555
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -110778,7 +110776,7 @@
|
|
|
110778
110776
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
110779
110777
|
"post": {
|
|
110780
110778
|
"summary": "Cancel a workflow run",
|
|
110781
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
110779
|
+
"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.",
|
|
110782
110780
|
"tags": [
|
|
110783
110781
|
"actions"
|
|
110784
110782
|
],
|
|
@@ -110872,6 +110870,103 @@
|
|
|
110872
110870
|
"x-octokit": {}
|
|
110873
110871
|
}
|
|
110874
110872
|
},
|
|
110873
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
|
|
110874
|
+
"post": {
|
|
110875
|
+
"summary": "Force cancel a workflow run",
|
|
110876
|
+
"description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\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.",
|
|
110877
|
+
"tags": [
|
|
110878
|
+
"actions"
|
|
110879
|
+
],
|
|
110880
|
+
"operationId": "actions/force-cancel-workflow-run",
|
|
110881
|
+
"externalDocs": {
|
|
110882
|
+
"description": "API method documentation",
|
|
110883
|
+
"url": "https://docs.github.com/github-ae@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run"
|
|
110884
|
+
},
|
|
110885
|
+
"parameters": [
|
|
110886
|
+
{
|
|
110887
|
+
"name": "owner",
|
|
110888
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
110889
|
+
"in": "path",
|
|
110890
|
+
"required": true,
|
|
110891
|
+
"schema": {
|
|
110892
|
+
"type": "string"
|
|
110893
|
+
}
|
|
110894
|
+
},
|
|
110895
|
+
{
|
|
110896
|
+
"name": "repo",
|
|
110897
|
+
"description": "The name of the repository without the `.git` extension. The name is not case sensitive.",
|
|
110898
|
+
"in": "path",
|
|
110899
|
+
"required": true,
|
|
110900
|
+
"schema": {
|
|
110901
|
+
"type": "string"
|
|
110902
|
+
}
|
|
110903
|
+
},
|
|
110904
|
+
{
|
|
110905
|
+
"name": "run_id",
|
|
110906
|
+
"description": "The unique identifier of the workflow run.",
|
|
110907
|
+
"in": "path",
|
|
110908
|
+
"required": true,
|
|
110909
|
+
"schema": {
|
|
110910
|
+
"type": "integer"
|
|
110911
|
+
}
|
|
110912
|
+
}
|
|
110913
|
+
],
|
|
110914
|
+
"responses": {
|
|
110915
|
+
"202": {
|
|
110916
|
+
"description": "Response",
|
|
110917
|
+
"content": {
|
|
110918
|
+
"application/json": {
|
|
110919
|
+
"schema": {
|
|
110920
|
+
"title": "Empty Object",
|
|
110921
|
+
"description": "An object without any properties.",
|
|
110922
|
+
"type": "object",
|
|
110923
|
+
"properties": {},
|
|
110924
|
+
"additionalProperties": false
|
|
110925
|
+
},
|
|
110926
|
+
"examples": {
|
|
110927
|
+
"default": {
|
|
110928
|
+
"value": null
|
|
110929
|
+
}
|
|
110930
|
+
}
|
|
110931
|
+
}
|
|
110932
|
+
}
|
|
110933
|
+
},
|
|
110934
|
+
"409": {
|
|
110935
|
+
"description": "Conflict",
|
|
110936
|
+
"content": {
|
|
110937
|
+
"application/json": {
|
|
110938
|
+
"schema": {
|
|
110939
|
+
"title": "Basic Error",
|
|
110940
|
+
"description": "Basic Error",
|
|
110941
|
+
"type": "object",
|
|
110942
|
+
"properties": {
|
|
110943
|
+
"message": {
|
|
110944
|
+
"type": "string"
|
|
110945
|
+
},
|
|
110946
|
+
"documentation_url": {
|
|
110947
|
+
"type": "string"
|
|
110948
|
+
},
|
|
110949
|
+
"url": {
|
|
110950
|
+
"type": "string"
|
|
110951
|
+
},
|
|
110952
|
+
"status": {
|
|
110953
|
+
"type": "string"
|
|
110954
|
+
}
|
|
110955
|
+
}
|
|
110956
|
+
}
|
|
110957
|
+
}
|
|
110958
|
+
}
|
|
110959
|
+
}
|
|
110960
|
+
},
|
|
110961
|
+
"x-github": {
|
|
110962
|
+
"githubCloudOnly": false,
|
|
110963
|
+
"enabledForGitHubApps": true,
|
|
110964
|
+
"category": "actions",
|
|
110965
|
+
"subcategory": "workflow-runs"
|
|
110966
|
+
},
|
|
110967
|
+
"x-octokit": {}
|
|
110968
|
+
}
|
|
110969
|
+
},
|
|
110875
110970
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
|
|
110876
110971
|
"get": {
|
|
110877
110972
|
"summary": "List jobs for a workflow run",
|
|
@@ -111192,7 +111287,7 @@
|
|
|
111192
111287
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
111193
111288
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
111194
111289
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
111195
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
111290
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
111196
111291
|
"status": "completed",
|
|
111197
111292
|
"conclusion": "success",
|
|
111198
111293
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -135996,7 +136091,7 @@
|
|
|
135996
136091
|
},
|
|
135997
136092
|
"patch": {
|
|
135998
136093
|
"summary": "Update a check run",
|
|
135999
|
-
"description": "**Note:** The
|
|
136094
|
+
"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.",
|
|
136000
136095
|
"tags": [
|
|
136001
136096
|
"checks"
|
|
136002
136097
|
],
|
|
@@ -143083,7 +143178,7 @@
|
|
|
143083
143178
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
143084
143179
|
"get": {
|
|
143085
143180
|
"summary": "List check runs in a check suite",
|
|
143086
|
-
"description": "
|
|
143181
|
+
"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.",
|
|
143087
143182
|
"tags": [
|
|
143088
143183
|
"checks"
|
|
143089
143184
|
],
|
|
@@ -158188,7 +158283,7 @@
|
|
|
158188
158283
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
158189
158284
|
"get": {
|
|
158190
158285
|
"summary": "List check runs for a Git reference",
|
|
158191
|
-
"description": "**Note:** The
|
|
158286
|
+
"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/github-ae@latest/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/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.",
|
|
158192
158287
|
"tags": [
|
|
158193
158288
|
"checks"
|
|
158194
158289
|
],
|
|
@@ -159245,7 +159340,7 @@
|
|
|
159245
159340
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
159246
159341
|
"get": {
|
|
159247
159342
|
"summary": "List check suites for a Git reference",
|
|
159248
|
-
"description": "
|
|
159343
|
+
"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`.",
|
|
159249
159344
|
"tags": [
|
|
159250
159345
|
"checks"
|
|
159251
159346
|
],
|
|
@@ -170622,6 +170717,11 @@
|
|
|
170622
170717
|
"type": "string",
|
|
170623
170718
|
"example": "MDQ6R2F0ZTM3NTU="
|
|
170624
170719
|
},
|
|
170720
|
+
"prevent_self_review": {
|
|
170721
|
+
"type": "boolean",
|
|
170722
|
+
"example": false,
|
|
170723
|
+
"description": "Whether deployments to this environment can be approved by the user who created the deployment."
|
|
170724
|
+
},
|
|
170625
170725
|
"type": {
|
|
170626
170726
|
"type": "string",
|
|
170627
170727
|
"example": "required_reviewers"
|
|
@@ -171027,6 +171127,7 @@
|
|
|
171027
171127
|
{
|
|
171028
171128
|
"id": 3755,
|
|
171029
171129
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
171130
|
+
"prevent_self_review": false,
|
|
171030
171131
|
"type": "required_reviewers",
|
|
171031
171132
|
"reviewers": [
|
|
171032
171133
|
{
|
|
@@ -171228,6 +171329,11 @@
|
|
|
171228
171329
|
"type": "string",
|
|
171229
171330
|
"example": "MDQ6R2F0ZTM3NTU="
|
|
171230
171331
|
},
|
|
171332
|
+
"prevent_self_review": {
|
|
171333
|
+
"type": "boolean",
|
|
171334
|
+
"example": false,
|
|
171335
|
+
"description": "Whether deployments to this environment can be approved by the user who created the deployment."
|
|
171336
|
+
},
|
|
171231
171337
|
"type": {
|
|
171232
171338
|
"type": "string",
|
|
171233
171339
|
"example": "required_reviewers"
|
|
@@ -171627,6 +171733,7 @@
|
|
|
171627
171733
|
{
|
|
171628
171734
|
"id": 3755,
|
|
171629
171735
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
171736
|
+
"prevent_self_review": false,
|
|
171630
171737
|
"type": "required_reviewers",
|
|
171631
171738
|
"reviewers": [
|
|
171632
171739
|
{
|
|
@@ -171750,6 +171857,11 @@
|
|
|
171750
171857
|
"example": 30,
|
|
171751
171858
|
"description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."
|
|
171752
171859
|
},
|
|
171860
|
+
"prevent_self_review": {
|
|
171861
|
+
"type": "boolean",
|
|
171862
|
+
"example": false,
|
|
171863
|
+
"description": "Whether or not a user who created the job is prevented from approving their own job."
|
|
171864
|
+
},
|
|
171753
171865
|
"reviewers": {
|
|
171754
171866
|
"type": "array",
|
|
171755
171867
|
"nullable": true,
|
|
@@ -171800,6 +171912,7 @@
|
|
|
171800
171912
|
"default": {
|
|
171801
171913
|
"value": {
|
|
171802
171914
|
"wait_timer": 30,
|
|
171915
|
+
"prevent_self_review": false,
|
|
171803
171916
|
"reviewers": [
|
|
171804
171917
|
{
|
|
171805
171918
|
"type": "User",
|
|
@@ -171907,6 +172020,11 @@
|
|
|
171907
172020
|
"type": "string",
|
|
171908
172021
|
"example": "MDQ6R2F0ZTM3NTU="
|
|
171909
172022
|
},
|
|
172023
|
+
"prevent_self_review": {
|
|
172024
|
+
"type": "boolean",
|
|
172025
|
+
"example": false,
|
|
172026
|
+
"description": "Whether deployments to this environment can be approved by the user who created the deployment."
|
|
172027
|
+
},
|
|
171910
172028
|
"type": {
|
|
171911
172029
|
"type": "string",
|
|
171912
172030
|
"example": "required_reviewers"
|
|
@@ -172306,6 +172424,7 @@
|
|
|
172306
172424
|
{
|
|
172307
172425
|
"id": 3755,
|
|
172308
172426
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
172427
|
+
"prevent_self_review": false,
|
|
172309
172428
|
"type": "required_reviewers",
|
|
172310
172429
|
"reviewers": [
|
|
172311
172430
|
{
|
|
@@ -172532,11 +172651,11 @@
|
|
|
172532
172651
|
"type": "array",
|
|
172533
172652
|
"items": {
|
|
172534
172653
|
"title": "Deployment branch policy",
|
|
172535
|
-
"description": "Details of a deployment branch policy.",
|
|
172654
|
+
"description": "Details of a deployment branch or tag policy.",
|
|
172536
172655
|
"type": "object",
|
|
172537
172656
|
"properties": {
|
|
172538
172657
|
"id": {
|
|
172539
|
-
"description": "The unique identifier of the branch policy.",
|
|
172658
|
+
"description": "The unique identifier of the branch or tag policy.",
|
|
172540
172659
|
"type": "integer",
|
|
172541
172660
|
"example": 361471
|
|
172542
172661
|
},
|
|
@@ -172545,9 +172664,18 @@
|
|
|
172545
172664
|
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
172546
172665
|
},
|
|
172547
172666
|
"name": {
|
|
172548
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
172667
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.",
|
|
172549
172668
|
"type": "string",
|
|
172550
172669
|
"example": "release/*"
|
|
172670
|
+
},
|
|
172671
|
+
"type": {
|
|
172672
|
+
"description": "Whether this rule targets a branch or tag.",
|
|
172673
|
+
"type": "string",
|
|
172674
|
+
"example": "branch",
|
|
172675
|
+
"enum": [
|
|
172676
|
+
"branch",
|
|
172677
|
+
"tag"
|
|
172678
|
+
]
|
|
172551
172679
|
}
|
|
172552
172680
|
}
|
|
172553
172681
|
}
|
|
@@ -172591,7 +172719,7 @@
|
|
|
172591
172719
|
},
|
|
172592
172720
|
"post": {
|
|
172593
172721
|
"summary": "Create a deployment branch policy",
|
|
172594
|
-
"description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
172722
|
+
"description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
172595
172723
|
"tags": [
|
|
172596
172724
|
"repos"
|
|
172597
172725
|
],
|
|
@@ -172634,13 +172762,22 @@
|
|
|
172634
172762
|
"content": {
|
|
172635
172763
|
"application/json": {
|
|
172636
172764
|
"schema": {
|
|
172637
|
-
"title": "Deployment branch policy name pattern",
|
|
172765
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
172638
172766
|
"type": "object",
|
|
172639
172767
|
"properties": {
|
|
172640
172768
|
"name": {
|
|
172641
|
-
"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).",
|
|
172769
|
+
"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).",
|
|
172642
172770
|
"type": "string",
|
|
172643
172771
|
"example": "release/*"
|
|
172772
|
+
},
|
|
172773
|
+
"type": {
|
|
172774
|
+
"description": "Whether this rule targets a branch or tag",
|
|
172775
|
+
"type": "string",
|
|
172776
|
+
"example": "branch",
|
|
172777
|
+
"enum": [
|
|
172778
|
+
"branch",
|
|
172779
|
+
"tag"
|
|
172780
|
+
]
|
|
172644
172781
|
}
|
|
172645
172782
|
},
|
|
172646
172783
|
"required": [
|
|
@@ -172657,7 +172794,15 @@
|
|
|
172657
172794
|
"example-single-branch": {
|
|
172658
172795
|
"summary": "Example of a single branch name pattern",
|
|
172659
172796
|
"value": {
|
|
172660
|
-
"name": "main"
|
|
172797
|
+
"name": "main",
|
|
172798
|
+
"type": "branch"
|
|
172799
|
+
}
|
|
172800
|
+
},
|
|
172801
|
+
"example-single-tag": {
|
|
172802
|
+
"summary": "Example of a single tag name pattern",
|
|
172803
|
+
"value": {
|
|
172804
|
+
"name": "v1",
|
|
172805
|
+
"type": "tag"
|
|
172661
172806
|
}
|
|
172662
172807
|
}
|
|
172663
172808
|
}
|
|
@@ -172671,11 +172816,11 @@
|
|
|
172671
172816
|
"application/json": {
|
|
172672
172817
|
"schema": {
|
|
172673
172818
|
"title": "Deployment branch policy",
|
|
172674
|
-
"description": "Details of a deployment branch policy.",
|
|
172819
|
+
"description": "Details of a deployment branch or tag policy.",
|
|
172675
172820
|
"type": "object",
|
|
172676
172821
|
"properties": {
|
|
172677
172822
|
"id": {
|
|
172678
|
-
"description": "The unique identifier of the branch policy.",
|
|
172823
|
+
"description": "The unique identifier of the branch or tag policy.",
|
|
172679
172824
|
"type": "integer",
|
|
172680
172825
|
"example": 361471
|
|
172681
172826
|
},
|
|
@@ -172684,9 +172829,18 @@
|
|
|
172684
172829
|
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
172685
172830
|
},
|
|
172686
172831
|
"name": {
|
|
172687
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
172832
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.",
|
|
172688
172833
|
"type": "string",
|
|
172689
172834
|
"example": "release/*"
|
|
172835
|
+
},
|
|
172836
|
+
"type": {
|
|
172837
|
+
"description": "Whether this rule targets a branch or tag.",
|
|
172838
|
+
"type": "string",
|
|
172839
|
+
"example": "branch",
|
|
172840
|
+
"enum": [
|
|
172841
|
+
"branch",
|
|
172842
|
+
"tag"
|
|
172843
|
+
]
|
|
172690
172844
|
}
|
|
172691
172845
|
}
|
|
172692
172846
|
},
|
|
@@ -172704,6 +172858,14 @@
|
|
|
172704
172858
|
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
172705
172859
|
"name": "main"
|
|
172706
172860
|
}
|
|
172861
|
+
},
|
|
172862
|
+
"example-single-tag": {
|
|
172863
|
+
"value": {
|
|
172864
|
+
"id": 364663,
|
|
172865
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
172866
|
+
"name": "v1",
|
|
172867
|
+
"type": "tag"
|
|
172868
|
+
}
|
|
172707
172869
|
}
|
|
172708
172870
|
}
|
|
172709
172871
|
}
|
|
@@ -172728,7 +172890,7 @@
|
|
|
172728
172890
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
172729
172891
|
"get": {
|
|
172730
172892
|
"summary": "Get a deployment branch policy",
|
|
172731
|
-
"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 `actions:read` permission to use this endpoint.",
|
|
172893
|
+
"description": "Gets a deployment branch or tag 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 `actions:read` permission to use this endpoint.",
|
|
172732
172894
|
"tags": [
|
|
172733
172895
|
"repos"
|
|
172734
172896
|
],
|
|
@@ -172782,11 +172944,11 @@
|
|
|
172782
172944
|
"application/json": {
|
|
172783
172945
|
"schema": {
|
|
172784
172946
|
"title": "Deployment branch policy",
|
|
172785
|
-
"description": "Details of a deployment branch policy.",
|
|
172947
|
+
"description": "Details of a deployment branch or tag policy.",
|
|
172786
172948
|
"type": "object",
|
|
172787
172949
|
"properties": {
|
|
172788
172950
|
"id": {
|
|
172789
|
-
"description": "The unique identifier of the branch policy.",
|
|
172951
|
+
"description": "The unique identifier of the branch or tag policy.",
|
|
172790
172952
|
"type": "integer",
|
|
172791
172953
|
"example": 361471
|
|
172792
172954
|
},
|
|
@@ -172795,9 +172957,18 @@
|
|
|
172795
172957
|
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
172796
172958
|
},
|
|
172797
172959
|
"name": {
|
|
172798
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
172960
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.",
|
|
172799
172961
|
"type": "string",
|
|
172800
172962
|
"example": "release/*"
|
|
172963
|
+
},
|
|
172964
|
+
"type": {
|
|
172965
|
+
"description": "Whether this rule targets a branch or tag.",
|
|
172966
|
+
"type": "string",
|
|
172967
|
+
"example": "branch",
|
|
172968
|
+
"enum": [
|
|
172969
|
+
"branch",
|
|
172970
|
+
"tag"
|
|
172971
|
+
]
|
|
172801
172972
|
}
|
|
172802
172973
|
}
|
|
172803
172974
|
},
|
|
@@ -172824,7 +172995,7 @@
|
|
|
172824
172995
|
},
|
|
172825
172996
|
"put": {
|
|
172826
172997
|
"summary": "Update a deployment branch policy",
|
|
172827
|
-
"description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
172998
|
+
"description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
172828
172999
|
"tags": [
|
|
172829
173000
|
"repos"
|
|
172830
173001
|
],
|
|
@@ -172906,11 +173077,11 @@
|
|
|
172906
173077
|
"application/json": {
|
|
172907
173078
|
"schema": {
|
|
172908
173079
|
"title": "Deployment branch policy",
|
|
172909
|
-
"description": "Details of a deployment branch policy.",
|
|
173080
|
+
"description": "Details of a deployment branch or tag policy.",
|
|
172910
173081
|
"type": "object",
|
|
172911
173082
|
"properties": {
|
|
172912
173083
|
"id": {
|
|
172913
|
-
"description": "The unique identifier of the branch policy.",
|
|
173084
|
+
"description": "The unique identifier of the branch or tag policy.",
|
|
172914
173085
|
"type": "integer",
|
|
172915
173086
|
"example": 361471
|
|
172916
173087
|
},
|
|
@@ -172919,9 +173090,18 @@
|
|
|
172919
173090
|
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
172920
173091
|
},
|
|
172921
173092
|
"name": {
|
|
172922
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
173093
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.",
|
|
172923
173094
|
"type": "string",
|
|
172924
173095
|
"example": "release/*"
|
|
173096
|
+
},
|
|
173097
|
+
"type": {
|
|
173098
|
+
"description": "Whether this rule targets a branch or tag.",
|
|
173099
|
+
"type": "string",
|
|
173100
|
+
"example": "branch",
|
|
173101
|
+
"enum": [
|
|
173102
|
+
"branch",
|
|
173103
|
+
"tag"
|
|
173104
|
+
]
|
|
172925
173105
|
}
|
|
172926
173106
|
}
|
|
172927
173107
|
},
|
|
@@ -172948,7 +173128,7 @@
|
|
|
172948
173128
|
},
|
|
172949
173129
|
"delete": {
|
|
172950
173130
|
"summary": "Delete a deployment branch policy",
|
|
172951
|
-
"description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
173131
|
+
"description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
172952
173132
|
"tags": [
|
|
172953
173133
|
"repos"
|
|
172954
173134
|
],
|
|
@@ -181305,7 +181485,6 @@
|
|
|
181305
181485
|
"forks",
|
|
181306
181486
|
"forks_count",
|
|
181307
181487
|
"git_url",
|
|
181308
|
-
"has_downloads",
|
|
181309
181488
|
"has_issues",
|
|
181310
181489
|
"has_projects",
|
|
181311
181490
|
"has_wiki",
|
|
@@ -186143,7 +186322,7 @@
|
|
|
186143
186322
|
},
|
|
186144
186323
|
{
|
|
186145
186324
|
"name": "hook_id",
|
|
186146
|
-
"description": "The unique identifier of the hook.",
|
|
186325
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
186147
186326
|
"in": "path",
|
|
186148
186327
|
"required": true,
|
|
186149
186328
|
"schema": {
|
|
@@ -186416,7 +186595,7 @@
|
|
|
186416
186595
|
},
|
|
186417
186596
|
{
|
|
186418
186597
|
"name": "hook_id",
|
|
186419
|
-
"description": "The unique identifier of the hook.",
|
|
186598
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
186420
186599
|
"in": "path",
|
|
186421
186600
|
"required": true,
|
|
186422
186601
|
"schema": {
|
|
@@ -186854,7 +187033,7 @@
|
|
|
186854
187033
|
},
|
|
186855
187034
|
{
|
|
186856
187035
|
"name": "hook_id",
|
|
186857
|
-
"description": "The unique identifier of the hook.",
|
|
187036
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
186858
187037
|
"in": "path",
|
|
186859
187038
|
"required": true,
|
|
186860
187039
|
"schema": {
|
|
@@ -186935,7 +187114,7 @@
|
|
|
186935
187114
|
},
|
|
186936
187115
|
{
|
|
186937
187116
|
"name": "hook_id",
|
|
186938
|
-
"description": "The unique identifier of the hook.",
|
|
187117
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
186939
187118
|
"in": "path",
|
|
186940
187119
|
"required": true,
|
|
186941
187120
|
"schema": {
|
|
@@ -187037,7 +187216,7 @@
|
|
|
187037
187216
|
},
|
|
187038
187217
|
{
|
|
187039
187218
|
"name": "hook_id",
|
|
187040
|
-
"description": "The unique identifier of the hook.",
|
|
187219
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
187041
187220
|
"in": "path",
|
|
187042
187221
|
"required": true,
|
|
187043
187222
|
"schema": {
|
|
@@ -187191,7 +187370,7 @@
|
|
|
187191
187370
|
},
|
|
187192
187371
|
{
|
|
187193
187372
|
"name": "hook_id",
|
|
187194
|
-
"description": "The unique identifier of the hook.",
|
|
187373
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
187195
187374
|
"in": "path",
|
|
187196
187375
|
"required": true,
|
|
187197
187376
|
"schema": {
|
|
@@ -187519,7 +187698,7 @@
|
|
|
187519
187698
|
},
|
|
187520
187699
|
{
|
|
187521
187700
|
"name": "hook_id",
|
|
187522
|
-
"description": "The unique identifier of the hook.",
|
|
187701
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
187523
187702
|
"in": "path",
|
|
187524
187703
|
"required": true,
|
|
187525
187704
|
"schema": {
|
|
@@ -187889,7 +188068,7 @@
|
|
|
187889
188068
|
},
|
|
187890
188069
|
{
|
|
187891
188070
|
"name": "hook_id",
|
|
187892
|
-
"description": "The unique identifier of the hook.",
|
|
188071
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
187893
188072
|
"in": "path",
|
|
187894
188073
|
"required": true,
|
|
187895
188074
|
"schema": {
|
|
@@ -188093,7 +188272,7 @@
|
|
|
188093
188272
|
},
|
|
188094
188273
|
{
|
|
188095
188274
|
"name": "hook_id",
|
|
188096
|
-
"description": "The unique identifier of the hook.",
|
|
188275
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
188097
188276
|
"in": "path",
|
|
188098
188277
|
"required": true,
|
|
188099
188278
|
"schema": {
|
|
@@ -188174,7 +188353,7 @@
|
|
|
188174
188353
|
},
|
|
188175
188354
|
{
|
|
188176
188355
|
"name": "hook_id",
|
|
188177
|
-
"description": "The unique identifier of the hook.",
|
|
188356
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
188178
188357
|
"in": "path",
|
|
188179
188358
|
"required": true,
|
|
188180
188359
|
"schema": {
|
|
@@ -260967,7 +261146,7 @@
|
|
|
260967
261146
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
260968
261147
|
"get": {
|
|
260969
261148
|
"summary": "List reactions for a pull request review comment",
|
|
260970
|
-
"description": "List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
261149
|
+
"description": "List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request).",
|
|
260971
261150
|
"tags": [
|
|
260972
261151
|
"reactions"
|
|
260973
261152
|
],
|
|
@@ -377671,7 +377850,7 @@
|
|
|
377671
377850
|
"format": "uri"
|
|
377672
377851
|
},
|
|
377673
377852
|
"conclusion": {
|
|
377674
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
377853
|
+
"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`.",
|
|
377675
377854
|
"type": "string",
|
|
377676
377855
|
"nullable": true,
|
|
377677
377856
|
"enum": [
|
|
@@ -379926,7 +380105,7 @@
|
|
|
379926
380105
|
"format": "uri"
|
|
379927
380106
|
},
|
|
379928
380107
|
"conclusion": {
|
|
379929
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
380108
|
+
"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.",
|
|
379930
380109
|
"type": "string",
|
|
379931
380110
|
"nullable": true,
|
|
379932
380111
|
"enum": [
|
|
@@ -382174,7 +382353,7 @@
|
|
|
382174
382353
|
"format": "uri"
|
|
382175
382354
|
},
|
|
382176
382355
|
"conclusion": {
|
|
382177
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
382356
|
+
"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.",
|
|
382178
382357
|
"type": "string",
|
|
382179
382358
|
"nullable": true,
|
|
382180
382359
|
"enum": [
|
|
@@ -384053,7 +384232,7 @@
|
|
|
384053
384232
|
]
|
|
384054
384233
|
},
|
|
384055
384234
|
"dismissed_reason": {
|
|
384056
|
-
"description": "The reason for dismissing or closing the alert.
|
|
384235
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
384057
384236
|
"type": "string",
|
|
384058
384237
|
"nullable": true,
|
|
384059
384238
|
"enum": [
|
|
@@ -385846,7 +386025,7 @@
|
|
|
385846
386025
|
]
|
|
385847
386026
|
},
|
|
385848
386027
|
"dismissed_reason": {
|
|
385849
|
-
"description": "The reason for dismissing or closing the alert.
|
|
386028
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
385850
386029
|
"type": "string",
|
|
385851
386030
|
"nullable": true,
|
|
385852
386031
|
"enum": [
|
|
@@ -389404,7 +389583,7 @@
|
|
|
389404
389583
|
]
|
|
389405
389584
|
},
|
|
389406
389585
|
"dismissed_reason": {
|
|
389407
|
-
"description": "The reason for dismissing or closing the alert.
|
|
389586
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
389408
389587
|
"type": "string",
|
|
389409
389588
|
"nullable": true,
|
|
389410
389589
|
"enum": [
|
|
@@ -432560,7 +432739,7 @@
|
|
|
432560
432739
|
"format": "date-time"
|
|
432561
432740
|
},
|
|
432562
432741
|
"conclusion": {
|
|
432563
|
-
"description": "The result of the completed check run.
|
|
432742
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
432564
432743
|
"type": "string",
|
|
432565
432744
|
"nullable": true,
|
|
432566
432745
|
"enum": [
|
|
@@ -527530,6 +527709,10 @@
|
|
|
527530
527709
|
"type": "string",
|
|
527531
527710
|
"format": "uri"
|
|
527532
527711
|
},
|
|
527712
|
+
"has_discussions": {
|
|
527713
|
+
"description": "Whether the repository has discussions enabled.",
|
|
527714
|
+
"type": "boolean"
|
|
527715
|
+
},
|
|
527533
527716
|
"has_downloads": {
|
|
527534
527717
|
"description": "Whether downloads are enabled.",
|
|
527535
527718
|
"type": "boolean",
|
|
@@ -527886,6 +528069,10 @@
|
|
|
527886
528069
|
},
|
|
527887
528070
|
"watchers_count": {
|
|
527888
528071
|
"type": "integer"
|
|
528072
|
+
},
|
|
528073
|
+
"web_commit_signoff_required": {
|
|
528074
|
+
"description": "Whether to require commit signoff.",
|
|
528075
|
+
"type": "boolean"
|
|
527889
528076
|
}
|
|
527890
528077
|
},
|
|
527891
528078
|
"required": [
|
|
@@ -799555,7 +799742,6 @@
|
|
|
799555
799742
|
"forks",
|
|
799556
799743
|
"forks_count",
|
|
799557
799744
|
"git_url",
|
|
799558
|
-
"has_downloads",
|
|
799559
799745
|
"has_issues",
|
|
799560
799746
|
"has_projects",
|
|
799561
799747
|
"has_wiki",
|
|
@@ -824702,7 +824888,7 @@
|
|
|
824702
824888
|
}
|
|
824703
824889
|
},
|
|
824704
824890
|
"x-github": {
|
|
824705
|
-
"githubCloudOnly":
|
|
824891
|
+
"githubCloudOnly": true,
|
|
824706
824892
|
"category": "webhooks",
|
|
824707
824893
|
"subcategory": "user",
|
|
824708
824894
|
"supported-webhook-types": [
|
|
@@ -826295,7 +826481,7 @@
|
|
|
826295
826481
|
}
|
|
826296
826482
|
},
|
|
826297
826483
|
"x-github": {
|
|
826298
|
-
"githubCloudOnly":
|
|
826484
|
+
"githubCloudOnly": true,
|
|
826299
826485
|
"category": "webhooks",
|
|
826300
826486
|
"subcategory": "user",
|
|
826301
826487
|
"supported-webhook-types": [
|