@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
package/generated/github.ae.json
CHANGED
|
@@ -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": {
|
|
@@ -11635,7 +11635,7 @@
|
|
|
11635
11635
|
},
|
|
11636
11636
|
"exclude": {
|
|
11637
11637
|
"type": "array",
|
|
11638
|
-
"description": "Exclude related items from being returned in the response in order to improve performance of the request.
|
|
11638
|
+
"description": "Exclude related items from being returned in the response in order to improve performance of the request.",
|
|
11639
11639
|
"items": {
|
|
11640
11640
|
"type": "string",
|
|
11641
11641
|
"enum": [
|
|
@@ -17528,7 +17528,7 @@
|
|
|
17528
17528
|
"/repos/{owner}/{repo}/actions/runners": {
|
|
17529
17529
|
"get": {
|
|
17530
17530
|
"summary": "List self-hosted runners for a repository",
|
|
17531
|
-
"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.\
|
|
17531
|
+
"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.",
|
|
17532
17532
|
"tags": [
|
|
17533
17533
|
"actions"
|
|
17534
17534
|
],
|
|
@@ -17600,7 +17600,7 @@
|
|
|
17600
17600
|
"/repos/{owner}/{repo}/actions/runners/downloads": {
|
|
17601
17601
|
"get": {
|
|
17602
17602
|
"summary": "List runner applications for a repository",
|
|
17603
|
-
"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.\
|
|
17603
|
+
"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.",
|
|
17604
17604
|
"tags": [
|
|
17605
17605
|
"actions"
|
|
17606
17606
|
],
|
|
@@ -17649,7 +17649,7 @@
|
|
|
17649
17649
|
"/repos/{owner}/{repo}/actions/runners/registration-token": {
|
|
17650
17650
|
"post": {
|
|
17651
17651
|
"summary": "Create a registration token for a repository",
|
|
17652
|
-
"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.\
|
|
17652
|
+
"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```",
|
|
17653
17653
|
"tags": [
|
|
17654
17654
|
"actions"
|
|
17655
17655
|
],
|
|
@@ -17695,7 +17695,7 @@
|
|
|
17695
17695
|
"/repos/{owner}/{repo}/actions/runners/remove-token": {
|
|
17696
17696
|
"post": {
|
|
17697
17697
|
"summary": "Create a remove token for a repository",
|
|
17698
|
-
"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.\
|
|
17698
|
+
"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```",
|
|
17699
17699
|
"tags": [
|
|
17700
17700
|
"actions"
|
|
17701
17701
|
],
|
|
@@ -17741,7 +17741,7 @@
|
|
|
17741
17741
|
"/repos/{owner}/{repo}/actions/runners/{runner_id}": {
|
|
17742
17742
|
"get": {
|
|
17743
17743
|
"summary": "Get a self-hosted runner for a repository",
|
|
17744
|
-
"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.\
|
|
17744
|
+
"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.",
|
|
17745
17745
|
"tags": [
|
|
17746
17746
|
"actions"
|
|
17747
17747
|
],
|
|
@@ -17788,7 +17788,7 @@
|
|
|
17788
17788
|
},
|
|
17789
17789
|
"delete": {
|
|
17790
17790
|
"summary": "Delete a self-hosted runner from a repository",
|
|
17791
|
-
"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.\
|
|
17791
|
+
"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.",
|
|
17792
17792
|
"tags": [
|
|
17793
17793
|
"actions"
|
|
17794
17794
|
],
|
|
@@ -18270,7 +18270,7 @@
|
|
|
18270
18270
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
18271
18271
|
"post": {
|
|
18272
18272
|
"summary": "Cancel a workflow run",
|
|
18273
|
-
"description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\
|
|
18273
|
+
"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.",
|
|
18274
18274
|
"tags": [
|
|
18275
18275
|
"actions"
|
|
18276
18276
|
],
|
|
@@ -18319,6 +18319,58 @@
|
|
|
18319
18319
|
"x-octokit": {}
|
|
18320
18320
|
}
|
|
18321
18321
|
},
|
|
18322
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": {
|
|
18323
|
+
"post": {
|
|
18324
|
+
"summary": "Force cancel a workflow run",
|
|
18325
|
+
"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.",
|
|
18326
|
+
"tags": [
|
|
18327
|
+
"actions"
|
|
18328
|
+
],
|
|
18329
|
+
"operationId": "actions/force-cancel-workflow-run",
|
|
18330
|
+
"externalDocs": {
|
|
18331
|
+
"description": "API method documentation",
|
|
18332
|
+
"url": "https://docs.github.com/github-ae@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run"
|
|
18333
|
+
},
|
|
18334
|
+
"parameters": [
|
|
18335
|
+
{
|
|
18336
|
+
"$ref": "#/components/parameters/owner"
|
|
18337
|
+
},
|
|
18338
|
+
{
|
|
18339
|
+
"$ref": "#/components/parameters/repo"
|
|
18340
|
+
},
|
|
18341
|
+
{
|
|
18342
|
+
"$ref": "#/components/parameters/run-id"
|
|
18343
|
+
}
|
|
18344
|
+
],
|
|
18345
|
+
"responses": {
|
|
18346
|
+
"202": {
|
|
18347
|
+
"description": "Response",
|
|
18348
|
+
"content": {
|
|
18349
|
+
"application/json": {
|
|
18350
|
+
"schema": {
|
|
18351
|
+
"$ref": "#/components/schemas/empty-object"
|
|
18352
|
+
},
|
|
18353
|
+
"examples": {
|
|
18354
|
+
"default": {
|
|
18355
|
+
"value": null
|
|
18356
|
+
}
|
|
18357
|
+
}
|
|
18358
|
+
}
|
|
18359
|
+
}
|
|
18360
|
+
},
|
|
18361
|
+
"409": {
|
|
18362
|
+
"$ref": "#/components/responses/conflict"
|
|
18363
|
+
}
|
|
18364
|
+
},
|
|
18365
|
+
"x-github": {
|
|
18366
|
+
"githubCloudOnly": false,
|
|
18367
|
+
"enabledForGitHubApps": true,
|
|
18368
|
+
"category": "actions",
|
|
18369
|
+
"subcategory": "workflow-runs"
|
|
18370
|
+
},
|
|
18371
|
+
"x-octokit": {}
|
|
18372
|
+
}
|
|
18373
|
+
},
|
|
18322
18374
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
|
|
18323
18375
|
"get": {
|
|
18324
18376
|
"summary": "List jobs for a workflow run",
|
|
@@ -22724,7 +22776,7 @@
|
|
|
22724
22776
|
},
|
|
22725
22777
|
"patch": {
|
|
22726
22778
|
"summary": "Update a check run",
|
|
22727
|
-
"description": "**Note:** The
|
|
22779
|
+
"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.",
|
|
22728
22780
|
"tags": [
|
|
22729
22781
|
"checks"
|
|
22730
22782
|
],
|
|
@@ -23397,7 +23449,7 @@
|
|
|
23397
23449
|
"/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": {
|
|
23398
23450
|
"get": {
|
|
23399
23451
|
"summary": "List check runs in a check suite",
|
|
23400
|
-
"description": "
|
|
23452
|
+
"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.",
|
|
23401
23453
|
"tags": [
|
|
23402
23454
|
"checks"
|
|
23403
23455
|
],
|
|
@@ -25620,7 +25672,7 @@
|
|
|
25620
25672
|
"/repos/{owner}/{repo}/commits/{ref}/check-runs": {
|
|
25621
25673
|
"get": {
|
|
25622
25674
|
"summary": "List check runs for a Git reference",
|
|
25623
|
-
"description": "**Note:** The
|
|
25675
|
+
"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.",
|
|
25624
25676
|
"tags": [
|
|
25625
25677
|
"checks"
|
|
25626
25678
|
],
|
|
@@ -25723,7 +25775,7 @@
|
|
|
25723
25775
|
"/repos/{owner}/{repo}/commits/{ref}/check-suites": {
|
|
25724
25776
|
"get": {
|
|
25725
25777
|
"summary": "List check suites for a Git reference",
|
|
25726
|
-
"description": "
|
|
25778
|
+
"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`.",
|
|
25727
25779
|
"tags": [
|
|
25728
25780
|
"checks"
|
|
25729
25781
|
],
|
|
@@ -27332,6 +27384,9 @@
|
|
|
27332
27384
|
"wait_timer": {
|
|
27333
27385
|
"$ref": "#/components/schemas/wait-timer"
|
|
27334
27386
|
},
|
|
27387
|
+
"prevent_self_review": {
|
|
27388
|
+
"$ref": "#/components/schemas/prevent-self-review"
|
|
27389
|
+
},
|
|
27335
27390
|
"reviewers": {
|
|
27336
27391
|
"type": "array",
|
|
27337
27392
|
"nullable": true,
|
|
@@ -27360,6 +27415,7 @@
|
|
|
27360
27415
|
"default": {
|
|
27361
27416
|
"value": {
|
|
27362
27417
|
"wait_timer": 30,
|
|
27418
|
+
"prevent_self_review": false,
|
|
27363
27419
|
"reviewers": [
|
|
27364
27420
|
{
|
|
27365
27421
|
"type": "User",
|
|
@@ -27524,7 +27580,7 @@
|
|
|
27524
27580
|
},
|
|
27525
27581
|
"post": {
|
|
27526
27582
|
"summary": "Create a deployment branch policy",
|
|
27527
|
-
"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.",
|
|
27583
|
+
"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.",
|
|
27528
27584
|
"tags": [
|
|
27529
27585
|
"repos"
|
|
27530
27586
|
],
|
|
@@ -27549,7 +27605,7 @@
|
|
|
27549
27605
|
"content": {
|
|
27550
27606
|
"application/json": {
|
|
27551
27607
|
"schema": {
|
|
27552
|
-
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
|
|
27608
|
+
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type"
|
|
27553
27609
|
},
|
|
27554
27610
|
"examples": {
|
|
27555
27611
|
"example-wildcard": {
|
|
@@ -27561,7 +27617,15 @@
|
|
|
27561
27617
|
"example-single-branch": {
|
|
27562
27618
|
"summary": "Example of a single branch name pattern",
|
|
27563
27619
|
"value": {
|
|
27564
|
-
"name": "main"
|
|
27620
|
+
"name": "main",
|
|
27621
|
+
"type": "branch"
|
|
27622
|
+
}
|
|
27623
|
+
},
|
|
27624
|
+
"example-single-tag": {
|
|
27625
|
+
"summary": "Example of a single tag name pattern",
|
|
27626
|
+
"value": {
|
|
27627
|
+
"name": "v1",
|
|
27628
|
+
"type": "tag"
|
|
27565
27629
|
}
|
|
27566
27630
|
}
|
|
27567
27631
|
}
|
|
@@ -27582,6 +27646,9 @@
|
|
|
27582
27646
|
},
|
|
27583
27647
|
"example-single-branch": {
|
|
27584
27648
|
"$ref": "#/components/examples/deployment-branch-policy-single-branch"
|
|
27649
|
+
},
|
|
27650
|
+
"example-single-tag": {
|
|
27651
|
+
"$ref": "#/components/examples/deployment-branch-policy-single-tag"
|
|
27585
27652
|
}
|
|
27586
27653
|
}
|
|
27587
27654
|
}
|
|
@@ -27606,7 +27673,7 @@
|
|
|
27606
27673
|
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
27607
27674
|
"get": {
|
|
27608
27675
|
"summary": "Get a deployment branch policy",
|
|
27609
|
-
"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.",
|
|
27676
|
+
"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.",
|
|
27610
27677
|
"tags": [
|
|
27611
27678
|
"repos"
|
|
27612
27679
|
],
|
|
@@ -27656,7 +27723,7 @@
|
|
|
27656
27723
|
},
|
|
27657
27724
|
"put": {
|
|
27658
27725
|
"summary": "Update a deployment branch policy",
|
|
27659
|
-
"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.",
|
|
27726
|
+
"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.",
|
|
27660
27727
|
"tags": [
|
|
27661
27728
|
"repos"
|
|
27662
27729
|
],
|
|
@@ -27723,7 +27790,7 @@
|
|
|
27723
27790
|
},
|
|
27724
27791
|
"delete": {
|
|
27725
27792
|
"summary": "Delete a deployment branch policy",
|
|
27726
|
-
"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.",
|
|
27793
|
+
"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.",
|
|
27727
27794
|
"tags": [
|
|
27728
27795
|
"repos"
|
|
27729
27796
|
],
|
|
@@ -35344,7 +35411,7 @@
|
|
|
35344
35411
|
"/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
|
|
35345
35412
|
"get": {
|
|
35346
35413
|
"summary": "List reactions for a pull request review comment",
|
|
35347
|
-
"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).",
|
|
35414
|
+
"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).",
|
|
35348
35415
|
"tags": [
|
|
35349
35416
|
"reactions"
|
|
35350
35417
|
],
|
|
@@ -64820,7 +64887,7 @@
|
|
|
64820
64887
|
}
|
|
64821
64888
|
},
|
|
64822
64889
|
"x-github": {
|
|
64823
|
-
"githubCloudOnly":
|
|
64890
|
+
"githubCloudOnly": true,
|
|
64824
64891
|
"category": "webhooks",
|
|
64825
64892
|
"subcategory": "user",
|
|
64826
64893
|
"supported-webhook-types": [
|
|
@@ -64911,7 +64978,7 @@
|
|
|
64911
64978
|
}
|
|
64912
64979
|
},
|
|
64913
64980
|
"x-github": {
|
|
64914
|
-
"githubCloudOnly":
|
|
64981
|
+
"githubCloudOnly": true,
|
|
64915
64982
|
"category": "webhooks",
|
|
64916
64983
|
"subcategory": "user",
|
|
64917
64984
|
"supported-webhook-types": [
|
|
@@ -76337,7 +76404,6 @@
|
|
|
76337
76404
|
"forks",
|
|
76338
76405
|
"forks_count",
|
|
76339
76406
|
"git_url",
|
|
76340
|
-
"has_downloads",
|
|
76341
76407
|
"has_issues",
|
|
76342
76408
|
"has_projects",
|
|
76343
76409
|
"has_wiki",
|
|
@@ -81565,6 +81631,11 @@
|
|
|
81565
81631
|
"type": "string",
|
|
81566
81632
|
"example": "MDQ6R2F0ZTM3NTU="
|
|
81567
81633
|
},
|
|
81634
|
+
"prevent_self_review": {
|
|
81635
|
+
"type": "boolean",
|
|
81636
|
+
"example": false,
|
|
81637
|
+
"description": "Whether deployments to this environment can be approved by the user who created the deployment."
|
|
81638
|
+
},
|
|
81568
81639
|
"type": {
|
|
81569
81640
|
"type": "string",
|
|
81570
81641
|
"example": "required_reviewers"
|
|
@@ -81637,13 +81708,18 @@
|
|
|
81637
81708
|
"updated_at"
|
|
81638
81709
|
]
|
|
81639
81710
|
},
|
|
81711
|
+
"prevent-self-review": {
|
|
81712
|
+
"type": "boolean",
|
|
81713
|
+
"example": false,
|
|
81714
|
+
"description": "Whether or not a user who created the job is prevented from approving their own job."
|
|
81715
|
+
},
|
|
81640
81716
|
"deployment-branch-policy": {
|
|
81641
81717
|
"title": "Deployment branch policy",
|
|
81642
|
-
"description": "Details of a deployment branch policy.",
|
|
81718
|
+
"description": "Details of a deployment branch or tag policy.",
|
|
81643
81719
|
"type": "object",
|
|
81644
81720
|
"properties": {
|
|
81645
81721
|
"id": {
|
|
81646
|
-
"description": "The unique identifier of the branch policy.",
|
|
81722
|
+
"description": "The unique identifier of the branch or tag policy.",
|
|
81647
81723
|
"type": "integer",
|
|
81648
81724
|
"example": 361471
|
|
81649
81725
|
},
|
|
@@ -81652,12 +81728,44 @@
|
|
|
81652
81728
|
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
81653
81729
|
},
|
|
81654
81730
|
"name": {
|
|
81655
|
-
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
81731
|
+
"description": "The name pattern that branches or tags must match in order to deploy to the environment.",
|
|
81656
81732
|
"type": "string",
|
|
81657
81733
|
"example": "release/*"
|
|
81734
|
+
},
|
|
81735
|
+
"type": {
|
|
81736
|
+
"description": "Whether this rule targets a branch or tag.",
|
|
81737
|
+
"type": "string",
|
|
81738
|
+
"example": "branch",
|
|
81739
|
+
"enum": [
|
|
81740
|
+
"branch",
|
|
81741
|
+
"tag"
|
|
81742
|
+
]
|
|
81658
81743
|
}
|
|
81659
81744
|
}
|
|
81660
81745
|
},
|
|
81746
|
+
"deployment-branch-policy-name-pattern-with-type": {
|
|
81747
|
+
"title": "Deployment branch and tag policy name pattern",
|
|
81748
|
+
"type": "object",
|
|
81749
|
+
"properties": {
|
|
81750
|
+
"name": {
|
|
81751
|
+
"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).",
|
|
81752
|
+
"type": "string",
|
|
81753
|
+
"example": "release/*"
|
|
81754
|
+
},
|
|
81755
|
+
"type": {
|
|
81756
|
+
"description": "Whether this rule targets a branch or tag",
|
|
81757
|
+
"type": "string",
|
|
81758
|
+
"example": "branch",
|
|
81759
|
+
"enum": [
|
|
81760
|
+
"branch",
|
|
81761
|
+
"tag"
|
|
81762
|
+
]
|
|
81763
|
+
}
|
|
81764
|
+
},
|
|
81765
|
+
"required": [
|
|
81766
|
+
"name"
|
|
81767
|
+
]
|
|
81768
|
+
},
|
|
81661
81769
|
"deployment-branch-policy-name-pattern": {
|
|
81662
81770
|
"title": "Deployment branch policy name pattern",
|
|
81663
81771
|
"type": "object",
|
|
@@ -94181,7 +94289,7 @@
|
|
|
94181
94289
|
"format": "uri"
|
|
94182
94290
|
},
|
|
94183
94291
|
"conclusion": {
|
|
94184
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
94292
|
+
"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`.",
|
|
94185
94293
|
"type": "string",
|
|
94186
94294
|
"nullable": true,
|
|
94187
94295
|
"enum": [
|
|
@@ -94962,7 +95070,7 @@
|
|
|
94962
95070
|
"format": "uri"
|
|
94963
95071
|
},
|
|
94964
95072
|
"conclusion": {
|
|
94965
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
95073
|
+
"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.",
|
|
94966
95074
|
"type": "string",
|
|
94967
95075
|
"nullable": true,
|
|
94968
95076
|
"enum": [
|
|
@@ -95736,7 +95844,7 @@
|
|
|
95736
95844
|
"format": "uri"
|
|
95737
95845
|
},
|
|
95738
95846
|
"conclusion": {
|
|
95739
|
-
"description": "The summary conclusion for all check runs that are part of the check suite.
|
|
95847
|
+
"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.",
|
|
95740
95848
|
"type": "string",
|
|
95741
95849
|
"nullable": true,
|
|
95742
95850
|
"enum": [
|
|
@@ -96141,7 +96249,7 @@
|
|
|
96141
96249
|
]
|
|
96142
96250
|
},
|
|
96143
96251
|
"dismissed_reason": {
|
|
96144
|
-
"description": "The reason for dismissing or closing the alert.
|
|
96252
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
96145
96253
|
"type": "string",
|
|
96146
96254
|
"nullable": true,
|
|
96147
96255
|
"enum": [
|
|
@@ -96460,7 +96568,7 @@
|
|
|
96460
96568
|
]
|
|
96461
96569
|
},
|
|
96462
96570
|
"dismissed_reason": {
|
|
96463
|
-
"description": "The reason for dismissing or closing the alert.
|
|
96571
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
96464
96572
|
"type": "string",
|
|
96465
96573
|
"nullable": true,
|
|
96466
96574
|
"enum": [
|
|
@@ -97067,7 +97175,7 @@
|
|
|
97067
97175
|
]
|
|
97068
97176
|
},
|
|
97069
97177
|
"dismissed_reason": {
|
|
97070
|
-
"description": "The reason for dismissing or closing the alert.
|
|
97178
|
+
"description": "The reason for dismissing or closing the alert.",
|
|
97071
97179
|
"type": "string",
|
|
97072
97180
|
"nullable": true,
|
|
97073
97181
|
"enum": [
|
|
@@ -103560,7 +103668,7 @@
|
|
|
103560
103668
|
"format": "date-time"
|
|
103561
103669
|
},
|
|
103562
103670
|
"conclusion": {
|
|
103563
|
-
"description": "The result of the completed check run.
|
|
103671
|
+
"description": "The result of the completed check run. This value will be `null` until the check run has completed.",
|
|
103564
103672
|
"type": "string",
|
|
103565
103673
|
"nullable": true,
|
|
103566
103674
|
"enum": [
|
|
@@ -128287,6 +128395,10 @@
|
|
|
128287
128395
|
"type": "string",
|
|
128288
128396
|
"format": "uri"
|
|
128289
128397
|
},
|
|
128398
|
+
"has_discussions": {
|
|
128399
|
+
"description": "Whether the repository has discussions enabled.",
|
|
128400
|
+
"type": "boolean"
|
|
128401
|
+
},
|
|
128290
128402
|
"has_downloads": {
|
|
128291
128403
|
"description": "Whether downloads are enabled.",
|
|
128292
128404
|
"type": "boolean",
|
|
@@ -128643,6 +128755,10 @@
|
|
|
128643
128755
|
},
|
|
128644
128756
|
"watchers_count": {
|
|
128645
128757
|
"type": "integer"
|
|
128758
|
+
},
|
|
128759
|
+
"web_commit_signoff_required": {
|
|
128760
|
+
"description": "Whether to require commit signoff.",
|
|
128761
|
+
"type": "boolean"
|
|
128646
128762
|
}
|
|
128647
128763
|
},
|
|
128648
128764
|
"required": [
|
|
@@ -247417,7 +247533,7 @@
|
|
|
247417
247533
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
247418
247534
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
247419
247535
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
247420
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
247536
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
247421
247537
|
"status": "completed",
|
|
247422
247538
|
"conclusion": "success",
|
|
247423
247539
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -248019,7 +248135,7 @@
|
|
|
248019
248135
|
"node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
|
|
248020
248136
|
"head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
|
|
248021
248137
|
"url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496",
|
|
248022
|
-
"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
|
|
248138
|
+
"html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
|
|
248023
248139
|
"status": "completed",
|
|
248024
248140
|
"conclusion": "success",
|
|
248025
248141
|
"started_at": "2020-01-20T17:42:40Z",
|
|
@@ -252299,6 +252415,7 @@
|
|
|
252299
252415
|
{
|
|
252300
252416
|
"id": 3755,
|
|
252301
252417
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
252418
|
+
"prevent_self_review": false,
|
|
252302
252419
|
"type": "required_reviewers",
|
|
252303
252420
|
"reviewers": [
|
|
252304
252421
|
{
|
|
@@ -252377,6 +252494,7 @@
|
|
|
252377
252494
|
{
|
|
252378
252495
|
"id": 3755,
|
|
252379
252496
|
"node_id": "MDQ6R2F0ZTM3NTU=",
|
|
252497
|
+
"prevent_self_review": false,
|
|
252380
252498
|
"type": "required_reviewers",
|
|
252381
252499
|
"reviewers": [
|
|
252382
252500
|
{
|
|
@@ -252465,6 +252583,14 @@
|
|
|
252465
252583
|
"name": "main"
|
|
252466
252584
|
}
|
|
252467
252585
|
},
|
|
252586
|
+
"deployment-branch-policy-single-tag": {
|
|
252587
|
+
"value": {
|
|
252588
|
+
"id": 364663,
|
|
252589
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
252590
|
+
"name": "v1",
|
|
252591
|
+
"type": "tag"
|
|
252592
|
+
}
|
|
252593
|
+
},
|
|
252468
252594
|
"repo-events-items": {
|
|
252469
252595
|
"value": [
|
|
252470
252596
|
{
|
|
@@ -261653,7 +261779,7 @@
|
|
|
261653
261779
|
},
|
|
261654
261780
|
"hook-id": {
|
|
261655
261781
|
"name": "hook_id",
|
|
261656
|
-
"description": "The unique identifier of the hook.",
|
|
261782
|
+
"description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
|
|
261657
261783
|
"in": "path",
|
|
261658
261784
|
"required": true,
|
|
261659
261785
|
"schema": {
|