@octokit/openapi 11.0.0 → 11.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.
Files changed (29) hide show
  1. package/generated/api.github.com.deref.json +7446 -606
  2. package/generated/api.github.com.json +1135 -104
  3. package/generated/ghec-diff-to-api.github.com.deref.json +4944 -11
  4. package/generated/ghec-diff-to-api.github.com.json +92 -1
  5. package/generated/ghec.deref.json +7446 -606
  6. package/generated/ghec.json +1135 -104
  7. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +2 -2
  8. package/generated/ghes-3.5-diff-to-ghes-3.6.json +2 -2
  9. package/generated/ghes-3.5.deref.json +2 -2
  10. package/generated/ghes-3.5.json +2 -2
  11. package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +2 -2
  12. package/generated/ghes-3.6-diff-to-ghes-3.7.json +2 -2
  13. package/generated/ghes-3.6.deref.json +2 -2
  14. package/generated/ghes-3.6.json +2 -2
  15. package/generated/ghes-3.7-diff-to-ghes-3.8.deref.json +252 -11
  16. package/generated/ghes-3.7-diff-to-ghes-3.8.json +1 -1
  17. package/generated/ghes-3.7.deref.json +253 -12
  18. package/generated/ghes-3.7.json +115 -12
  19. package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +17 -0
  20. package/generated/ghes-3.8-diff-to-api.github.com.deref.json +252 -11
  21. package/generated/ghes-3.8-diff-to-api.github.com.json +1 -1
  22. package/generated/ghes-3.8.deref.json +403 -12
  23. package/generated/ghes-3.8.json +265 -12
  24. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +17 -0
  25. package/generated/github.ae-diff-to-api.github.com.deref.json +4996 -146
  26. package/generated/github.ae-diff-to-api.github.com.json +96 -5
  27. package/generated/github.ae.deref.json +5146 -146
  28. package/generated/github.ae.json +405 -15
  29. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "openapi": "3.0.3",
