@octokit/openapi 13.0.0 → 13.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "13.0.0",
4
+ "version": "13.2.0",
5
5
  "title": "GitHub's official OpenAPI spec + Octokit extension",
6
6
  "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
7
7
  "license": {
@@ -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. The array can include any of: `\"repositories\"`.",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\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```",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\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```",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\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.",
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.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission 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 Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.",
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": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists 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.",
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 Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists 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.",
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": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists 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.",
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
  ],
@@ -29085,7 +29152,7 @@
29085
29152
  "operationId": "repos/list-webhooks",
29086
29153
  "externalDocs": {
29087
29154
  "description": "API method documentation",
29088
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#list-repository-webhooks"
29155
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#list-repository-webhooks"
29089
29156
  },
29090
29157
  "parameters": [
29091
29158
  {
@@ -29132,8 +29199,8 @@
29132
29199
  "x-github": {
29133
29200
  "githubCloudOnly": false,
29134
29201
  "enabledForGitHubApps": true,
29135
- "category": "webhooks",
29136
- "subcategory": "repos"
29202
+ "category": "repos",
29203
+ "subcategory": "webhooks"
29137
29204
  },
29138
29205
  "x-octokit": {}
29139
29206
  },
@@ -29146,7 +29213,7 @@
29146
29213
  "operationId": "repos/create-webhook",
29147
29214
  "externalDocs": {
29148
29215
  "description": "API method documentation",
29149
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#create-a-repository-webhook"
29216
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#create-a-repository-webhook"
29150
29217
  },
29151
29218
  "parameters": [
29152
29219
  {
@@ -29269,8 +29336,8 @@
29269
29336
  "x-github": {
29270
29337
  "githubCloudOnly": false,
29271
29338
  "enabledForGitHubApps": true,
29272
- "category": "webhooks",
29273
- "subcategory": "repos"
29339
+ "category": "repos",
29340
+ "subcategory": "webhooks"
29274
29341
  },
29275
29342
  "x-octokit": {}
29276
29343
  }
@@ -29285,7 +29352,7 @@
29285
29352
  "operationId": "repos/get-webhook",
29286
29353
  "externalDocs": {
29287
29354
  "description": "API method documentation",
29288
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#get-a-repository-webhook"
29355
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#get-a-repository-webhook"
29289
29356
  },
29290
29357
  "parameters": [
29291
29358
  {
@@ -29321,8 +29388,8 @@
29321
29388
  "x-github": {
29322
29389
  "githubCloudOnly": false,
29323
29390
  "enabledForGitHubApps": true,
29324
- "category": "webhooks",
29325
- "subcategory": "repos"
29391
+ "category": "repos",
29392
+ "subcategory": "webhooks"
29326
29393
  },
29327
29394
  "x-octokit": {}
29328
29395
  },
@@ -29335,7 +29402,7 @@
29335
29402
  "operationId": "repos/update-webhook",
29336
29403
  "externalDocs": {
29337
29404
  "description": "API method documentation",
29338
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#update-a-repository-webhook"
29405
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#update-a-repository-webhook"
29339
29406
  },
29340
29407
  "parameters": [
29341
29408
  {
@@ -29454,8 +29521,8 @@
29454
29521
  "x-github": {
29455
29522
  "githubCloudOnly": false,
29456
29523
  "enabledForGitHubApps": true,
29457
- "category": "webhooks",
29458
- "subcategory": "repos"
29524
+ "category": "repos",
29525
+ "subcategory": "webhooks"
29459
29526
  },
29460
29527
  "x-octokit": {}
29461
29528
  },
@@ -29468,7 +29535,7 @@
29468
29535
  "operationId": "repos/delete-webhook",
29469
29536
  "externalDocs": {
29470
29537
  "description": "API method documentation",
29471
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#delete-a-repository-webhook"
29538
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#delete-a-repository-webhook"
29472
29539
  },
29473
29540
  "parameters": [
29474
29541
  {
@@ -29492,8 +29559,8 @@
29492
29559
  "x-github": {
29493
29560
  "githubCloudOnly": false,
29494
29561
  "enabledForGitHubApps": true,
29495
- "category": "webhooks",
29496
- "subcategory": "repos"
29562
+ "category": "repos",
29563
+ "subcategory": "webhooks"
29497
29564
  },
29498
29565
  "x-octokit": {}
29499
29566
  }
@@ -29508,7 +29575,7 @@
29508
29575
  "operationId": "repos/get-webhook-config-for-repo",
29509
29576
  "externalDocs": {
29510
29577
  "description": "API method documentation",
29511
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repo-config#get-a-webhook-configuration-for-a-repository"
29578
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository"
29512
29579
  },
29513
29580
  "parameters": [
29514
29581
  {
@@ -29541,8 +29608,8 @@
29541
29608
  "x-github": {
29542
29609
  "githubCloudOnly": false,
29543
29610
  "enabledForGitHubApps": true,
29544
- "category": "webhooks",
29545
- "subcategory": "repo-config"
29611
+ "category": "repos",
29612
+ "subcategory": "webhooks"
29546
29613
  },
29547
29614
  "x-octokit": {}
29548
29615
  },
@@ -29555,7 +29622,7 @@
29555
29622
  "operationId": "repos/update-webhook-config-for-repo",
29556
29623
  "externalDocs": {
29557
29624
  "description": "API method documentation",
29558
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository"
29625
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository"
29559
29626
  },
29560
29627
  "parameters": [
29561
29628
  {
@@ -29622,8 +29689,8 @@
29622
29689
  "x-github": {
29623
29690
  "githubCloudOnly": false,
29624
29691
  "enabledForGitHubApps": true,
29625
- "category": "webhooks",
29626
- "subcategory": "repo-config"
29692
+ "category": "repos",
29693
+ "subcategory": "webhooks"
29627
29694
  },
29628
29695
  "x-octokit": {}
29629
29696
  }
@@ -29638,7 +29705,7 @@
29638
29705
  "operationId": "repos/list-webhook-deliveries",
29639
29706
  "externalDocs": {
29640
29707
  "description": "API method documentation",
29641
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repo-deliveries#list-deliveries-for-a-repository-webhook"
29708
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#list-deliveries-for-a-repository-webhook"
29642
29709
  },
29643
29710
  "parameters": [
29644
29711
  {
@@ -29694,8 +29761,8 @@
29694
29761
  "x-github": {
29695
29762
  "githubCloudOnly": false,
29696
29763
  "enabledForGitHubApps": true,
29697
- "category": "webhooks",
29698
- "subcategory": "repo-deliveries"
29764
+ "category": "repos",
29765
+ "subcategory": "webhooks"
29699
29766
  },
29700
29767
  "x-octokit": {}
29701
29768
  }
@@ -29710,7 +29777,7 @@
29710
29777
  "operationId": "repos/get-webhook-delivery",
29711
29778
  "externalDocs": {
29712
29779
  "description": "API method documentation",
29713
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repo-deliveries#get-a-delivery-for-a-repository-webhook"
29780
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook"
29714
29781
  },
29715
29782
  "parameters": [
29716
29783
  {
@@ -29752,8 +29819,8 @@
29752
29819
  "x-github": {
29753
29820
  "githubCloudOnly": false,
29754
29821
  "enabledForGitHubApps": true,
29755
- "category": "webhooks",
29756
- "subcategory": "repo-deliveries"
29822
+ "category": "repos",
29823
+ "subcategory": "webhooks"
29757
29824
  },
29758
29825
  "x-octokit": {}
29759
29826
  }
@@ -29768,7 +29835,7 @@
29768
29835
  "operationId": "repos/redeliver-webhook-delivery",
29769
29836
  "externalDocs": {
29770
29837
  "description": "API method documentation",
29771
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repo-deliveries#redeliver-a-delivery-for-a-repository-webhook"
29838
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook"
29772
29839
  },
29773
29840
  "parameters": [
29774
29841
  {
@@ -29798,8 +29865,8 @@
29798
29865
  "x-github": {
29799
29866
  "githubCloudOnly": false,
29800
29867
  "enabledForGitHubApps": true,
29801
- "category": "webhooks",
29802
- "subcategory": "repo-deliveries"
29868
+ "category": "repos",
29869
+ "subcategory": "webhooks"
29803
29870
  },
29804
29871
  "x-octokit": {}
29805
29872
  }
@@ -29814,7 +29881,7 @@
29814
29881
  "operationId": "repos/ping-webhook",
29815
29882
  "externalDocs": {
29816
29883
  "description": "API method documentation",
29817
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#ping-a-repository-webhook"
29884
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#ping-a-repository-webhook"
29818
29885
  },
29819
29886
  "parameters": [
29820
29887
  {
@@ -29838,8 +29905,8 @@
29838
29905
  "x-github": {
29839
29906
  "githubCloudOnly": false,
29840
29907
  "enabledForGitHubApps": true,
29841
- "category": "webhooks",
29842
- "subcategory": "repos"
29908
+ "category": "repos",
29909
+ "subcategory": "webhooks"
29843
29910
  },
29844
29911
  "x-octokit": {}
29845
29912
  }
@@ -29854,7 +29921,7 @@
29854
29921
  "operationId": "repos/test-push-webhook",
29855
29922
  "externalDocs": {
29856
29923
  "description": "API method documentation",
29857
- "url": "https://docs.github.com/github-ae@latest/rest/webhooks/repos#test-the-push-repository-webhook"
29924
+ "url": "https://docs.github.com/github-ae@latest/rest/repos/webhooks#test-the-push-repository-webhook"
29858
29925
  },
29859
29926
  "parameters": [
29860
29927
  {
@@ -29878,8 +29945,8 @@
29878
29945
  "x-github": {
29879
29946
  "githubCloudOnly": false,
29880
29947
  "enabledForGitHubApps": true,
29881
- "category": "webhooks",
29882
- "subcategory": "repos"
29948
+ "category": "repos",
29949
+ "subcategory": "webhooks"
29883
29950
  },
29884
29951
  "x-octokit": {}
29885
29952
  }
@@ -33318,6 +33385,9 @@
33318
33385
  }
33319
33386
  }
33320
33387
  }
33388
+ },
33389
+ "404": {
33390
+ "$ref": "#/components/responses/not_found"
33321
33391
  }
33322
33392
  },
33323
33393
  "x-github": {
@@ -35344,7 +35414,7 @@
35344
35414
  "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": {
35345
35415
  "get": {
35346
35416
  "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).",
35417
+ "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
35418
  "tags": [
35349
35419
  "reactions"
35350
35420
  ],
@@ -58780,7 +58850,7 @@
58780
58850
  "pull-request-edited": {
58781
58851
  "post": {
58782
58852
  "summary": "This event occurs when there is activity on a pull request. For more information, see \"[About pull requests](https://docs.github.com/github-ae@latest/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests).\" For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/github-ae@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/github-ae@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Pull requests\" repository permission.",
58783
- "description": "The title or body of a pull request was edited.",
58853
+ "description": "The title or body of a pull request was edited, or the base branch of a pull request was changed.",
58784
58854
  "operationId": "pull-request/edited",
58785
58855
  "externalDocs": {
58786
58856
  "url": "https://docs.github.com/github-ae@latest/webhooks/webhook-events-and-payloads#pull_request"
@@ -64820,7 +64890,7 @@
64820
64890
  }
64821
64891
  },
64822
64892
  "x-github": {
64823
- "githubCloudOnly": false,
64893
+ "githubCloudOnly": true,
64824
64894
  "category": "webhooks",
64825
64895
  "subcategory": "user",
64826
64896
  "supported-webhook-types": [
@@ -64911,7 +64981,7 @@
64911
64981
  }
64912
64982
  },
64913
64983
  "x-github": {
64914
- "githubCloudOnly": false,
64984
+ "githubCloudOnly": true,
64915
64985
  "category": "webhooks",
64916
64986
  "subcategory": "user",
64917
64987
  "supported-webhook-types": [
@@ -76337,7 +76407,6 @@
76337
76407
  "forks",
76338
76408
  "forks_count",
76339
76409
  "git_url",
76340
- "has_downloads",
76341
76410
  "has_issues",
76342
76411
  "has_projects",
76343
76412
  "has_wiki",
@@ -76503,7 +76572,8 @@
76503
76572
  "enum": [
76504
76573
  "queued",
76505
76574
  "in_progress",
76506
- "completed"
76575
+ "completed",
76576
+ "waiting"
76507
76577
  ]
76508
76578
  },
76509
76579
  "conclusion": {
@@ -81565,6 +81635,11 @@
81565
81635
  "type": "string",
81566
81636
  "example": "MDQ6R2F0ZTM3NTU="
81567
81637
  },
81638
+ "prevent_self_review": {
81639
+ "type": "boolean",
81640
+ "example": false,
81641
+ "description": "Whether deployments to this environment can be approved by the user who created the deployment."
81642
+ },
81568
81643
  "type": {
81569
81644
  "type": "string",
81570
81645
  "example": "required_reviewers"
@@ -81637,13 +81712,18 @@
81637
81712
  "updated_at"
81638
81713
  ]
81639
81714
  },
81715
+ "prevent-self-review": {
81716
+ "type": "boolean",
81717
+ "example": false,
81718
+ "description": "Whether or not a user who created the job is prevented from approving their own job."
81719
+ },
81640
81720
  "deployment-branch-policy": {
81641
81721
  "title": "Deployment branch policy",
81642
- "description": "Details of a deployment branch policy.",
81722
+ "description": "Details of a deployment branch or tag policy.",
81643
81723
  "type": "object",
81644
81724
  "properties": {
81645
81725
  "id": {
81646
- "description": "The unique identifier of the branch policy.",
81726
+ "description": "The unique identifier of the branch or tag policy.",
81647
81727
  "type": "integer",
81648
81728
  "example": 361471
81649
81729
  },
@@ -81652,12 +81732,44 @@
81652
81732
  "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
81653
81733
  },
81654
81734
  "name": {
81655
- "description": "The name pattern that branches must match in order to deploy to the environment.",
81735
+ "description": "The name pattern that branches or tags must match in order to deploy to the environment.",
81656
81736
  "type": "string",
81657
81737
  "example": "release/*"
81738
+ },
81739
+ "type": {
81740
+ "description": "Whether this rule targets a branch or tag.",
81741
+ "type": "string",
81742
+ "example": "branch",
81743
+ "enum": [
81744
+ "branch",
81745
+ "tag"
81746
+ ]
81658
81747
  }
81659
81748
  }
81660
81749
  },
81750
+ "deployment-branch-policy-name-pattern-with-type": {
81751
+ "title": "Deployment branch and tag policy name pattern",
81752
+ "type": "object",
81753
+ "properties": {
81754
+ "name": {
81755
+ "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).",
81756
+ "type": "string",
81757
+ "example": "release/*"
81758
+ },
81759
+ "type": {
81760
+ "description": "Whether this rule targets a branch or tag",
81761
+ "type": "string",
81762
+ "example": "branch",
81763
+ "enum": [
81764
+ "branch",
81765
+ "tag"
81766
+ ]
81767
+ }
81768
+ },
81769
+ "required": [
81770
+ "name"
81771
+ ]
81772
+ },
81661
81773
  "deployment-branch-policy-name-pattern": {
81662
81774
  "title": "Deployment branch policy name pattern",
81663
81775
  "type": "object",
@@ -94181,7 +94293,7 @@
94181
94293
  "format": "uri"
94182
94294
  },
94183
94295
  "conclusion": {
94184
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.",
94296
+ "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
94297
  "type": "string",
94186
94298
  "nullable": true,
94187
94299
  "enum": [
@@ -94962,7 +95074,7 @@
94962
95074
  "format": "uri"
94963
95075
  },
94964
95076
  "conclusion": {
94965
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
95077
+ "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
95078
  "type": "string",
94967
95079
  "nullable": true,
94968
95080
  "enum": [
@@ -95736,7 +95848,7 @@
95736
95848
  "format": "uri"
95737
95849
  },
95738
95850
  "conclusion": {
95739
- "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
95851
+ "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
95852
  "type": "string",
95741
95853
  "nullable": true,
95742
95854
  "enum": [
@@ -96141,7 +96253,7 @@
96141
96253
  ]
96142
96254
  },
96143
96255
  "dismissed_reason": {
96144
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
96256
+ "description": "The reason for dismissing or closing the alert.",
96145
96257
  "type": "string",
96146
96258
  "nullable": true,
96147
96259
  "enum": [
@@ -96460,7 +96572,7 @@
96460
96572
  ]
96461
96573
  },
96462
96574
  "dismissed_reason": {
96463
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
96575
+ "description": "The reason for dismissing or closing the alert.",
96464
96576
  "type": "string",
96465
96577
  "nullable": true,
96466
96578
  "enum": [
@@ -97067,7 +97179,7 @@
97067
97179
  ]
97068
97180
  },
97069
97181
  "dismissed_reason": {
97070
- "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
97182
+ "description": "The reason for dismissing or closing the alert.",
97071
97183
  "type": "string",
97072
97184
  "nullable": true,
97073
97185
  "enum": [
@@ -103560,7 +103672,7 @@
103560
103672
  "format": "date-time"
103561
103673
  },
103562
103674
  "conclusion": {
103563
- "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.",
103675
+ "description": "The result of the completed check run. This value will be `null` until the check run has completed.",
103564
103676
  "type": "string",
103565
103677
  "nullable": true,
103566
103678
  "enum": [
@@ -128287,6 +128399,10 @@
128287
128399
  "type": "string",
128288
128400
  "format": "uri"
128289
128401
  },
128402
+ "has_discussions": {
128403
+ "description": "Whether the repository has discussions enabled.",
128404
+ "type": "boolean"
128405
+ },
128290
128406
  "has_downloads": {
128291
128407
  "description": "Whether downloads are enabled.",
128292
128408
  "type": "boolean",
@@ -128643,6 +128759,10 @@
128643
128759
  },
128644
128760
  "watchers_count": {
128645
128761
  "type": "integer"
128762
+ },
128763
+ "web_commit_signoff_required": {
128764
+ "description": "Whether to require commit signoff.",
128765
+ "type": "boolean"
128646
128766
  }
128647
128767
  },
128648
128768
  "required": [
@@ -247417,7 +247537,7 @@
247417
247537
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
247418
247538
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
247419
247539
  "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",
247540
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
247421
247541
  "status": "completed",
247422
247542
  "conclusion": "success",
247423
247543
  "started_at": "2020-01-20T17:42:40Z",
@@ -248019,7 +248139,7 @@
248019
248139
  "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==",
248020
248140
  "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0",
248021
248141
  "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",
248142
+ "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",
248023
248143
  "status": "completed",
248024
248144
  "conclusion": "success",
248025
248145
  "started_at": "2020-01-20T17:42:40Z",
@@ -252299,6 +252419,7 @@
252299
252419
  {
252300
252420
  "id": 3755,
252301
252421
  "node_id": "MDQ6R2F0ZTM3NTU=",
252422
+ "prevent_self_review": false,
252302
252423
  "type": "required_reviewers",
252303
252424
  "reviewers": [
252304
252425
  {
@@ -252377,6 +252498,7 @@
252377
252498
  {
252378
252499
  "id": 3755,
252379
252500
  "node_id": "MDQ6R2F0ZTM3NTU=",
252501
+ "prevent_self_review": false,
252380
252502
  "type": "required_reviewers",
252381
252503
  "reviewers": [
252382
252504
  {
@@ -252465,6 +252587,14 @@
252465
252587
  "name": "main"
252466
252588
  }
252467
252589
  },
252590
+ "deployment-branch-policy-single-tag": {
252591
+ "value": {
252592
+ "id": 364663,
252593
+ "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
252594
+ "name": "v1",
252595
+ "type": "tag"
252596
+ }
252597
+ },
252468
252598
  "repo-events-items": {
252469
252599
  "value": [
252470
252600
  {
@@ -261653,7 +261783,7 @@
261653
261783
  },
261654
261784
  "hook-id": {
261655
261785
  "name": "hook_id",
261656
- "description": "The unique identifier of the hook.",
261786
+ "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.",
261657
261787
  "in": "path",
261658
261788
  "required": true,
261659
261789
  "schema": {