3
3
  "info": {
4
- "version": "11.0.0",
4
+ "version": "11.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": {
@@ -14307,10 +14307,9 @@
14307
14307
  "examples": {
14308
14308
  "default": {
14309
14309
  "value": {
14310
- "id": 21,
14311
14310
  "name": "super cool ruleset",
14312
14311
  "target": "branch",
14313
- "enforcement": "enabled",
14312
+ "enforcement": "active",
14314
14313
  "bypass_actors": [
14315
14314
  {
14316
14315
  "actor_id": 234,
@@ -14502,10 +14501,9 @@
14502
14501
  "examples": {
14503
14502
  "default": {
14504
14503
  "value": {
14505
- "id": 21,
14506
14504
  "name": "super cool ruleset",
14507
14505
  "target": "branch",
14508
- "enforcement": "enabled",
14506
+ "enforcement": "active",
14509
14507
  "bypass_actors": [
14510
14508
  {
14511
14509
  "actor_id": 234,
@@ -21954,6 +21952,70 @@
21954
21952
  "x-octokit": {}
21955
21953
  }
21956
21954
  },
21955
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
21956
+ "post": {
21957
+ "summary": "Review custom deployment protection rules for a workflow run",
21958
+ "description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nGitHub Apps must have read and write permission for **Deployments** to use this endpoint.",
21959
+ "tags": [
21960
+ "actions"
21961
+ ],
21962
+ "operationId": "actions/review-custom-gates-for-run",
21963
+ "externalDocs": {
21964
+ "description": "API method documentation",
21965
+ "url": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
21966
+ },
21967
+ "parameters": [
21968
+ {
21969
+ "$ref": "#/components/parameters/owner"
21970
+ },
21971
+ {
21972
+ "$ref": "#/components/parameters/repo"
21973
+ },
21974
+ {
21975
+ "$ref": "#/components/parameters/run-id"
21976
+ }
21977
+ ],
21978
+ "requestBody": {
21979
+ "required": true,
21980
+ "content": {
21981
+ "application/json": {
21982
+ "schema": {
21983
+ "anyOf": [
21984
+ {
21985
+ "$ref": "#/components/schemas/review-custom-gates-comment-required"
21986
+ },
21987
+ {
21988
+ "$ref": "#/components/schemas/review-custom-gates-state-required"
21989
+ }
21990
+ ]
21991
+ },
21992
+ "examples": {
21993
+ "default": {
21994
+ "value": {
21995
+ "environment_name": "prod-eus",
21996
+ "state": "approved",
21997
+ "comment": "All health checks passed."
21998
+ }
21999
+ }
22000
+ }
22001
+ }
22002
+ }
22003
+ },
22004
+ "responses": {
22005
+ "204": {
22006
+ "description": "Response"
22007
+ }
22008
+ },
22009
+ "x-github": {
22010
+ "githubCloudOnly": false,
22011
+ "enabledForGitHubApps": true,
22012
+ "previews": [],
22013
+ "category": "actions",
22014
+ "subcategory": "workflow-runs"
22015
+ },
22016
+ "x-octokit": {}
22017
+ }
22018
+ },
21957
22019
  "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
21958
22020
  "get": {
21959
22021
  "summary": "List jobs for a workflow run",
@@ -29104,7 +29166,7 @@
29104
29166
  "type": "string"
29105
29167
  },
29106
29168
  "location": {
29107
- "description": "Location for this codespace. Assigned by IP if not provided",
29169
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
29108
29170
  "type": "string"
29109
29171
  },
29110
29172
  "client_ip": {
@@ -33996,10 +34058,296 @@
33996
34058
  "x-octokit": {}
33997
34059
  }
33998
34060
  },
34061
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
34062
+ "get": {
34063
+ "summary": "Get all deployment protection rules for an environment",
34064
+ "description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).",
34065
+ "tags": [
34066
+ "repos"
34067
+ ],
34068
+ "operationId": "repos/get-all-deployment-protection-rules",
34069
+ "externalDocs": {
34070
+ "description": "API method documentation",
34071
+ "url": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules"
34072
+ },
34073
+ "parameters": [
34074
+ {
34075
+ "$ref": "#/components/parameters/environment-name"
34076
+ },
34077
+ {
34078
+ "$ref": "#/components/parameters/repo"
34079
+ },
34080
+ {
34081
+ "$ref": "#/components/parameters/owner"
34082
+ }
34083
+ ],
34084
+ "responses": {
34085
+ "200": {
34086
+ "description": "List of deployment protection rules",
34087
+ "content": {
34088
+ "application/json": {
34089
+ "schema": {
34090
+ "type": "object",
34091
+ "properties": {
34092
+ "total_count": {
34093
+ "description": "The number of enabled custom deployment protection rules for this environment",
34094
+ "type": "integer",
34095
+ "example": 10
34096
+ },
34097
+ "custom_deployment_protection_rules": {
34098
+ "type": "array",
34099
+ "items": {
34100
+ "$ref": "#/components/schemas/deployment-protection-rule"
34101
+ }
34102
+ }
34103
+ },
34104
+ "example": "../../components/examples/deployment_protection_rules.yaml"
34105
+ }
34106
+ }
34107
+ }
34108
+ }
34109
+ },
34110
+ "x-github": {
34111
+ "githubCloudOnly": false,
34112
+ "enabledForGitHubApps": true,
34113
+ "category": "deployments",
34114
+ "subcategory": "protection-rules"
34115
+ },
34116
+ "x-octokit": {}
34117
+ },
34118
+ "post": {
34119
+ "summary": "Create a custom deployment protection rule on an environment",
34120
+ "description": "Enable a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).",
34121
+ "tags": [
34122
+ "repos"
34123
+ ],
34124
+ "operationId": "repos/create-deployment-protection-rule",
34125
+ "externalDocs": {
34126
+ "description": "API method documentation",
34127
+ "url": "https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule"
34128
+ },
34129
+ "parameters": [
34130
+ {
34131
+ "$ref": "#/components/parameters/environment-name"
34132
+ },
34133
+ {
34134
+ "$ref": "#/components/parameters/repo"
34135
+ },
34136
+ {
34137
+ "$ref": "#/components/parameters/owner"
34138
+ }
34139
+ ],
34140
+ "requestBody": {
34141
+ "content": {
34142
+ "application/json": {
34143
+ "schema": {
34144
+ "type": "object",
34145
+ "properties": {
34146
+ "integration_id": {
34147
+ "type": "integer",
34148
+ "description": "The ID of the custom app that will be enabled on the environment."
34149
+ }
34150
+ }
34151
+ },
34152
+ "examples": {
34153
+ "default": {
34154
+ "value": {
34155
+ "integration_id": 5
34156
+ }
34157
+ }
34158
+ }
34159
+ }
34160
+ },
34161
+ "required": true
34162
+ },
34163
+ "responses": {
34164
+ "201": {
34165
+ "description": "The enabled custom deployment protection rule",
34166
+ "content": {
34167
+ "application/json": {
34168
+ "schema": {
34169
+ "$ref": "#/components/schemas/deployment-protection-rule"
34170
+ },
34171
+ "examples": {
34172
+ "default": {
34173
+ "$ref": "#/components/examples/deployment-protection-rule"
34174
+ }
34175
+ }
34176
+ }
34177
+ }
34178
+ }
34179
+ },
34180
+ "x-github": {
34181
+ "githubCloudOnly": false,
34182
+ "enabledForGitHubApps": true,
34183
+ "category": "deployments",
34184
+ "subcategory": "protection-rules"
34185
+ },
34186
+ "x-octokit": {}
34187
+ }
34188
+ },
34189
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
34190
+ "get": {
34191
+ "summary": "List custom deployment rule integrations available for an environment",
34192
+ "description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)\".",
34193
+ "tags": [
34194
+ "repos"
34195
+ ],
34196
+ "operationId": "repos/list-custom-deployment-rule-integrations",
34197
+ "externalDocs": {
34198
+ "description": "API method documentation",
34199
+ "url": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations"
34200
+ },
34201
+ "parameters": [
34202
+ {
34203
+ "$ref": "#/components/parameters/environment-name"
34204
+ },
34205
+ {
34206
+ "$ref": "#/components/parameters/repo"
34207
+ },
34208
+ {
34209
+ "$ref": "#/components/parameters/owner"
34210
+ },
34211
+ {
34212
+ "$ref": "#/components/parameters/page"
34213
+ },
34214
+ {
34215
+ "$ref": "#/components/parameters/per-page"
34216
+ }
34217
+ ],
34218
+ "responses": {
34219
+ "200": {
34220
+ "description": "A list of custom deployment rule integrations available for this environment.",
34221
+ "content": {
34222
+ "application/json": {
34223
+ "schema": {
34224
+ "type": "object",
34225
+ "properties": {
34226
+ "total_count": {
34227
+ "description": "The total number of custom deployment protection rule integrations available for this environment.",
34228
+ "type": "integer",
34229
+ "example": 35
34230
+ },
34231
+ "available_custom_deployment_protection_rule_integrations": {
34232
+ "type": "array",
34233
+ "items": {
34234
+ "$ref": "#/components/schemas/custom-deployment-rule-app"
34235
+ }
34236
+ }
34237
+ }
34238
+ },
34239
+ "examples": {
34240
+ "default": {
34241
+ "$ref": "#/components/examples/custom-deployment-protection-rule-apps"
34242
+ }
34243
+ }
34244
+ }
34245
+ }
34246
+ }
34247
+ },
34248
+ "x-github": {
34249
+ "githubCloudOnly": false,
34250
+ "enabledForGitHubApps": true,
34251
+ "category": "deployments",
34252
+ "subcategory": "protection-rules"
34253
+ },
34254
+ "x-octokit": {}
34255
+ }
34256
+ },
34257
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
34258
+ "get": {
34259
+ "summary": "Get a custom deployment protection rule",
34260
+ "description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app).",
34261
+ "tags": [
34262
+ "repos"
34263
+ ],
34264
+ "operationId": "repos/get-custom-deployment-protection-rule",
34265
+ "externalDocs": {
34266
+ "description": "API method documentation",
34267
+ "url": "https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule"
34268
+ },
34269
+ "parameters": [
34270
+ {
34271
+ "$ref": "#/components/parameters/owner"
34272
+ },
34273
+ {
34274
+ "$ref": "#/components/parameters/repo"
34275
+ },
34276
+ {
34277
+ "$ref": "#/components/parameters/environment-name"
34278
+ },
34279
+ {
34280
+ "$ref": "#/components/parameters/protection-rule-id"
34281
+ }
34282
+ ],
34283
+ "responses": {
34284
+ "200": {
34285
+ "description": "Response",
34286
+ "content": {
34287
+ "application/json": {
34288
+ "schema": {
34289
+ "$ref": "#/components/schemas/deployment-protection-rule"
34290
+ },
34291
+ "examples": {
34292
+ "default": {
34293
+ "$ref": "#/components/examples/deployment-protection-rule"
34294
+ }
34295
+ }
34296
+ }
34297
+ }
34298
+ }
34299
+ },
34300
+ "x-github": {
34301
+ "githubCloudOnly": false,
34302
+ "enabledForGitHubApps": true,
34303
+ "category": "deployments",
34304
+ "subcategory": "protection-rules"
34305
+ },
34306
+ "x-octokit": {}
34307
+ },
34308
+ "delete": {
34309
+ "summary": "Disable a custom protection rule for an environment",
34310
+ "description": "Disables a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)\".",
34311
+ "tags": [
34312
+ "repos"
34313
+ ],
34314
+ "operationId": "repos/disable-deployment-protection-rule",
34315
+ "externalDocs": {
34316
+ "description": "API method documentation",
34317
+ "url": "https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule"
34318
+ },
34319
+ "parameters": [
34320
+ {
34321
+ "$ref": "#/components/parameters/environment-name"
34322
+ },
34323
+ {
34324
+ "$ref": "#/components/parameters/repo"
34325
+ },
34326
+ {
34327
+ "$ref": "#/components/parameters/owner"
34328
+ },
34329
+ {
34330
+ "$ref": "#/components/parameters/protection-rule-id"
34331
+ }
34332
+ ],
34333
+ "responses": {
34334
+ "204": {
34335
+ "description": "Response"
34336
+ }
34337
+ },
34338
+ "x-github": {
34339
+ "githubCloudOnly": false,
34340
+ "enabledForGitHubApps": true,
34341
+ "category": "deployments",
34342
+ "subcategory": "protection-rules"
34343
+ },
34344
+ "x-octokit": {}
34345
+ }
34346
+ },
33999
34347
  "/repos/{owner}/{repo}/events": {
34000
34348
  "get": {
34001
34349
  "summary": "List repository events",
34002
- "description": "",
34350
+ "description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n",
34003
34351
  "tags": [
34004
34352
  "activity"
34005
34353
  ],
@@ -36155,7 +36503,7 @@
36155
36503
  "/repos/{owner}/{repo}/import": {
36156
36504
  "get": {
36157
36505
  "summary": "Get an import status",
36158
- "description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
36506
+ "description": "View the progress of an import.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
36159
36507
  "tags": [
36160
36508
  "migrations"
36161
36509
  ],
@@ -36205,7 +36553,7 @@
36205
36553
  },
36206
36554
  "put": {
36207
36555
  "summary": "Start an import",
36208
- "description": "Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.",
36556
+ "description": "Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
36209
36557
  "tags": [
36210
36558
  "migrations"
36211
36559
  ],
@@ -36317,7 +36665,7 @@
36317
36665
  },
36318
36666
  "patch": {
36319
36667
  "summary": "Update an import",
36320
- "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.",
36668
+ "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
36321
36669
  "tags": [
36322
36670
  "migrations"
36323
36671
  ],
@@ -36427,7 +36775,7 @@
36427
36775
  },
36428
36776
  "delete": {
36429
36777
  "summary": "Cancel an import",
36430
- "description": "Stop an import for a repository.",
36778
+ "description": "Stop an import for a repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
36431
36779
  "tags": [
36432
36780
  "migrations"
36433
36781
  ],
@@ -36464,7 +36812,7 @@
36464
36812
  "/repos/{owner}/{repo}/import/authors": {
36465
36813
  "get": {
36466
36814
  "summary": "Get commit authors",
36467
- "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.",
36815
+ "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
36468
36816
  "tags": [
36469
36817
  "migrations"
36470
36818
  ],
@@ -36522,7 +36870,7 @@
36522
36870
  "/repos/{owner}/{repo}/import/authors/{author_id}": {
36523
36871
  "patch": {
36524
36872
  "summary": "Map a commit author",
36525
- "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.",
36873
+ "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
36526
36874
  "tags": [
36527
36875
  "migrations"
36528
36876
  ],
@@ -36614,7 +36962,7 @@
36614
36962
  "/repos/{owner}/{repo}/import/large_files": {
36615
36963
  "get": {
36616
36964
  "summary": "Get large files",
36617
- "description": "List files larger than 100MB found during the import",
36965
+ "description": "List files larger than 100MB found during the import\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
36618
36966
  "tags": [
36619
36967
  "migrations"
36620
36968
  ],
@@ -36666,7 +37014,7 @@
36666
37014
  "/repos/{owner}/{repo}/import/lfs": {
36667
37015
  "patch": {
36668
37016
  "summary": "Update Git LFS preference",
36669
- "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.com). You can learn more about our LFS feature and working with large files [on our help site](https://docs.github.com/repositories/working-with-files/managing-large-files).",
37017
+ "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
36670
37018
  "tags": [
36671
37019
  "migrations"
36672
37020
  ],
@@ -42893,7 +43241,7 @@
42893
43241
  "nullable": true,
42894
43242
  "properties": {
42895
43243
  "location": {
42896
- "description": "Location for this codespace. Assigned by IP if not provided",
43244
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
42897
43245
  "type": "string"
42898
43246
  },
42899
43247
  "client_ip": {
@@ -46111,10 +46459,9 @@
46111
46459
  "examples": {
46112
46460
  "default": {
46113
46461
  "value": {
46114
- "id": 42,
46115
46462
  "name": "super cool ruleset",
46116
46463
  "target": "branch",
46117
- "enforcement": "enabled",
46464
+ "enforcement": "active",
46118
46465
  "bypass_mode": "repository",
46119
46466
  "bypass_actors": [
46120
46467
  {
@@ -46331,10 +46678,9 @@
46331
46678
  "examples": {
46332
46679
  "default": {
46333
46680
  "value": {
46334
- "id": 42,
46335
46681
  "name": "super cool ruleset",
46336
46682
  "target": "branch",
46337
- "enforcement": "enabled",
46683
+ "enforcement": "active",
46338
46684
  "bypass_mode": "repository",
46339
46685
  "bypass_actors": [
46340
46686
  {
@@ -46995,6 +47341,96 @@
46995
47341
  "x-octokit": {}
46996
47342
  }
46997
47343
  },
47344
+ "/repos/{owner}/{repo}/security-advisories/reports": {
47345
+ "post": {
47346
+ "summary": "Privately report a security vulnerability",
47347
+ "description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.",
47348
+ "tags": [
47349
+ "security-advisories"
47350
+ ],
47351
+ "operationId": "security-advisories/create-private-vulnerability-report",
47352
+ "externalDocs": {
47353
+ "description": "API method documentation",
47354
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
47355
+ },
47356
+ "parameters": [
47357
+ {
47358
+ "$ref": "#/components/parameters/owner"
47359
+ },
47360
+ {
47361
+ "$ref": "#/components/parameters/repo"
47362
+ }
47363
+ ],
47364
+ "requestBody": {
47365
+ "required": true,
47366
+ "content": {
47367
+ "application/json": {
47368
+ "schema": {
47369
+ "$ref": "#/components/schemas/private-vulnerability-report-create"
47370
+ },
47371
+ "examples": {
47372
+ "default": {
47373
+ "value": {
47374
+ "summary": "A newly discovered vulnerability",
47375
+ "description": "A more in-depth description of what the problem is.",
47376
+ "severity": "high",
47377
+ "vulnerabilities": [
47378
+ {
47379
+ "package": {
47380
+ "name": "a-package",
47381
+ "ecosystem": "npm"
47382
+ },
47383
+ "vulnerable_version_range": "< 1.0.0",
47384
+ "patched_versions": "1.0.0",
47385
+ "vulnerable_functions": [
47386
+ "important_function"
47387
+ ]
47388
+ }
47389
+ ],
47390
+ "cwe_ids": [
47391
+ "CWE-123"
47392
+ ]
47393
+ }
47394
+ }
47395
+ }
47396
+ }
47397
+ }
47398
+ },
47399
+ "responses": {
47400
+ "201": {
47401
+ "description": "Response",
47402
+ "content": {
47403
+ "application/json": {
47404
+ "schema": {
47405
+ "$ref": "#/components/schemas/repository-advisory"
47406
+ },
47407
+ "examples": {
47408
+ "default": {
47409
+ "$ref": "#/components/examples/repository-advisory-pvr"
47410
+ }
47411
+ }
47412
+ }
47413
+ }
47414
+ },
47415
+ "403": {
47416
+ "$ref": "#/components/responses/forbidden"
47417
+ },
47418
+ "404": {
47419
+ "$ref": "#/components/responses/not_found"
47420
+ },
47421
+ "422": {
47422
+ "$ref": "#/components/responses/validation_failed"
47423
+ }
47424
+ },
47425
+ "x-github": {
47426
+ "githubCloudOnly": false,
47427
+ "enabledForGitHubApps": true,
47428
+ "category": "security-advisories",
47429
+ "subcategory": "repository-advisories"
47430
+ },
47431
+ "x-octokit": {}
47432
+ }
47433
+ },
46998
47434
  "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
46999
47435
  "get": {
47000
47436
  "summary": "Get a repository security advisory",
@@ -49575,7 +50011,7 @@
49575
50011
  "/search/code": {
49576
50012
  "get": {
49577
50013
  "summary": "Search code",
49578
- "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n**Note:** Starting on April 10, 2023, code search on GitHub.com will have a separate\nrate limit from other search types, of 10 requests per minute, and all code\nsearch requests will require authentication. For more information, see [this blog post](https://github.blog/changelog/2023-03-10-changes-to-the-code-search-api/).",
50014
+ "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.",
49579
50015
  "tags": [
49580
50016
  "search"
49581
50017
  ],
@@ -49597,7 +50033,7 @@
49597
50033
  {
49598
50034
  "name": "sort",
49599
50035
  "deprecated": true,
49600
- "description": "**Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server).** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)",
50036
+ "description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://docs.github.com/rest/reference/search#ranking-search-results)",
49601
50037
  "in": "query",
49602
50038
  "required": false,
49603
50039
  "schema": {
@@ -49609,7 +50045,7 @@
49609
50045
  },
49610
50046
  {
49611
50047
  "name": "order",
49612
- "description": "**Note: This field is deprecated, and will be ignored after April 10, 2023 (except on GitHub Enterprise Server).** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ",
50048
+ "description": "**This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ",
49613
50049
  "in": "query",
49614
50050
  "deprecated": true,
49615
50051
  "required": false,
@@ -52917,7 +53353,7 @@
52917
53353
  "type": "string"
52918
53354
  },
52919
53355
  "location": {
52920
- "description": "Location for this codespace. Assigned by IP if not provided",
53356
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
52921
53357
  "type": "string"
52922
53358
  },
52923
53359
  "client_ip": {
@@ -52979,7 +53415,7 @@
52979
53415
  }
52980
53416
  },
52981
53417
  "location": {
52982
- "description": "Location for this codespace. Assigned by IP if not provided",
53418
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
52983
53419
  "type": "string"
52984
53420
  },
52985
53421
  "machine": {
@@ -62975,7 +63411,100 @@
62975
63411
  "content": {
62976
63412
  "application/json": {
62977
63413
  "schema": {
62978
- "$ref": "#/components/schemas/webhook-dependabot-alert-created"
63414
+ "$ref": "#/components/schemas/webhook-dependabot-alert-created"
63415
+ }
63416
+ }
63417
+ }
63418
+ },
63419
+ "responses": {
63420
+ "200": {
63421
+ "description": "Return a 200 status to indicate that the data was received successfully"
63422
+ }
63423
+ },
63424
+ "x-github": {
63425
+ "githubCloudOnly": false,
63426
+ "category": "webhooks",
63427
+ "subcategory": "dependabot-alert",
63428
+ "supported-webhook-types": [
63429
+ "repository",
63430
+ "organization",
63431
+ "app"
63432
+ ]
63433
+ }
63434
+ }
63435
+ },
63436
+ "dependabot-alert-dismissed": {
63437
+ "post": {
63438
+ "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
63439
+ "description": "A Dependabot alert was manually closed.",
63440
+ "operationId": "dependabot-alert/dismissed",
63441
+ "externalDocs": {
63442
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63443
+ },
63444
+ "parameters": [
63445
+ {
63446
+ "name": "User-Agent",
63447
+ "in": "header",
63448
+ "example": "GitHub-Hookshot/123abc",
63449
+ "schema": {
63450
+ "type": "string"
63451
+ }
63452
+ },
63453
+ {
63454
+ "name": "X-Github-Hook-Id",
63455
+ "in": "header",
63456
+ "example": 12312312,
63457
+ "schema": {
63458
+ "type": "string"
63459
+ }
63460
+ },
63461
+ {
63462
+ "name": "X-Github-Event",
63463
+ "in": "header",
63464
+ "example": "issues",
63465
+ "schema": {
63466
+ "type": "string"
63467
+ }
63468
+ },
63469
+ {
63470
+ "name": "X-Github-Hook-Installation-Target-Id",
63471
+ "in": "header",
63472
+ "example": 123123,
63473
+ "schema": {
63474
+ "type": "string"
63475
+ }
63476
+ },
63477
+ {
63478
+ "name": "X-Github-Hook-Installation-Target-Type",
63479
+ "in": "header",
63480
+ "example": "repository",
63481
+ "schema": {
63482
+ "type": "string"
63483
+ }
63484
+ },
63485
+ {
63486
+ "name": "X-GitHub-Delivery",
63487
+ "in": "header",
63488
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
63489
+ "schema": {
63490
+ "type": "string"
63491
+ }
63492
+ },
63493
+ {
63494
+ "name": "X-Hub-Signature-256",
63495
+ "in": "header",
63496
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
63497
+ "schema": {
63498
+ "type": "string"
63499
+ }
63500
+ }
63501
+ ],
63502
+ "requestBody": {
63503
+ "required": true,
63504
+ "content": {
63505
+ "application/json": {
63506
+ "schema": {
63507
+ "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
62979
63508
  }
62980
63509
  }
62981
63510
  }
@@ -62997,11 +63526,11 @@
62997
63526
  }
62998
63527
  }
62999
63528
  },
63000
- "dependabot-alert-dismissed": {
63529
+ "dependabot-alert-fixed": {
63001
63530
  "post": {
63002
63531
  "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
63003
- "description": "A Dependabot alert was manually closed.",
63004
- "operationId": "dependabot-alert/dismissed",
63532
+ "description": "A manifest file change removed a vulnerability.",
63533
+ "operationId": "dependabot-alert/fixed",
63005
63534
  "externalDocs": {
63006
63535
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63007
63536
  },
@@ -63068,7 +63597,7 @@
63068
63597
  "content": {
63069
63598
  "application/json": {
63070
63599
  "schema": {
63071
- "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
63600
+ "$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
63072
63601
  }
63073
63602
  }
63074
63603
  }
@@ -63090,11 +63619,11 @@
63090
63619
  }
63091
63620
  }
63092
63621
  },
63093
- "dependabot-alert-fixed": {
63622
+ "dependabot-alert-reintroduced": {
63094
63623
  "post": {
63095
63624
  "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
63096
- "description": "A manifest file change removed a vulnerability.",
63097
- "operationId": "dependabot-alert/fixed",
63625
+ "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.",
63626
+ "operationId": "dependabot-alert/reintroduced",
63098
63627
  "externalDocs": {
63099
63628
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63100
63629
  },
@@ -63161,7 +63690,7 @@
63161
63690
  "content": {
63162
63691
  "application/json": {
63163
63692
  "schema": {
63164
- "$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
63693
+ "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
63165
63694
  }
63166
63695
  }
63167
63696
  }
@@ -63183,11 +63712,11 @@
63183
63712
  }
63184
63713
  }
63185
63714
  },
63186
- "dependabot-alert-reintroduced": {
63715
+ "dependabot-alert-reopened": {
63187
63716
  "post": {
63188
63717
  "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
63189
- "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.",
63190
- "operationId": "dependabot-alert/reintroduced",
63718
+ "description": "A Dependabot alert was manually reopened.",
63719
+ "operationId": "dependabot-alert/reopened",
63191
63720
  "externalDocs": {
63192
63721
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63193
63722
  },
@@ -63254,7 +63783,7 @@
63254
63783
  "content": {
63255
63784
  "application/json": {
63256
63785
  "schema": {
63257
- "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
63786
+ "$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
63258
63787
  }
63259
63788
  }
63260
63789
  }
@@ -63276,13 +63805,13 @@
63276
63805
  }
63277
63806
  }
63278
63807
  },
63279
- "dependabot-alert-reopened": {
63808
+ "deploy-key-created": {
63280
63809
  "post": {
63281
- "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
63282
- "description": "A Dependabot alert was manually reopened.",
63283
- "operationId": "dependabot-alert/reopened",
63810
+ "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
63811
+ "description": "A deploy key was created.",
63812
+ "operationId": "deploy-key/created",
63284
63813
  "externalDocs": {
63285
- "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63814
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
63286
63815
  },
63287
63816
  "parameters": [
63288
63817
  {
@@ -63347,7 +63876,7 @@
63347
63876
  "content": {
63348
63877
  "application/json": {
63349
63878
  "schema": {
63350
- "$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
63879
+ "$ref": "#/components/schemas/webhook-deploy-key-created"
63351
63880
  }
63352
63881
  }
63353
63882
  }
@@ -63360,7 +63889,7 @@
63360
63889
  "x-github": {
63361
63890
  "githubCloudOnly": false,
63362
63891
  "category": "webhooks",
63363
- "subcategory": "dependabot-alert",
63892
+ "subcategory": "deploy-key",
63364
63893
  "supported-webhook-types": [
63365
63894
  "repository",
63366
63895
  "organization",
@@ -63369,11 +63898,11 @@
63369
63898
  }
63370
63899
  }
63371
63900
  },
63372
- "deploy-key-created": {
63901
+ "deploy-key-deleted": {
63373
63902
  "post": {
63374
- "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
63375
- "description": "A deploy key was created.",
63376
- "operationId": "deploy-key/created",
63903
+ "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
63904
+ "description": "A deploy key was deleted.",
63905
+ "operationId": "deploy-key/deleted",
63377
63906
  "externalDocs": {
63378
63907
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
63379
63908
  },
@@ -63440,7 +63969,7 @@
63440
63969
  "content": {
63441
63970
  "application/json": {
63442
63971
  "schema": {
63443
- "$ref": "#/components/schemas/webhook-deploy-key-created"
63972
+ "$ref": "#/components/schemas/webhook-deploy-key-deleted"
63444
63973
  }
63445
63974
  }
63446
63975
  }
@@ -63462,13 +63991,13 @@
63462
63991
  }
63463
63992
  }
63464
63993
  },
63465
- "deploy-key-deleted": {
63994
+ "deployment-created": {
63466
63995
  "post": {
63467
- "summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
63468
- "description": "A deploy key was deleted.",
63469
- "operationId": "deploy-key/deleted",
63996
+ "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
63997
+ "description": "A deployment was created.",
63998
+ "operationId": "deployment/created",
63470
63999
  "externalDocs": {
63471
- "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
64000
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment"
63472
64001
  },
63473
64002
  "parameters": [
63474
64003
  {
@@ -63533,7 +64062,7 @@
63533
64062
  "content": {
63534
64063
  "application/json": {
63535
64064
  "schema": {
63536
- "$ref": "#/components/schemas/webhook-deploy-key-deleted"
64065
+ "$ref": "#/components/schemas/webhook-deployment-created"
63537
64066
  }
63538
64067
  }
63539
64068
  }
@@ -63546,7 +64075,7 @@
63546
64075
  "x-github": {
63547
64076
  "githubCloudOnly": false,
63548
64077
  "category": "webhooks",
63549
- "subcategory": "deploy-key",
64078
+ "subcategory": "deployment",
63550
64079
  "supported-webhook-types": [
63551
64080
  "repository",
63552
64081
  "organization",
@@ -63555,13 +64084,13 @@
63555
64084
  }
63556
64085
  }
63557
64086
  },
63558
- "deployment-created": {
64087
+ "deployment-protection-rule-requested": {
63559
64088
  "post": {
63560
- "summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
63561
- "description": "A deployment was created.",
63562
- "operationId": "deployment/created",
64089
+ "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
64090
+ "description": "A deployment protection rule was requested for an environment.",
64091
+ "operationId": "deployment-protection-rule/requested",
63563
64092
  "externalDocs": {
63564
- "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment"
64093
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule"
63565
64094
  },
63566
64095
  "parameters": [
63567
64096
  {
@@ -63626,7 +64155,7 @@
63626
64155
  "content": {
63627
64156
  "application/json": {
63628
64157
  "schema": {
63629
- "$ref": "#/components/schemas/webhook-deployment-created"
64158
+ "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested"
63630
64159
  }
63631
64160
  }
63632
64161
  }
@@ -63639,10 +64168,8 @@
63639
64168
  "x-github": {
63640
64169
  "githubCloudOnly": false,
63641
64170
  "category": "webhooks",
63642
- "subcategory": "deployment",
64171
+ "subcategory": "deployment-protection-rule",
63643
64172
  "supported-webhook-types": [
63644
- "repository",
63645
- "organization",
63646
64173
  "app"
63647
64174
  ]
63648
64175
  }
@@ -89844,7 +90371,7 @@
89844
90371
  }
89845
90372
  },
89846
90373
  "location": {
89847
- "description": "The Azure region where this codespace is located.",
90374
+ "description": "The initally assigned location of a new codespace.",
89848
90375
  "enum": [
89849
90376
  "EastUs",
89850
90377
  "SouthEastAsia",
@@ -96339,6 +96866,48 @@
96339
96866
  "comment"
96340
96867
  ]
96341
96868
  },
96869
+ "review-custom-gates-comment-required": {
96870
+ "type": "object",
96871
+ "properties": {
96872
+ "environment_name": {
96873
+ "type": "string",
96874
+ "description": "The name of the environment to approve or reject."
96875
+ },
96876
+ "comment": {
96877
+ "type": "string",
96878
+ "description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**"
96879
+ }
96880
+ },
96881
+ "required": [
96882
+ "environment_name",
96883
+ "comment"
96884
+ ]
96885
+ },
96886
+ "review-custom-gates-state-required": {
96887
+ "type": "object",
96888
+ "properties": {
96889
+ "environment_name": {
96890
+ "type": "string",
96891
+ "description": "The name of the environment to approve or reject."
96892
+ },
96893
+ "state": {
96894
+ "type": "string",
96895
+ "description": "Whether to approve or reject deployment to the specified environments.",
96896
+ "enum": [
96897
+ "approved",
96898
+ "rejected"
96899
+ ]
96900
+ },
96901
+ "comment": {
96902
+ "type": "string",
96903
+ "description": "Optional comment to include with the review."
96904
+ }
96905
+ },
96906
+ "required": [
96907
+ "environment_name",
96908
+ "state"
96909
+ ]
96910
+ },
96342
96911
  "deployment-reviewer-type": {
96343
96912
  "type": "string",
96344
96913
  "description": "The type of reviewer.",
@@ -98872,8 +99441,13 @@
98872
99441
  "items": {
98873
99442
  "type": "string",
98874
99443
  "enum": [
99444
+ "c",
99445
+ "cpp",
99446
+ "csharp",
98875
99447
  "go",
99448
+ "java",
98876
99449
  "javascript",
99450
+ "kotlin",
98877
99451
  "python",
98878
99452
  "ruby",
98879
99453
  "typescript"
@@ -102013,6 +102587,70 @@
102013
102587
  "name"
102014
102588
  ]
102015
102589
  },
102590
+ "custom-deployment-rule-app": {
102591
+ "title": "Custom deployment protection rule app",
102592
+ "description": "A GitHub App that is providing a custom deployment protection rule.",
102593
+ "type": "object",
102594
+ "properties": {
102595
+ "id": {
102596
+ "type": "integer",
102597
+ "example": 3515,
102598
+ "description": "The unique identifier of the deployment protection rule integration."
102599
+ },
102600
+ "slug": {
102601
+ "type": "string",
102602
+ "example": "my-custom-app",
102603
+ "description": "The slugified name of the deployment protection rule integration."
102604
+ },
102605
+ "integration_url": {
102606
+ "type": "string",
102607
+ "example": "https://api.github.com/apps/custom-app-slug",
102608
+ "description": "The URL for the endpoint to get details about the app."
102609
+ },
102610
+ "node_id": {
102611
+ "type": "string",
102612
+ "example": "MDQ6R2F0ZTM1MTU=",
102613
+ "description": "The node ID for the deployment protection rule integration."
102614
+ }
102615
+ },
102616
+ "required": [
102617
+ "id",
102618
+ "slug",
102619
+ "integration_url",
102620
+ "node_id"
102621
+ ]
102622
+ },
102623
+ "deployment-protection-rule": {
102624
+ "title": "Deployment protection rule",
102625
+ "description": "Deployment protection rule",
102626
+ "type": "object",
102627
+ "properties": {
102628
+ "id": {
102629
+ "type": "integer",
102630
+ "example": 3515,
102631
+ "description": "The unique identifier for the deployment protection rule."
102632
+ },
102633
+ "node_id": {
102634
+ "type": "string",
102635
+ "example": "MDQ6R2F0ZTM1MTU=",
102636
+ "description": "The node ID for the deployment protection rule."
102637
+ },
102638
+ "enabled": {
102639
+ "type": "boolean",
102640
+ "example": true,
102641
+ "description": "Whether the deployment protection rule is enabled for the environment."
102642
+ },
102643
+ "app": {
102644
+ "$ref": "#/components/schemas/custom-deployment-rule-app"
102645
+ }
102646
+ },
102647
+ "required": [
102648
+ "id",
102649
+ "node_id",
102650
+ "enabled",
102651
+ "app"
102652
+ ]
102653
+ },
102016
102654
  "short-blob": {
102017
102655
  "title": "Short Blob",
102018
102656
  "description": "Short Blob",
@@ -108663,28 +109301,122 @@
108663
109301
  "type": "string"
108664
109302
  }
108665
109303
  },
108666
- "credits": {
108667
- "type": "array",
108668
- "description": "A list of users receiving credit for their participation in the security advisory.",
108669
- "nullable": true,
108670
- "items": {
108671
- "type": "object",
108672
- "properties": {
108673
- "login": {
108674
- "type": "string",
108675
- "description": "The username of the user credited."
108676
- },
108677
- "type": {
108678
- "$ref": "#/components/schemas/repository-advisory-credit-types"
108679
- }
108680
- },
108681
- "required": [
108682
- "login",
108683
- "type"
108684
- ],
108685
- "additionalProperties": false
108686
- }
108687
- },
109304
+ "credits": {
109305
+ "type": "array",
109306
+ "description": "A list of users receiving credit for their participation in the security advisory.",
109307
+ "nullable": true,
109308
+ "items": {
109309
+ "type": "object",
109310
+ "properties": {
109311
+ "login": {
109312
+ "type": "string",
109313
+ "description": "The username of the user credited."
109314
+ },
109315
+ "type": {
109316
+ "$ref": "#/components/schemas/repository-advisory-credit-types"
109317
+ }
109318
+ },
109319
+ "required": [
109320
+ "login",
109321
+ "type"
109322
+ ],
109323
+ "additionalProperties": false
109324
+ }
109325
+ },
109326
+ "severity": {
109327
+ "type": "string",
109328
+ "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
109329
+ "nullable": true,
109330
+ "enum": [
109331
+ "critical",
109332
+ "high",
109333
+ "medium",
109334
+ "low"
109335
+ ]
109336
+ },
109337
+ "cvss_vector_string": {
109338
+ "type": "string",
109339
+ "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
109340
+ "nullable": true
109341
+ }
109342
+ },
109343
+ "required": [
109344
+ "summary",
109345
+ "description",
109346
+ "vulnerabilities"
109347
+ ],
109348
+ "additionalProperties": false
109349
+ },
109350
+ "private-vulnerability-report-create": {
109351
+ "type": "object",
109352
+ "properties": {
109353
+ "summary": {
109354
+ "type": "string",
109355
+ "description": "A short summary of the advisory.",
109356
+ "maxLength": 1024
109357
+ },
109358
+ "description": {
109359
+ "type": "string",
109360
+ "description": "A detailed description of what the advisory impacts.",
109361
+ "maxLength": 65535
109362
+ },
109363
+ "vulnerabilities": {
109364
+ "type": "array",
109365
+ "description": "An array of products affected by the vulnerability detailed in a repository security advisory.",
109366
+ "nullable": true,
109367
+ "items": {
109368
+ "type": "object",
109369
+ "properties": {
109370
+ "package": {
109371
+ "description": "The name of the package affected by the vulnerability.",
109372
+ "type": "object",
109373
+ "properties": {
109374
+ "ecosystem": {
109375
+ "$ref": "#/components/schemas/repository-advisory-ecosystems"
109376
+ },
109377
+ "name": {
109378
+ "type": "string",
109379
+ "description": "The unique package name within its ecosystem.",
109380
+ "nullable": true
109381
+ }
109382
+ },
109383
+ "required": [
109384
+ "ecosystem"
109385
+ ]
109386
+ },
109387
+ "vulnerable_version_range": {
109388
+ "type": "string",
109389
+ "description": "The range of the package versions affected by the vulnerability.",
109390
+ "nullable": true
109391
+ },
109392
+ "patched_versions": {
109393
+ "type": "string",
109394
+ "description": "The package version(s) that resolve the vulnerability.",
109395
+ "nullable": true
109396
+ },
109397
+ "vulnerable_functions": {
109398
+ "type": "array",
109399
+ "description": "The functions in the package that are affected.",
109400
+ "nullable": true,
109401
+ "items": {
109402
+ "type": "string"
109403
+ }
109404
+ }
109405
+ },
109406
+ "required": [
109407
+ "package"
109408
+ ],
109409
+ "additionalProperties": false
109410
+ }
109411
+ },
109412
+ "cwe_ids": {
109413
+ "type": "array",
109414
+ "description": "A list of Common Weakness Enumeration (CWE) IDs.",
109415
+ "nullable": true,
109416
+ "items": {
109417
+ "type": "string"
109418
+ }
109419
+ },
108688
109420
  "severity": {
108689
109421
  "type": "string",
108690
109422
  "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
@@ -108704,8 +109436,7 @@
108704
109436
  },
108705
109437
  "required": [
108706
109438
  "summary",
108707
- "description",
108708
- "vulnerabilities"
109439
+ "description"
108709
109440
  ],
108710
109441
  "additionalProperties": false
108711
109442
  },
@@ -110893,7 +111624,7 @@
110893
111624
  }
110894
111625
  },
110895
111626
  "location": {
110896
- "description": "The Azure region where this codespace is located.",
111627
+ "description": "The initally assigned location of a new codespace.",
110897
111628
  "enum": [
110898
111629
  "EastUs",
110899
111630
  "SouthEastAsia",
@@ -119732,6 +120463,52 @@
119732
120463
  "sender"
119733
120464
  ]
119734
120465
  },
120466
+ "webhook-deployment-protection-rule-requested": {
120467
+ "title": "deployment protection rule requested event",
120468
+ "type": "object",
120469
+ "properties": {
120470
+ "action": {
120471
+ "type": "string",
120472
+ "enum": [
120473
+ "requested"
120474
+ ]
120475
+ },
120476
+ "environment": {
120477
+ "description": "The name of the environment that has the deployment protection rule.",
120478
+ "type": "string"
120479
+ },
120480
+ "event": {
120481
+ "description": "The event that triggered the deployment protection rule.",
120482
+ "type": "string"
120483
+ },
120484
+ "deployment_callback_url": {
120485
+ "description": "The URL to review the deployment protection rule.",
120486
+ "type": "string",
120487
+ "format": "uri"
120488
+ },
120489
+ "deployment": {
120490
+ "$ref": "#/components/schemas/deployment"
120491
+ },
120492
+ "pull_requests": {
120493
+ "type": "array",
120494
+ "items": {
120495
+ "$ref": "#/components/schemas/pull-request"
120496
+ }
120497
+ },
120498
+ "repository": {
120499
+ "$ref": "#/components/schemas/repository"
120500
+ },
120501
+ "organization": {
120502
+ "$ref": "#/components/schemas/organization-simple"
120503
+ },
120504
+ "installation": {
120505
+ "$ref": "#/components/schemas/simple-installation"
120506
+ },
120507
+ "sender": {
120508
+ "$ref": "#/components/schemas/simple-user"
120509
+ }
120510
+ }
120511
+ },
119735
120512
  "webhook-deployment-status-created": {
119736
120513
  "title": "deployment_status created event",
119737
120514
  "type": "object",
@@ -162590,6 +163367,56 @@
162590
163367
  "sender"
162591
163368
  ]
162592
163369
  },
163370
+ "webhook-rubygems-metadata": {
163371
+ "title": "Ruby Gems metadata",
163372
+ "type": "object",
163373
+ "properties": {
163374
+ "name": {
163375
+ "type": "string"
163376
+ },
163377
+ "description": {
163378
+ "type": "string"
163379
+ },
163380
+ "readme": {
163381
+ "type": "string"
163382
+ },
163383
+ "homepage": {
163384
+ "type": "string"
163385
+ },
163386
+ "version_info": {
163387
+ "type": "object",
163388
+ "properties": {
163389
+ "version": {
163390
+ "type": "string"
163391
+ }
163392
+ }
163393
+ },
163394
+ "platform": {
163395
+ "type": "string"
163396
+ },
163397
+ "metadata": {
163398
+ "type": "object",
163399
+ "additionalProperties": {
163400
+ "type": "string"
163401
+ }
163402
+ },
163403
+ "repo": {
163404
+ "type": "string"
163405
+ },
163406
+ "dependencies": {
163407
+ "type": "array",
163408
+ "items": {
163409
+ "type": "object",
163410
+ "additionalProperties": {
163411
+ "type": "string"
163412
+ }
163413
+ }
163414
+ },
163415
+ "commit_oid": {
163416
+ "type": "string"
163417
+ }
163418
+ }
163419
+ },
162593
163420
  "webhook-package-published": {
162594
163421
  "title": "package published event",
162595
163422
  "type": "object",
@@ -162874,7 +163701,17 @@
162874
163701
  },
162875
163702
  "docker_metadata": {
162876
163703
  "type": "array",
162877
- "items": {}
163704
+ "items": {
163705
+ "type": "object",
163706
+ "properties": {
163707
+ "tags": {
163708
+ "type": "array",
163709
+ "items": {
163710
+ "type": "string"
163711
+ }
163712
+ }
163713
+ }
163714
+ }
162878
163715
  },
162879
163716
  "draft": {
162880
163717
  "type": "boolean"
@@ -163304,7 +164141,9 @@
163304
164141
  },
163305
164142
  "rubygems_metadata": {
163306
164143
  "type": "array",
163307
- "items": {}
164144
+ "items": {
164145
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
164146
+ }
163308
164147
  },
163309
164148
  "source_url": {
163310
164149
  "type": "string"
@@ -163653,7 +164492,17 @@
163653
164492
  },
163654
164493
  "docker_metadata": {
163655
164494
  "type": "array",
163656
- "items": {}
164495
+ "items": {
164496
+ "type": "object",
164497
+ "properties": {
164498
+ "tags": {
164499
+ "type": "array",
164500
+ "items": {
164501
+ "type": "string"
164502
+ }
164503
+ }
164504
+ }
164505
+ }
163657
164506
  },
163658
164507
  "draft": {
163659
164508
  "type": "boolean"
@@ -163673,7 +164522,10 @@
163673
164522
  },
163674
164523
  "metadata": {
163675
164524
  "type": "array",
163676
- "items": {}
164525
+ "items": {
164526
+ "type": "object",
164527
+ "additionalProperties": true
164528
+ }
163677
164529
  },
163678
164530
  "name": {
163679
164531
  "type": "string"
@@ -163885,7 +164737,9 @@
163885
164737
  },
163886
164738
  "rubygems_metadata": {
163887
164739
  "type": "array",
163888
- "items": {}
164740
+ "items": {
164741
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
164742
+ }
163889
164743
  },
163890
164744
  "source_url": {
163891
164745
  "type": "string",
@@ -244788,7 +245642,17 @@
244788
245642
  },
244789
245643
  "docker_metadata": {
244790
245644
  "type": "array",
244791
- "items": {}
245645
+ "items": {
245646
+ "type": "object",
245647
+ "properties": {
245648
+ "tags": {
245649
+ "type": "array",
245650
+ "items": {
245651
+ "type": "string"
245652
+ }
245653
+ }
245654
+ }
245655
+ }
244792
245656
  },
244793
245657
  "draft": {
244794
245658
  "type": "boolean"
@@ -245207,7 +246071,9 @@
245207
246071
  },
245208
246072
  "rubygems_metadata": {
245209
246073
  "type": "array",
245210
- "items": {}
246074
+ "items": {
246075
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
246076
+ }
245211
246077
  },
245212
246078
  "summary": {
245213
246079
  "type": "string"
@@ -245513,7 +246379,16 @@
245513
246379
  "docker_metadata": {
245514
246380
  "type": "array",
245515
246381
  "items": {
245516
- "nullable": true
246382
+ "type": "object",
246383
+ "nullable": true,
246384
+ "properties": {
246385
+ "tags": {
246386
+ "type": "array",
246387
+ "items": {
246388
+ "type": "string"
246389
+ }
246390
+ }
246391
+ }
245517
246392
  }
245518
246393
  },
245519
246394
  "draft": {
@@ -245533,7 +246408,10 @@
245533
246408
  },
245534
246409
  "metadata": {
245535
246410
  "type": "array",
245536
- "items": {}
246411
+ "items": {
246412
+ "type": "object",
246413
+ "additionalProperties": true
246414
+ }
245537
246415
  },
245538
246416
  "name": {
245539
246417
  "type": "string"
@@ -245716,7 +246594,9 @@
245716
246594
  },
245717
246595
  "rubygems_metadata": {
245718
246596
  "type": "array",
245719
- "items": {}
246597
+ "items": {
246598
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
246599
+ }
245720
246600
  },
245721
246601
  "summary": {
245722
246602
  "type": "string"
@@ -273076,7 +273956,7 @@
273076
273956
  "target": "branch",
273077
273957
  "source_type": "Organization",
273078
273958
  "source": "my-org",
273079
- "enforcement": "enabled",
273959
+ "enforcement": "active",
273080
273960
  "bypass_actors": [
273081
273961
  {
273082
273962
  "actor_id": 234,
@@ -281998,6 +282878,42 @@
281998
282878
  "name": "main"
281999
282879
  }
282000
282880
  },
282881
+ "deployment-protection-rule": {
282882
+ "value": {
282883
+ "id": 3,
282884
+ "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
282885
+ "enabled": true,
282886
+ "app": {
282887
+ "id": 1,
282888
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
282889
+ "slug": "a-custom-app",
282890
+ "integration_url": "https://api.github.com/apps/a-custom-app"
282891
+ }
282892
+ }
282893
+ },
282894
+ "custom-deployment-protection-rule-apps": {
282895
+ "value": [
282896
+ {
282897
+ "total_count": 2
282898
+ },
282899
+ {
282900
+ "available_custom_deployment_protection_rule_integrations": [
282901
+ {
282902
+ "id": 1,
282903
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
282904
+ "slug": "a-custom-app",
282905
+ "integration_url": "https://api.github.com/apps/a-custom-app"
282906
+ },
282907
+ {
282908
+ "id": 2,
282909
+ "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
282910
+ "slug": "another-custom-app",
282911
+ "integration_url": "https://api.github.com/apps/another-custom-app"
282912
+ }
282913
+ ]
282914
+ }
282915
+ ]
282916
+ },
282001
282917
  "repo-events-items": {
282002
282918
  "value": [
282003
282919
  {
@@ -286756,7 +287672,7 @@
286756
287672
  "target": "branch",
286757
287673
  "source_type": "Repository",
286758
287674
  "source": "monalisa/my-repo",
286759
- "enforcement": "enabled",
287675
+ "enforcement": "active",
286760
287676
  "bypass_mode": "repository",
286761
287677
  "bypass_actors": [
286762
287678
  {
@@ -287374,6 +288290,112 @@
287374
288290
  ]
287375
288291
  }
287376
288292
  },
288293
+ "repository-advisory-pvr": {
288294
+ "value": {
288295
+ "ghsa_id": "GHSA-abcd-1234-efgh",
288296
+ "cve_id": "CVE-2050-00000",
288297
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
288298
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
288299
+ "summary": "A newly discovered vulnerability",
288300
+ "description": "A more in-depth description of what the problem is.",
288301
+ "severity": "high",
288302
+ "author": {
288303
+ "login": "octocat",
288304
+ "id": 1,
288305
+ "node_id": "MDQ6VXNlcjE=",
288306
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
288307
+ "gravatar_id": "",
288308
+ "url": "https://api.github.com/users/octocat",
288309
+ "html_url": "https://github.com/octocat",
288310
+ "followers_url": "https://api.github.com/users/octocat/followers",
288311
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
288312
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
288313
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
288314
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
288315
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
288316
+ "repos_url": "https://api.github.com/users/octocat/repos",
288317
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
288318
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
288319
+ "type": "User",
288320
+ "site_admin": false
288321
+ },
288322
+ "publisher": null,
288323
+ "identifiers": [
288324
+ {
288325
+ "type": "GHSA",
288326
+ "value": "GHSA-abcd-1234-efgh"
288327
+ },
288328
+ {
288329
+ "type": "CVE",
288330
+ "value": null
288331
+ }
288332
+ ],
288333
+ "state": "triage",
288334
+ "created_at": "2020-01-01T00:00:00Z",
288335
+ "updated_at": "2020-01-02T00:00:00Z",
288336
+ "published_at": null,
288337
+ "closed_at": null,
288338
+ "withdrawn_at": null,
288339
+ "submission": {
288340
+ "accepted": false
288341
+ },
288342
+ "vulnerabilities": [
288343
+ {
288344
+ "package": {
288345
+ "ecosystem": "npm",
288346
+ "name": "a-package"
288347
+ },
288348
+ "vulnerable_version_range": "< 1.0.0",
288349
+ "patched_versions": "1.0.0",
288350
+ "vulnerable_functions": [
288351
+ "important_function"
288352
+ ]
288353
+ }
288354
+ ],
288355
+ "cvss": null,
288356
+ "cwes": [
288357
+ {
288358
+ "cwe_id": "CWE-123",
288359
+ "name": "A CWE"
288360
+ }
288361
+ ],
288362
+ "cwe_ids": [
288363
+ "CWE-123"
288364
+ ],
288365
+ "credits": [
288366
+ {
288367
+ "login": "octocat",
288368
+ "type": "finder"
288369
+ }
288370
+ ],
288371
+ "credits_detailed": [
288372
+ {
288373
+ "user": {
288374
+ "login": "octocat",
288375
+ "id": 1,
288376
+ "node_id": "MDQ6VXNlcjE=",
288377
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
288378
+ "gravatar_id": "",
288379
+ "url": "https://api.github.com/users/octocat",
288380
+ "html_url": "https://github.com/octocat",
288381
+ "followers_url": "https://api.github.com/users/octocat/followers",
288382
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
288383
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
288384
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
288385
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
288386
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
288387
+ "repos_url": "https://api.github.com/users/octocat/repos",
288388
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
288389
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
288390
+ "type": "User",
288391
+ "site_admin": false
288392
+ },
288393
+ "type": "finder",
288394
+ "state": "accepted"
288395
+ }
288396
+ ]
288397
+ }
288398
+ },
287377
288399
  "simple-user-items-default-response": {
287378
288400
  "summary": "Default response",
287379
288401
  "value": [
@@ -295325,6 +296347,15 @@
295325
296347
  "type": "integer"
295326
296348
  }
295327
296349
  },
296350
+ "protection-rule-id": {
296351
+ "name": "protection_rule_id",
296352
+ "description": "The unique identifier of the protection rule.",
296353
+ "in": "path",
296354
+ "required": true,
296355
+ "schema": {
296356
+ "type": "integer"
296357
+ }
296358
+ },
295328
296359
  "since-user": {
295329
296360
  "name": "since",
295330
296361
  "description": "A user ID. Only return users with an ID greater than this ID.",