@octokit/openapi 11.0.0 → 11.1.1

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 (31) hide show
  1. package/generated/api.github.com.deref.json +7867 -1059
  2. package/generated/api.github.com.json +1150 -152
  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 +7870 -1062
  6. package/generated/ghec.json +1153 -155
  7. package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +0 -84
  8. package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +292 -4865
  9. package/generated/ghes-3.5-diff-to-ghes-3.6.json +2 -675
  10. package/generated/ghes-3.5.deref.json +208 -60
  11. package/generated/ghes-3.5.json +21 -60
  12. package/generated/ghes-3.6-anicca-diff-to-ghes-3.7.deref.json +0 -48
  13. package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +2 -4739
  14. package/generated/ghes-3.6-diff-to-ghes-3.7.json +2 -684
  15. package/generated/ghes-3.6.deref.json +44 -60
  16. package/generated/ghes-3.6.json +21 -60
  17. package/generated/ghes-3.7-diff-to-ghes-3.8.deref.json +252 -11
  18. package/generated/ghes-3.7-diff-to-ghes-3.8.json +1 -1
  19. package/generated/ghes-3.7.deref.json +282 -63
  20. package/generated/ghes-3.7.json +133 -63
  21. package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +17 -38
  22. package/generated/ghes-3.8-diff-to-api.github.com.deref.json +252 -4758
  23. package/generated/ghes-3.8-diff-to-api.github.com.json +1 -672
  24. package/generated/ghes-3.8.deref.json +433 -70
  25. package/generated/ghes-3.8.json +284 -70
  26. package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +17 -84
  27. package/generated/github.ae-diff-to-api.github.com.deref.json +13247 -12990
  28. package/generated/github.ae-diff-to-api.github.com.json +1351 -1935
  29. package/generated/github.ae.deref.json +5201 -73
  30. package/generated/github.ae.json +424 -73
  31. 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.1",
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": {
@@ -2189,6 +2189,7 @@
2189
2189
  "content": {
2190
2190
  "application/json": {
2191
2191
  "schema": {
2192
+ "type": "object",
2192
2193
  "properties": {
2193
2194
  "description": {
2194
2195
  "description": "The description of the gist.",
@@ -2205,29 +2206,20 @@
2205
2206
  },
2206
2207
  "type": "object",
2207
2208
  "additionalProperties": {
2208
- "type": "object",
2209
- "nullable": true,
2210
- "properties": {
2211
- "content": {
2212
- "description": "The new content of the file.",
2213
- "type": "string"
2214
- },
2215
- "filename": {
2216
- "description": "The new filename for the file.",
2217
- "type": "string",
2218
- "nullable": true
2219
- }
2220
- },
2221
- "anyOf": [
2222
- {
2223
- "required": [
2224
- "content"
2225
- ]
2226
- },
2209
+ "oneOf": [
2227
2210
  {
2228
- "required": [
2229
- "filename"
2230
- ]
2211
+ "type": "object",
2212
+ "properties": {
2213
+ "content": {
2214
+ "description": "The new content of the file.",
2215
+ "type": "string"
2216
+ },
2217
+ "filename": {
2218
+ "description": "The new filename for the file.",
2219
+ "type": "string",
2220
+ "nullable": true
2221
+ }
2222
+ }
2231
2223
  },
2232
2224
  {
2233
2225
  "type": "object",
@@ -2237,19 +2229,6 @@
2237
2229
  }
2238
2230
  }
2239
2231
  },
2240
- "anyOf": [
2241
- {
2242
- "required": [
2243
- "description"
2244
- ]
2245
- },
2246
- {
2247
- "required": [
2248
- "files"
2249
- ]
2250
- }
2251
- ],
2252
- "type": "object",
2253
2232
  "nullable": true
2254
2233
  },
2255
2234
  "examples": {
@@ -14307,10 +14286,9 @@
14307
14286
  "examples": {
14308
14287
  "default": {
14309
14288
  "value": {
14310
- "id": 21,
14311
14289
  "name": "super cool ruleset",
14312
14290
  "target": "branch",
14313
- "enforcement": "enabled",
14291
+ "enforcement": "active",
14314
14292
  "bypass_actors": [
14315
14293
  {
14316
14294
  "actor_id": 234,
@@ -14502,10 +14480,9 @@
14502
14480
  "examples": {
14503
14481
  "default": {
14504
14482
  "value": {
14505
- "id": 21,
14506
14483
  "name": "super cool ruleset",
14507
14484
  "target": "branch",
14508
- "enforcement": "enabled",
14485
+ "enforcement": "active",
14509
14486
  "bypass_actors": [
14510
14487
  {
14511
14488
  "actor_id": 234,
@@ -21954,6 +21931,70 @@
21954
21931
  "x-octokit": {}
21955
21932
  }
21956
21933
  },
21934
+ "/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
21935
+ "post": {
21936
+ "summary": "Review custom deployment protection rules for a workflow run",
21937
+ "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.",
21938
+ "tags": [
21939
+ "actions"
21940
+ ],
21941
+ "operationId": "actions/review-custom-gates-for-run",
21942
+ "externalDocs": {
21943
+ "description": "API method documentation",
21944
+ "url": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
21945
+ },
21946
+ "parameters": [
21947
+ {
21948
+ "$ref": "#/components/parameters/owner"
21949
+ },
21950
+ {
21951
+ "$ref": "#/components/parameters/repo"
21952
+ },
21953
+ {
21954
+ "$ref": "#/components/parameters/run-id"
21955
+ }
21956
+ ],
21957
+ "requestBody": {
21958
+ "required": true,
21959
+ "content": {
21960
+ "application/json": {
21961
+ "schema": {
21962
+ "anyOf": [
21963
+ {
21964
+ "$ref": "#/components/schemas/review-custom-gates-comment-required"
21965
+ },
21966
+ {
21967
+ "$ref": "#/components/schemas/review-custom-gates-state-required"
21968
+ }
21969
+ ]
21970
+ },
21971
+ "examples": {
21972
+ "default": {
21973
+ "value": {
21974
+ "environment_name": "prod-eus",
21975
+ "state": "approved",
21976
+ "comment": "All health checks passed."
21977
+ }
21978
+ }
21979
+ }
21980
+ }
21981
+ }
21982
+ },
21983
+ "responses": {
21984
+ "204": {
21985
+ "description": "Response"
21986
+ }
21987
+ },
21988
+ "x-github": {
21989
+ "githubCloudOnly": false,
21990
+ "enabledForGitHubApps": true,
21991
+ "previews": [],
21992
+ "category": "actions",
21993
+ "subcategory": "workflow-runs"
21994
+ },
21995
+ "x-octokit": {}
21996
+ }
21997
+ },
21957
21998
  "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
21958
21999
  "get": {
21959
22000
  "summary": "List jobs for a workflow run",
@@ -29104,7 +29145,7 @@
29104
29145
  "type": "string"
29105
29146
  },
29106
29147
  "location": {
29107
- "description": "Location for this codespace. Assigned by IP if not provided",
29148
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
29108
29149
  "type": "string"
29109
29150
  },
29110
29151
  "client_ip": {
@@ -33996,10 +34037,296 @@
33996
34037
  "x-octokit": {}
33997
34038
  }
33998
34039
  },
34040
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
34041
+ "get": {
34042
+ "summary": "Get all deployment protection rules for an environment",
34043
+ "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).",
34044
+ "tags": [
34045
+ "repos"
34046
+ ],
34047
+ "operationId": "repos/get-all-deployment-protection-rules",
34048
+ "externalDocs": {
34049
+ "description": "API method documentation",
34050
+ "url": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules"
34051
+ },
34052
+ "parameters": [
34053
+ {
34054
+ "$ref": "#/components/parameters/environment-name"
34055
+ },
34056
+ {
34057
+ "$ref": "#/components/parameters/repo"
34058
+ },
34059
+ {
34060
+ "$ref": "#/components/parameters/owner"
34061
+ }
34062
+ ],
34063
+ "responses": {
34064
+ "200": {
34065
+ "description": "List of deployment protection rules",
34066
+ "content": {
34067
+ "application/json": {
34068
+ "schema": {
34069
+ "type": "object",
34070
+ "properties": {
34071
+ "total_count": {
34072
+ "description": "The number of enabled custom deployment protection rules for this environment",
34073
+ "type": "integer",
34074
+ "example": 10
34075
+ },
34076
+ "custom_deployment_protection_rules": {
34077
+ "type": "array",
34078
+ "items": {
34079
+ "$ref": "#/components/schemas/deployment-protection-rule"
34080
+ }
34081
+ }
34082
+ },
34083
+ "example": "../../components/examples/deployment_protection_rules.yaml"
34084
+ }
34085
+ }
34086
+ }
34087
+ }
34088
+ },
34089
+ "x-github": {
34090
+ "githubCloudOnly": false,
34091
+ "enabledForGitHubApps": true,
34092
+ "category": "deployments",
34093
+ "subcategory": "protection-rules"
34094
+ },
34095
+ "x-octokit": {}
34096
+ },
34097
+ "post": {
34098
+ "summary": "Create a custom deployment protection rule on an environment",
34099
+ "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).",
34100
+ "tags": [
34101
+ "repos"
34102
+ ],
34103
+ "operationId": "repos/create-deployment-protection-rule",
34104
+ "externalDocs": {
34105
+ "description": "API method documentation",
34106
+ "url": "https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule"
34107
+ },
34108
+ "parameters": [
34109
+ {
34110
+ "$ref": "#/components/parameters/environment-name"
34111
+ },
34112
+ {
34113
+ "$ref": "#/components/parameters/repo"
34114
+ },
34115
+ {
34116
+ "$ref": "#/components/parameters/owner"
34117
+ }
34118
+ ],
34119
+ "requestBody": {
34120
+ "content": {
34121
+ "application/json": {
34122
+ "schema": {
34123
+ "type": "object",
34124
+ "properties": {
34125
+ "integration_id": {
34126
+ "type": "integer",
34127
+ "description": "The ID of the custom app that will be enabled on the environment."
34128
+ }
34129
+ }
34130
+ },
34131
+ "examples": {
34132
+ "default": {
34133
+ "value": {
34134
+ "integration_id": 5
34135
+ }
34136
+ }
34137
+ }
34138
+ }
34139
+ },
34140
+ "required": true
34141
+ },
34142
+ "responses": {
34143
+ "201": {
34144
+ "description": "The enabled custom deployment protection rule",
34145
+ "content": {
34146
+ "application/json": {
34147
+ "schema": {
34148
+ "$ref": "#/components/schemas/deployment-protection-rule"
34149
+ },
34150
+ "examples": {
34151
+ "default": {
34152
+ "$ref": "#/components/examples/deployment-protection-rule"
34153
+ }
34154
+ }
34155
+ }
34156
+ }
34157
+ }
34158
+ },
34159
+ "x-github": {
34160
+ "githubCloudOnly": false,
34161
+ "enabledForGitHubApps": true,
34162
+ "category": "deployments",
34163
+ "subcategory": "protection-rules"
34164
+ },
34165
+ "x-octokit": {}
34166
+ }
34167
+ },
34168
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
34169
+ "get": {
34170
+ "summary": "List custom deployment rule integrations available for an environment",
34171
+ "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)\".",
34172
+ "tags": [
34173
+ "repos"
34174
+ ],
34175
+ "operationId": "repos/list-custom-deployment-rule-integrations",
34176
+ "externalDocs": {
34177
+ "description": "API method documentation",
34178
+ "url": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations"
34179
+ },
34180
+ "parameters": [
34181
+ {
34182
+ "$ref": "#/components/parameters/environment-name"
34183
+ },
34184
+ {
34185
+ "$ref": "#/components/parameters/repo"
34186
+ },
34187
+ {
34188
+ "$ref": "#/components/parameters/owner"
34189
+ },
34190
+ {
34191
+ "$ref": "#/components/parameters/page"
34192
+ },
34193
+ {
34194
+ "$ref": "#/components/parameters/per-page"
34195
+ }
34196
+ ],
34197
+ "responses": {
34198
+ "200": {
34199
+ "description": "A list of custom deployment rule integrations available for this environment.",
34200
+ "content": {
34201
+ "application/json": {
34202
+ "schema": {
34203
+ "type": "object",
34204
+ "properties": {
34205
+ "total_count": {
34206
+ "description": "The total number of custom deployment protection rule integrations available for this environment.",
34207
+ "type": "integer",
34208
+ "example": 35
34209
+ },
34210
+ "available_custom_deployment_protection_rule_integrations": {
34211
+ "type": "array",
34212
+ "items": {
34213
+ "$ref": "#/components/schemas/custom-deployment-rule-app"
34214
+ }
34215
+ }
34216
+ }
34217
+ },
34218
+ "examples": {
34219
+ "default": {
34220
+ "$ref": "#/components/examples/custom-deployment-protection-rule-apps"
34221
+ }
34222
+ }
34223
+ }
34224
+ }
34225
+ }
34226
+ },
34227
+ "x-github": {
34228
+ "githubCloudOnly": false,
34229
+ "enabledForGitHubApps": true,
34230
+ "category": "deployments",
34231
+ "subcategory": "protection-rules"
34232
+ },
34233
+ "x-octokit": {}
34234
+ }
34235
+ },
34236
+ "/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
34237
+ "get": {
34238
+ "summary": "Get a custom deployment protection rule",
34239
+ "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).",
34240
+ "tags": [
34241
+ "repos"
34242
+ ],
34243
+ "operationId": "repos/get-custom-deployment-protection-rule",
34244
+ "externalDocs": {
34245
+ "description": "API method documentation",
34246
+ "url": "https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule"
34247
+ },
34248
+ "parameters": [
34249
+ {
34250
+ "$ref": "#/components/parameters/owner"
34251
+ },
34252
+ {
34253
+ "$ref": "#/components/parameters/repo"
34254
+ },
34255
+ {
34256
+ "$ref": "#/components/parameters/environment-name"
34257
+ },
34258
+ {
34259
+ "$ref": "#/components/parameters/protection-rule-id"
34260
+ }
34261
+ ],
34262
+ "responses": {
34263
+ "200": {
34264
+ "description": "Response",
34265
+ "content": {
34266
+ "application/json": {
34267
+ "schema": {
34268
+ "$ref": "#/components/schemas/deployment-protection-rule"
34269
+ },
34270
+ "examples": {
34271
+ "default": {
34272
+ "$ref": "#/components/examples/deployment-protection-rule"
34273
+ }
34274
+ }
34275
+ }
34276
+ }
34277
+ }
34278
+ },
34279
+ "x-github": {
34280
+ "githubCloudOnly": false,
34281
+ "enabledForGitHubApps": true,
34282
+ "category": "deployments",
34283
+ "subcategory": "protection-rules"
34284
+ },
34285
+ "x-octokit": {}
34286
+ },
34287
+ "delete": {
34288
+ "summary": "Disable a custom protection rule for an environment",
34289
+ "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)\".",
34290
+ "tags": [
34291
+ "repos"
34292
+ ],
34293
+ "operationId": "repos/disable-deployment-protection-rule",
34294
+ "externalDocs": {
34295
+ "description": "API method documentation",
34296
+ "url": "https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule"
34297
+ },
34298
+ "parameters": [
34299
+ {
34300
+ "$ref": "#/components/parameters/environment-name"
34301
+ },
34302
+ {
34303
+ "$ref": "#/components/parameters/repo"
34304
+ },
34305
+ {
34306
+ "$ref": "#/components/parameters/owner"
34307
+ },
34308
+ {
34309
+ "$ref": "#/components/parameters/protection-rule-id"
34310
+ }
34311
+ ],
34312
+ "responses": {
34313
+ "204": {
34314
+ "description": "Response"
34315
+ }
34316
+ },
34317
+ "x-github": {
34318
+ "githubCloudOnly": false,
34319
+ "enabledForGitHubApps": true,
34320
+ "category": "deployments",
34321
+ "subcategory": "protection-rules"
34322
+ },
34323
+ "x-octokit": {}
34324
+ }
34325
+ },
33999
34326
  "/repos/{owner}/{repo}/events": {
34000
34327
  "get": {
34001
34328
  "summary": "List repository events",
34002
- "description": "",
34329
+ "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
34330
  "tags": [
34004
34331
  "activity"
34005
34332
  ],
@@ -36155,7 +36482,7 @@
36155
36482
  "/repos/{owner}/{repo}/import": {
36156
36483
  "get": {
36157
36484
  "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.",
36485
+ "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
36486
  "tags": [
36160
36487
  "migrations"
36161
36488
  ],
@@ -36205,7 +36532,7 @@
36205
36532
  },
36206
36533
  "put": {
36207
36534
  "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.",
36535
+ "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
36536
  "tags": [
36210
36537
  "migrations"
36211
36538
  ],
@@ -36317,7 +36644,7 @@
36317
36644
  },
36318
36645
  "patch": {
36319
36646
  "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.",
36647
+ "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
36648
  "tags": [
36322
36649
  "migrations"
36323
36650
  ],
@@ -36427,7 +36754,7 @@
36427
36754
  },
36428
36755
  "delete": {
36429
36756
  "summary": "Cancel an import",
36430
- "description": "Stop an import for a repository.",
36757
+ "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
36758
  "tags": [
36432
36759
  "migrations"
36433
36760
  ],
@@ -36464,7 +36791,7 @@
36464
36791
  "/repos/{owner}/{repo}/import/authors": {
36465
36792
  "get": {
36466
36793
  "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.",
36794
+ "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
36795
  "tags": [
36469
36796
  "migrations"
36470
36797
  ],
@@ -36522,7 +36849,7 @@
36522
36849
  "/repos/{owner}/{repo}/import/authors/{author_id}": {
36523
36850
  "patch": {
36524
36851
  "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.",
36852
+ "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
36853
  "tags": [
36527
36854
  "migrations"
36528
36855
  ],
@@ -36614,7 +36941,7 @@
36614
36941
  "/repos/{owner}/{repo}/import/large_files": {
36615
36942
  "get": {
36616
36943
  "summary": "Get large files",
36617
- "description": "List files larger than 100MB found during the import",
36944
+ "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
36945
  "tags": [
36619
36946
  "migrations"
36620
36947
  ],
@@ -36666,7 +36993,7 @@
36666
36993
  "/repos/{owner}/{repo}/import/lfs": {
36667
36994
  "patch": {
36668
36995
  "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).",
36996
+ "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
36997
  "tags": [
36671
36998
  "migrations"
36672
36999
  ],
@@ -42893,7 +43220,7 @@
42893
43220
  "nullable": true,
42894
43221
  "properties": {
42895
43222
  "location": {
42896
- "description": "Location for this codespace. Assigned by IP if not provided",
43223
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
42897
43224
  "type": "string"
42898
43225
  },
42899
43226
  "client_ip": {
@@ -43738,19 +44065,7 @@
43738
44065
  "type": "string"
43739
44066
  }
43740
44067
  }
43741
- },
43742
- "anyOf": [
43743
- {
43744
- "required": [
43745
- "reviewers"
43746
- ]
43747
- },
43748
- {
43749
- "required": [
43750
- "team_reviewers"
43751
- ]
43752
- }
43753
- ]
44068
+ }
43754
44069
  },
43755
44070
  "examples": {
43756
44071
  "default": {
@@ -46111,10 +46426,9 @@
46111
46426
  "examples": {
46112
46427
  "default": {
46113
46428
  "value": {
46114
- "id": 42,
46115
46429
  "name": "super cool ruleset",
46116
46430
  "target": "branch",
46117
- "enforcement": "enabled",
46431
+ "enforcement": "active",
46118
46432
  "bypass_mode": "repository",
46119
46433
  "bypass_actors": [
46120
46434
  {
@@ -46331,10 +46645,9 @@
46331
46645
  "examples": {
46332
46646
  "default": {
46333
46647
  "value": {
46334
- "id": 42,
46335
46648
  "name": "super cool ruleset",
46336
46649
  "target": "branch",
46337
- "enforcement": "enabled",
46650
+ "enforcement": "active",
46338
46651
  "bypass_mode": "repository",
46339
46652
  "bypass_actors": [
46340
46653
  {
@@ -46995,6 +47308,96 @@
46995
47308
  "x-octokit": {}
46996
47309
  }
46997
47310
  },
47311
+ "/repos/{owner}/{repo}/security-advisories/reports": {
47312
+ "post": {
47313
+ "summary": "Privately report a security vulnerability",
47314
+ "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.",
47315
+ "tags": [
47316
+ "security-advisories"
47317
+ ],
47318
+ "operationId": "security-advisories/create-private-vulnerability-report",
47319
+ "externalDocs": {
47320
+ "description": "API method documentation",
47321
+ "url": "https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
47322
+ },
47323
+ "parameters": [
47324
+ {
47325
+ "$ref": "#/components/parameters/owner"
47326
+ },
47327
+ {
47328
+ "$ref": "#/components/parameters/repo"
47329
+ }
47330
+ ],
47331
+ "requestBody": {
47332
+ "required": true,
47333
+ "content": {
47334
+ "application/json": {
47335
+ "schema": {
47336
+ "$ref": "#/components/schemas/private-vulnerability-report-create"
47337
+ },
47338
+ "examples": {
47339
+ "default": {
47340
+ "value": {
47341
+ "summary": "A newly discovered vulnerability",
47342
+ "description": "A more in-depth description of what the problem is.",
47343
+ "severity": "high",
47344
+ "vulnerabilities": [
47345
+ {
47346
+ "package": {
47347
+ "name": "a-package",
47348
+ "ecosystem": "npm"
47349
+ },
47350
+ "vulnerable_version_range": "< 1.0.0",
47351
+ "patched_versions": "1.0.0",
47352
+ "vulnerable_functions": [
47353
+ "important_function"
47354
+ ]
47355
+ }
47356
+ ],
47357
+ "cwe_ids": [
47358
+ "CWE-123"
47359
+ ]
47360
+ }
47361
+ }
47362
+ }
47363
+ }
47364
+ }
47365
+ },
47366
+ "responses": {
47367
+ "201": {
47368
+ "description": "Response",
47369
+ "content": {
47370
+ "application/json": {
47371
+ "schema": {
47372
+ "$ref": "#/components/schemas/repository-advisory"
47373
+ },
47374
+ "examples": {
47375
+ "default": {
47376
+ "$ref": "#/components/examples/repository-advisory-pvr"
47377
+ }
47378
+ }
47379
+ }
47380
+ }
47381
+ },
47382
+ "403": {
47383
+ "$ref": "#/components/responses/forbidden"
47384
+ },
47385
+ "404": {
47386
+ "$ref": "#/components/responses/not_found"
47387
+ },
47388
+ "422": {
47389
+ "$ref": "#/components/responses/validation_failed"
47390
+ }
47391
+ },
47392
+ "x-github": {
47393
+ "githubCloudOnly": false,
47394
+ "enabledForGitHubApps": true,
47395
+ "category": "security-advisories",
47396
+ "subcategory": "repository-advisories"
47397
+ },
47398
+ "x-octokit": {}
47399
+ }
47400
+ },
46998
47401
  "/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
46999
47402
  "get": {
47000
47403
  "summary": "Get a repository security advisory",
@@ -49575,7 +49978,7 @@
49575
49978
  "/search/code": {
49576
49979
  "get": {
49577
49980
  "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/).",
49981
+ "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
49982
  "tags": [
49580
49983
  "search"
49581
49984
  ],
@@ -49597,7 +50000,7 @@
49597
50000
  {
49598
50001
  "name": "sort",
49599
50002
  "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)",
50003
+ "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
50004
  "in": "query",
49602
50005
  "required": false,
49603
50006
  "schema": {
@@ -49609,7 +50012,7 @@
49609
50012
  },
49610
50013
  {
49611
50014
  "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`. ",
50015
+ "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
50016
  "in": "query",
49614
50017
  "deprecated": true,
49615
50018
  "required": false,
@@ -52917,7 +53320,7 @@
52917
53320
  "type": "string"
52918
53321
  },
52919
53322
  "location": {
52920
- "description": "Location for this codespace. Assigned by IP if not provided",
53323
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
52921
53324
  "type": "string"
52922
53325
  },
52923
53326
  "client_ip": {
@@ -52979,7 +53382,7 @@
52979
53382
  }
52980
53383
  },
52981
53384
  "location": {
52982
- "description": "Location for this codespace. Assigned by IP if not provided",
53385
+ "description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
52983
53386
  "type": "string"
52984
53387
  },
52985
53388
  "machine": {
@@ -62975,7 +63378,100 @@
62975
63378
  "content": {
62976
63379
  "application/json": {
62977
63380
  "schema": {
62978
- "$ref": "#/components/schemas/webhook-dependabot-alert-created"
63381
+ "$ref": "#/components/schemas/webhook-dependabot-alert-created"
63382
+ }
63383
+ }
63384
+ }
63385
+ },
63386
+ "responses": {
63387
+ "200": {
63388
+ "description": "Return a 200 status to indicate that the data was received successfully"
63389
+ }
63390
+ },
63391
+ "x-github": {
63392
+ "githubCloudOnly": false,
63393
+ "category": "webhooks",
63394
+ "subcategory": "dependabot-alert",
63395
+ "supported-webhook-types": [
63396
+ "repository",
63397
+ "organization",
63398
+ "app"
63399
+ ]
63400
+ }
63401
+ }
63402
+ },
63403
+ "dependabot-alert-dismissed": {
63404
+ "post": {
63405
+ "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.",
63406
+ "description": "A Dependabot alert was manually closed.",
63407
+ "operationId": "dependabot-alert/dismissed",
63408
+ "externalDocs": {
63409
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63410
+ },
63411
+ "parameters": [
63412
+ {
63413
+ "name": "User-Agent",
63414
+ "in": "header",
63415
+ "example": "GitHub-Hookshot/123abc",
63416
+ "schema": {
63417
+ "type": "string"
63418
+ }
63419
+ },
63420
+ {
63421
+ "name": "X-Github-Hook-Id",
63422
+ "in": "header",
63423
+ "example": 12312312,
63424
+ "schema": {
63425
+ "type": "string"
63426
+ }
63427
+ },
63428
+ {
63429
+ "name": "X-Github-Event",
63430
+ "in": "header",
63431
+ "example": "issues",
63432
+ "schema": {
63433
+ "type": "string"
63434
+ }
63435
+ },
63436
+ {
63437
+ "name": "X-Github-Hook-Installation-Target-Id",
63438
+ "in": "header",
63439
+ "example": 123123,
63440
+ "schema": {
63441
+ "type": "string"
63442
+ }
63443
+ },
63444
+ {
63445
+ "name": "X-Github-Hook-Installation-Target-Type",
63446
+ "in": "header",
63447
+ "example": "repository",
63448
+ "schema": {
63449
+ "type": "string"
63450
+ }
63451
+ },
63452
+ {
63453
+ "name": "X-GitHub-Delivery",
63454
+ "in": "header",
63455
+ "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
63456
+ "schema": {
63457
+ "type": "string"
63458
+ }
63459
+ },
63460
+ {
63461
+ "name": "X-Hub-Signature-256",
63462
+ "in": "header",
63463
+ "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
63464
+ "schema": {
63465
+ "type": "string"
63466
+ }
63467
+ }
63468
+ ],
63469
+ "requestBody": {
63470
+ "required": true,
63471
+ "content": {
63472
+ "application/json": {
63473
+ "schema": {
63474
+ "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
62979
63475
  }
62980
63476
  }
62981
63477
  }
@@ -62997,11 +63493,11 @@
62997
63493
  }
62998
63494
  }
62999
63495
  },
63000
- "dependabot-alert-dismissed": {
63496
+ "dependabot-alert-fixed": {
63001
63497
  "post": {
63002
63498
  "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",
63499
+ "description": "A manifest file change removed a vulnerability.",
63500
+ "operationId": "dependabot-alert/fixed",
63005
63501
  "externalDocs": {
63006
63502
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63007
63503
  },
@@ -63068,7 +63564,7 @@
63068
63564
  "content": {
63069
63565
  "application/json": {
63070
63566
  "schema": {
63071
- "$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
63567
+ "$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
63072
63568
  }
63073
63569
  }
63074
63570
  }
@@ -63090,11 +63586,11 @@
63090
63586
  }
63091
63587
  }
63092
63588
  },
63093
- "dependabot-alert-fixed": {
63589
+ "dependabot-alert-reintroduced": {
63094
63590
  "post": {
63095
63591
  "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",
63592
+ "description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.",
63593
+ "operationId": "dependabot-alert/reintroduced",
63098
63594
  "externalDocs": {
63099
63595
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63100
63596
  },
@@ -63161,7 +63657,7 @@
63161
63657
  "content": {
63162
63658
  "application/json": {
63163
63659
  "schema": {
63164
- "$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
63660
+ "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
63165
63661
  }
63166
63662
  }
63167
63663
  }
@@ -63183,11 +63679,11 @@
63183
63679
  }
63184
63680
  }
63185
63681
  },
63186
- "dependabot-alert-reintroduced": {
63682
+ "dependabot-alert-reopened": {
63187
63683
  "post": {
63188
63684
  "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",
63685
+ "description": "A Dependabot alert was manually reopened.",
63686
+ "operationId": "dependabot-alert/reopened",
63191
63687
  "externalDocs": {
63192
63688
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63193
63689
  },
@@ -63254,7 +63750,7 @@
63254
63750
  "content": {
63255
63751
  "application/json": {
63256
63752
  "schema": {
63257
- "$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
63753
+ "$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
63258
63754
  }
63259
63755
  }
63260
63756
  }
@@ -63276,13 +63772,13 @@
63276
63772
  }
63277
63773
  }
63278
63774
  },
63279
- "dependabot-alert-reopened": {
63775
+ "deploy-key-created": {
63280
63776
  "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",
63777
+ "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.",
63778
+ "description": "A deploy key was created.",
63779
+ "operationId": "deploy-key/created",
63284
63780
  "externalDocs": {
63285
- "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
63781
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
63286
63782
  },
63287
63783
  "parameters": [
63288
63784
  {
@@ -63347,7 +63843,7 @@
63347
63843
  "content": {
63348
63844
  "application/json": {
63349
63845
  "schema": {
63350
- "$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
63846
+ "$ref": "#/components/schemas/webhook-deploy-key-created"
63351
63847
  }
63352
63848
  }
63353
63849
  }
@@ -63360,7 +63856,7 @@
63360
63856
  "x-github": {
63361
63857
  "githubCloudOnly": false,
63362
63858
  "category": "webhooks",
63363
- "subcategory": "dependabot-alert",
63859
+ "subcategory": "deploy-key",
63364
63860
  "supported-webhook-types": [
63365
63861
  "repository",
63366
63862
  "organization",
@@ -63369,11 +63865,11 @@
63369
63865
  }
63370
63866
  }
63371
63867
  },
63372
- "deploy-key-created": {
63868
+ "deploy-key-deleted": {
63373
63869
  "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",
63870
+ "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.",
63871
+ "description": "A deploy key was deleted.",
63872
+ "operationId": "deploy-key/deleted",
63377
63873
  "externalDocs": {
63378
63874
  "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
63379
63875
  },
@@ -63440,7 +63936,7 @@
63440
63936
  "content": {
63441
63937
  "application/json": {
63442
63938
  "schema": {
63443
- "$ref": "#/components/schemas/webhook-deploy-key-created"
63939
+ "$ref": "#/components/schemas/webhook-deploy-key-deleted"
63444
63940
  }
63445
63941
  }
63446
63942
  }
@@ -63462,13 +63958,13 @@
63462
63958
  }
63463
63959
  }
63464
63960
  },
63465
- "deploy-key-deleted": {
63961
+ "deployment-created": {
63466
63962
  "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",
63963
+ "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.",
63964
+ "description": "A deployment was created.",
63965
+ "operationId": "deployment/created",
63470
63966
  "externalDocs": {
63471
- "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
63967
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment"
63472
63968
  },
63473
63969
  "parameters": [
63474
63970
  {
@@ -63533,7 +64029,7 @@
63533
64029
  "content": {
63534
64030
  "application/json": {
63535
64031
  "schema": {
63536
- "$ref": "#/components/schemas/webhook-deploy-key-deleted"
64032
+ "$ref": "#/components/schemas/webhook-deployment-created"
63537
64033
  }
63538
64034
  }
63539
64035
  }
@@ -63546,7 +64042,7 @@
63546
64042
  "x-github": {
63547
64043
  "githubCloudOnly": false,
63548
64044
  "category": "webhooks",
63549
- "subcategory": "deploy-key",
64045
+ "subcategory": "deployment",
63550
64046
  "supported-webhook-types": [
63551
64047
  "repository",
63552
64048
  "organization",
@@ -63555,13 +64051,13 @@
63555
64051
  }
63556
64052
  }
63557
64053
  },
63558
- "deployment-created": {
64054
+ "deployment-protection-rule-requested": {
63559
64055
  "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",
64056
+ "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.",
64057
+ "description": "A deployment protection rule was requested for an environment.",
64058
+ "operationId": "deployment-protection-rule/requested",
63563
64059
  "externalDocs": {
63564
- "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment"
64060
+ "url": "https://docs.github.com/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule"
63565
64061
  },
63566
64062
  "parameters": [
63567
64063
  {
@@ -63626,7 +64122,7 @@
63626
64122
  "content": {
63627
64123
  "application/json": {
63628
64124
  "schema": {
63629
- "$ref": "#/components/schemas/webhook-deployment-created"
64125
+ "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested"
63630
64126
  }
63631
64127
  }
63632
64128
  }
@@ -63639,10 +64135,8 @@
63639
64135
  "x-github": {
63640
64136
  "githubCloudOnly": false,
63641
64137
  "category": "webhooks",
63642
- "subcategory": "deployment",
64138
+ "subcategory": "deployment-protection-rule",
63643
64139
  "supported-webhook-types": [
63644
- "repository",
63645
- "organization",
63646
64140
  "app"
63647
64141
  ]
63648
64142
  }
@@ -89844,7 +90338,7 @@
89844
90338
  }
89845
90339
  },
89846
90340
  "location": {
89847
- "description": "The Azure region where this codespace is located.",
90341
+ "description": "The initally assigned location of a new codespace.",
89848
90342
  "enum": [
89849
90343
  "EastUs",
89850
90344
  "SouthEastAsia",
@@ -96339,6 +96833,48 @@
96339
96833
  "comment"
96340
96834
  ]
96341
96835
  },
96836
+ "review-custom-gates-comment-required": {
96837
+ "type": "object",
96838
+ "properties": {
96839
+ "environment_name": {
96840
+ "type": "string",
96841
+ "description": "The name of the environment to approve or reject."
96842
+ },
96843
+ "comment": {
96844
+ "type": "string",
96845
+ "description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**"
96846
+ }
96847
+ },
96848
+ "required": [
96849
+ "environment_name",
96850
+ "comment"
96851
+ ]
96852
+ },
96853
+ "review-custom-gates-state-required": {
96854
+ "type": "object",
96855
+ "properties": {
96856
+ "environment_name": {
96857
+ "type": "string",
96858
+ "description": "The name of the environment to approve or reject."
96859
+ },
96860
+ "state": {
96861
+ "type": "string",
96862
+ "description": "Whether to approve or reject deployment to the specified environments.",
96863
+ "enum": [
96864
+ "approved",
96865
+ "rejected"
96866
+ ]
96867
+ },
96868
+ "comment": {
96869
+ "type": "string",
96870
+ "description": "Optional comment to include with the review."
96871
+ }
96872
+ },
96873
+ "required": [
96874
+ "environment_name",
96875
+ "state"
96876
+ ]
96877
+ },
96342
96878
  "deployment-reviewer-type": {
96343
96879
  "type": "string",
96344
96880
  "description": "The type of reviewer.",
@@ -98872,8 +99408,13 @@
98872
99408
  "items": {
98873
99409
  "type": "string",
98874
99410
  "enum": [
99411
+ "c",
99412
+ "cpp",
99413
+ "csharp",
98875
99414
  "go",
99415
+ "java",
98876
99416
  "javascript",
99417
+ "kotlin",
98877
99418
  "python",
98878
99419
  "ruby",
98879
99420
  "typescript"
@@ -102013,6 +102554,70 @@
102013
102554
  "name"
102014
102555
  ]
102015
102556
  },
102557
+ "custom-deployment-rule-app": {
102558
+ "title": "Custom deployment protection rule app",
102559
+ "description": "A GitHub App that is providing a custom deployment protection rule.",
102560
+ "type": "object",
102561
+ "properties": {
102562
+ "id": {
102563
+ "type": "integer",
102564
+ "example": 3515,
102565
+ "description": "The unique identifier of the deployment protection rule integration."
102566
+ },
102567
+ "slug": {
102568
+ "type": "string",
102569
+ "example": "my-custom-app",
102570
+ "description": "The slugified name of the deployment protection rule integration."
102571
+ },
102572
+ "integration_url": {
102573
+ "type": "string",
102574
+ "example": "https://api.github.com/apps/custom-app-slug",
102575
+ "description": "The URL for the endpoint to get details about the app."
102576
+ },
102577
+ "node_id": {
102578
+ "type": "string",
102579
+ "example": "MDQ6R2F0ZTM1MTU=",
102580
+ "description": "The node ID for the deployment protection rule integration."
102581
+ }
102582
+ },
102583
+ "required": [
102584
+ "id",
102585
+ "slug",
102586
+ "integration_url",
102587
+ "node_id"
102588
+ ]
102589
+ },
102590
+ "deployment-protection-rule": {
102591
+ "title": "Deployment protection rule",
102592
+ "description": "Deployment protection rule",
102593
+ "type": "object",
102594
+ "properties": {
102595
+ "id": {
102596
+ "type": "integer",
102597
+ "example": 3515,
102598
+ "description": "The unique identifier for the deployment protection rule."
102599
+ },
102600
+ "node_id": {
102601
+ "type": "string",
102602
+ "example": "MDQ6R2F0ZTM1MTU=",
102603
+ "description": "The node ID for the deployment protection rule."
102604
+ },
102605
+ "enabled": {
102606
+ "type": "boolean",
102607
+ "example": true,
102608
+ "description": "Whether the deployment protection rule is enabled for the environment."
102609
+ },
102610
+ "app": {
102611
+ "$ref": "#/components/schemas/custom-deployment-rule-app"
102612
+ }
102613
+ },
102614
+ "required": [
102615
+ "id",
102616
+ "node_id",
102617
+ "enabled",
102618
+ "app"
102619
+ ]
102620
+ },
102016
102621
  "short-blob": {
102017
102622
  "title": "Short Blob",
102018
102623
  "description": "Short Blob",
@@ -108663,28 +109268,122 @@
108663
109268
  "type": "string"
108664
109269
  }
108665
109270
  },
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
- },
109271
+ "credits": {
109272
+ "type": "array",
109273
+ "description": "A list of users receiving credit for their participation in the security advisory.",
109274
+ "nullable": true,
109275
+ "items": {
109276
+ "type": "object",
109277
+ "properties": {
109278
+ "login": {
109279
+ "type": "string",
109280
+ "description": "The username of the user credited."
109281
+ },
109282
+ "type": {
109283
+ "$ref": "#/components/schemas/repository-advisory-credit-types"
109284
+ }
109285
+ },
109286
+ "required": [
109287
+ "login",
109288
+ "type"
109289
+ ],
109290
+ "additionalProperties": false
109291
+ }
109292
+ },
109293
+ "severity": {
109294
+ "type": "string",
109295
+ "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
109296
+ "nullable": true,
109297
+ "enum": [
109298
+ "critical",
109299
+ "high",
109300
+ "medium",
109301
+ "low"
109302
+ ]
109303
+ },
109304
+ "cvss_vector_string": {
109305
+ "type": "string",
109306
+ "description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
109307
+ "nullable": true
109308
+ }
109309
+ },
109310
+ "required": [
109311
+ "summary",
109312
+ "description",
109313
+ "vulnerabilities"
109314
+ ],
109315
+ "additionalProperties": false
109316
+ },
109317
+ "private-vulnerability-report-create": {
109318
+ "type": "object",
109319
+ "properties": {
109320
+ "summary": {
109321
+ "type": "string",
109322
+ "description": "A short summary of the advisory.",
109323
+ "maxLength": 1024
109324
+ },
109325
+ "description": {
109326
+ "type": "string",
109327
+ "description": "A detailed description of what the advisory impacts.",
109328
+ "maxLength": 65535
109329
+ },
109330
+ "vulnerabilities": {
109331
+ "type": "array",
109332
+ "description": "An array of products affected by the vulnerability detailed in a repository security advisory.",
109333
+ "nullable": true,
109334
+ "items": {
109335
+ "type": "object",
109336
+ "properties": {
109337
+ "package": {
109338
+ "description": "The name of the package affected by the vulnerability.",
109339
+ "type": "object",
109340
+ "properties": {
109341
+ "ecosystem": {
109342
+ "$ref": "#/components/schemas/repository-advisory-ecosystems"
109343
+ },
109344
+ "name": {
109345
+ "type": "string",
109346
+ "description": "The unique package name within its ecosystem.",
109347
+ "nullable": true
109348
+ }
109349
+ },
109350
+ "required": [
109351
+ "ecosystem"
109352
+ ]
109353
+ },
109354
+ "vulnerable_version_range": {
109355
+ "type": "string",
109356
+ "description": "The range of the package versions affected by the vulnerability.",
109357
+ "nullable": true
109358
+ },
109359
+ "patched_versions": {
109360
+ "type": "string",
109361
+ "description": "The package version(s) that resolve the vulnerability.",
109362
+ "nullable": true
109363
+ },
109364
+ "vulnerable_functions": {
109365
+ "type": "array",
109366
+ "description": "The functions in the package that are affected.",
109367
+ "nullable": true,
109368
+ "items": {
109369
+ "type": "string"
109370
+ }
109371
+ }
109372
+ },
109373
+ "required": [
109374
+ "package"
109375
+ ],
109376
+ "additionalProperties": false
109377
+ }
109378
+ },
109379
+ "cwe_ids": {
109380
+ "type": "array",
109381
+ "description": "A list of Common Weakness Enumeration (CWE) IDs.",
109382
+ "nullable": true,
109383
+ "items": {
109384
+ "type": "string"
109385
+ }
109386
+ },
108688
109387
  "severity": {
108689
109388
  "type": "string",
108690
109389
  "description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
@@ -108704,8 +109403,7 @@
108704
109403
  },
108705
109404
  "required": [
108706
109405
  "summary",
108707
- "description",
108708
- "vulnerabilities"
109406
+ "description"
108709
109407
  ],
108710
109408
  "additionalProperties": false
108711
109409
  },
@@ -110893,7 +111591,7 @@
110893
111591
  }
110894
111592
  },
110895
111593
  "location": {
110896
- "description": "The Azure region where this codespace is located.",
111594
+ "description": "The initally assigned location of a new codespace.",
110897
111595
  "enum": [
110898
111596
  "EastUs",
110899
111597
  "SouthEastAsia",
@@ -119732,6 +120430,52 @@
119732
120430
  "sender"
119733
120431
  ]
119734
120432
  },
120433
+ "webhook-deployment-protection-rule-requested": {
120434
+ "title": "deployment protection rule requested event",
120435
+ "type": "object",
120436
+ "properties": {
120437
+ "action": {
120438
+ "type": "string",
120439
+ "enum": [
120440
+ "requested"
120441
+ ]
120442
+ },
120443
+ "environment": {
120444
+ "description": "The name of the environment that has the deployment protection rule.",
120445
+ "type": "string"
120446
+ },
120447
+ "event": {
120448
+ "description": "The event that triggered the deployment protection rule.",
120449
+ "type": "string"
120450
+ },
120451
+ "deployment_callback_url": {
120452
+ "description": "The URL to review the deployment protection rule.",
120453
+ "type": "string",
120454
+ "format": "uri"
120455
+ },
120456
+ "deployment": {
120457
+ "$ref": "#/components/schemas/deployment"
120458
+ },
120459
+ "pull_requests": {
120460
+ "type": "array",
120461
+ "items": {
120462
+ "$ref": "#/components/schemas/pull-request"
120463
+ }
120464
+ },
120465
+ "repository": {
120466
+ "$ref": "#/components/schemas/repository"
120467
+ },
120468
+ "organization": {
120469
+ "$ref": "#/components/schemas/organization-simple"
120470
+ },
120471
+ "installation": {
120472
+ "$ref": "#/components/schemas/simple-installation"
120473
+ },
120474
+ "sender": {
120475
+ "$ref": "#/components/schemas/simple-user"
120476
+ }
120477
+ }
120478
+ },
119735
120479
  "webhook-deployment-status-created": {
119736
120480
  "title": "deployment_status created event",
119737
120481
  "type": "object",
@@ -162590,6 +163334,56 @@
162590
163334
  "sender"
162591
163335
  ]
162592
163336
  },
163337
+ "webhook-rubygems-metadata": {
163338
+ "title": "Ruby Gems metadata",
163339
+ "type": "object",
163340
+ "properties": {
163341
+ "name": {
163342
+ "type": "string"
163343
+ },
163344
+ "description": {
163345
+ "type": "string"
163346
+ },
163347
+ "readme": {
163348
+ "type": "string"
163349
+ },
163350
+ "homepage": {
163351
+ "type": "string"
163352
+ },
163353
+ "version_info": {
163354
+ "type": "object",
163355
+ "properties": {
163356
+ "version": {
163357
+ "type": "string"
163358
+ }
163359
+ }
163360
+ },
163361
+ "platform": {
163362
+ "type": "string"
163363
+ },
163364
+ "metadata": {
163365
+ "type": "object",
163366
+ "additionalProperties": {
163367
+ "type": "string"
163368
+ }
163369
+ },
163370
+ "repo": {
163371
+ "type": "string"
163372
+ },
163373
+ "dependencies": {
163374
+ "type": "array",
163375
+ "items": {
163376
+ "type": "object",
163377
+ "additionalProperties": {
163378
+ "type": "string"
163379
+ }
163380
+ }
163381
+ },
163382
+ "commit_oid": {
163383
+ "type": "string"
163384
+ }
163385
+ }
163386
+ },
162593
163387
  "webhook-package-published": {
162594
163388
  "title": "package published event",
162595
163389
  "type": "object",
@@ -162874,7 +163668,17 @@
162874
163668
  },
162875
163669
  "docker_metadata": {
162876
163670
  "type": "array",
162877
- "items": {}
163671
+ "items": {
163672
+ "type": "object",
163673
+ "properties": {
163674
+ "tags": {
163675
+ "type": "array",
163676
+ "items": {
163677
+ "type": "string"
163678
+ }
163679
+ }
163680
+ }
163681
+ }
162878
163682
  },
162879
163683
  "draft": {
162880
163684
  "type": "boolean"
@@ -163304,7 +164108,9 @@
163304
164108
  },
163305
164109
  "rubygems_metadata": {
163306
164110
  "type": "array",
163307
- "items": {}
164111
+ "items": {
164112
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
164113
+ }
163308
164114
  },
163309
164115
  "source_url": {
163310
164116
  "type": "string"
@@ -163653,7 +164459,17 @@
163653
164459
  },
163654
164460
  "docker_metadata": {
163655
164461
  "type": "array",
163656
- "items": {}
164462
+ "items": {
164463
+ "type": "object",
164464
+ "properties": {
164465
+ "tags": {
164466
+ "type": "array",
164467
+ "items": {
164468
+ "type": "string"
164469
+ }
164470
+ }
164471
+ }
164472
+ }
163657
164473
  },
163658
164474
  "draft": {
163659
164475
  "type": "boolean"
@@ -163673,7 +164489,10 @@
163673
164489
  },
163674
164490
  "metadata": {
163675
164491
  "type": "array",
163676
- "items": {}
164492
+ "items": {
164493
+ "type": "object",
164494
+ "additionalProperties": true
164495
+ }
163677
164496
  },
163678
164497
  "name": {
163679
164498
  "type": "string"
@@ -163885,7 +164704,9 @@
163885
164704
  },
163886
164705
  "rubygems_metadata": {
163887
164706
  "type": "array",
163888
- "items": {}
164707
+ "items": {
164708
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
164709
+ }
163889
164710
  },
163890
164711
  "source_url": {
163891
164712
  "type": "string",
@@ -244788,7 +245609,17 @@
244788
245609
  },
244789
245610
  "docker_metadata": {
244790
245611
  "type": "array",
244791
- "items": {}
245612
+ "items": {
245613
+ "type": "object",
245614
+ "properties": {
245615
+ "tags": {
245616
+ "type": "array",
245617
+ "items": {
245618
+ "type": "string"
245619
+ }
245620
+ }
245621
+ }
245622
+ }
244792
245623
  },
244793
245624
  "draft": {
244794
245625
  "type": "boolean"
@@ -245207,7 +246038,9 @@
245207
246038
  },
245208
246039
  "rubygems_metadata": {
245209
246040
  "type": "array",
245210
- "items": {}
246041
+ "items": {
246042
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
246043
+ }
245211
246044
  },
245212
246045
  "summary": {
245213
246046
  "type": "string"
@@ -245513,7 +246346,16 @@
245513
246346
  "docker_metadata": {
245514
246347
  "type": "array",
245515
246348
  "items": {
245516
- "nullable": true
246349
+ "type": "object",
246350
+ "nullable": true,
246351
+ "properties": {
246352
+ "tags": {
246353
+ "type": "array",
246354
+ "items": {
246355
+ "type": "string"
246356
+ }
246357
+ }
246358
+ }
245517
246359
  }
245518
246360
  },
245519
246361
  "draft": {
@@ -245533,7 +246375,10 @@
245533
246375
  },
245534
246376
  "metadata": {
245535
246377
  "type": "array",
245536
- "items": {}
246378
+ "items": {
246379
+ "type": "object",
246380
+ "additionalProperties": true
246381
+ }
245537
246382
  },
245538
246383
  "name": {
245539
246384
  "type": "string"
@@ -245716,7 +246561,9 @@
245716
246561
  },
245717
246562
  "rubygems_metadata": {
245718
246563
  "type": "array",
245719
- "items": {}
246564
+ "items": {
246565
+ "$ref": "#/components/schemas/webhook-rubygems-metadata"
246566
+ }
245720
246567
  },
245721
246568
  "summary": {
245722
246569
  "type": "string"
@@ -273076,7 +273923,7 @@
273076
273923
  "target": "branch",
273077
273924
  "source_type": "Organization",
273078
273925
  "source": "my-org",
273079
- "enforcement": "enabled",
273926
+ "enforcement": "active",
273080
273927
  "bypass_actors": [
273081
273928
  {
273082
273929
  "actor_id": 234,
@@ -281998,6 +282845,42 @@
281998
282845
  "name": "main"
281999
282846
  }
282000
282847
  },
282848
+ "deployment-protection-rule": {
282849
+ "value": {
282850
+ "id": 3,
282851
+ "node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
282852
+ "enabled": true,
282853
+ "app": {
282854
+ "id": 1,
282855
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
282856
+ "slug": "a-custom-app",
282857
+ "integration_url": "https://api.github.com/apps/a-custom-app"
282858
+ }
282859
+ }
282860
+ },
282861
+ "custom-deployment-protection-rule-apps": {
282862
+ "value": [
282863
+ {
282864
+ "total_count": 2
282865
+ },
282866
+ {
282867
+ "available_custom_deployment_protection_rule_integrations": [
282868
+ {
282869
+ "id": 1,
282870
+ "node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
282871
+ "slug": "a-custom-app",
282872
+ "integration_url": "https://api.github.com/apps/a-custom-app"
282873
+ },
282874
+ {
282875
+ "id": 2,
282876
+ "node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
282877
+ "slug": "another-custom-app",
282878
+ "integration_url": "https://api.github.com/apps/another-custom-app"
282879
+ }
282880
+ ]
282881
+ }
282882
+ ]
282883
+ },
282001
282884
  "repo-events-items": {
282002
282885
  "value": [
282003
282886
  {
@@ -286756,7 +287639,7 @@
286756
287639
  "target": "branch",
286757
287640
  "source_type": "Repository",
286758
287641
  "source": "monalisa/my-repo",
286759
- "enforcement": "enabled",
287642
+ "enforcement": "active",
286760
287643
  "bypass_mode": "repository",
286761
287644
  "bypass_actors": [
286762
287645
  {
@@ -287374,6 +288257,112 @@
287374
288257
  ]
287375
288258
  }
287376
288259
  },
288260
+ "repository-advisory-pvr": {
288261
+ "value": {
288262
+ "ghsa_id": "GHSA-abcd-1234-efgh",
288263
+ "cve_id": "CVE-2050-00000",
288264
+ "url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
288265
+ "html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
288266
+ "summary": "A newly discovered vulnerability",
288267
+ "description": "A more in-depth description of what the problem is.",
288268
+ "severity": "high",
288269
+ "author": {
288270
+ "login": "octocat",
288271
+ "id": 1,
288272
+ "node_id": "MDQ6VXNlcjE=",
288273
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
288274
+ "gravatar_id": "",
288275
+ "url": "https://api.github.com/users/octocat",
288276
+ "html_url": "https://github.com/octocat",
288277
+ "followers_url": "https://api.github.com/users/octocat/followers",
288278
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
288279
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
288280
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
288281
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
288282
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
288283
+ "repos_url": "https://api.github.com/users/octocat/repos",
288284
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
288285
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
288286
+ "type": "User",
288287
+ "site_admin": false
288288
+ },
288289
+ "publisher": null,
288290
+ "identifiers": [
288291
+ {
288292
+ "type": "GHSA",
288293
+ "value": "GHSA-abcd-1234-efgh"
288294
+ },
288295
+ {
288296
+ "type": "CVE",
288297
+ "value": null
288298
+ }
288299
+ ],
288300
+ "state": "triage",
288301
+ "created_at": "2020-01-01T00:00:00Z",
288302
+ "updated_at": "2020-01-02T00:00:00Z",
288303
+ "published_at": null,
288304
+ "closed_at": null,
288305
+ "withdrawn_at": null,
288306
+ "submission": {
288307
+ "accepted": false
288308
+ },
288309
+ "vulnerabilities": [
288310
+ {
288311
+ "package": {
288312
+ "ecosystem": "npm",
288313
+ "name": "a-package"
288314
+ },
288315
+ "vulnerable_version_range": "< 1.0.0",
288316
+ "patched_versions": "1.0.0",
288317
+ "vulnerable_functions": [
288318
+ "important_function"
288319
+ ]
288320
+ }
288321
+ ],
288322
+ "cvss": null,
288323
+ "cwes": [
288324
+ {
288325
+ "cwe_id": "CWE-123",
288326
+ "name": "A CWE"
288327
+ }
288328
+ ],
288329
+ "cwe_ids": [
288330
+ "CWE-123"
288331
+ ],
288332
+ "credits": [
288333
+ {
288334
+ "login": "octocat",
288335
+ "type": "finder"
288336
+ }
288337
+ ],
288338
+ "credits_detailed": [
288339
+ {
288340
+ "user": {
288341
+ "login": "octocat",
288342
+ "id": 1,
288343
+ "node_id": "MDQ6VXNlcjE=",
288344
+ "avatar_url": "https://github.com/images/error/octocat_happy.gif",
288345
+ "gravatar_id": "",
288346
+ "url": "https://api.github.com/users/octocat",
288347
+ "html_url": "https://github.com/octocat",
288348
+ "followers_url": "https://api.github.com/users/octocat/followers",
288349
+ "following_url": "https://api.github.com/users/octocat/following{/other_user}",
288350
+ "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
288351
+ "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
288352
+ "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
288353
+ "organizations_url": "https://api.github.com/users/octocat/orgs",
288354
+ "repos_url": "https://api.github.com/users/octocat/repos",
288355
+ "events_url": "https://api.github.com/users/octocat/events{/privacy}",
288356
+ "received_events_url": "https://api.github.com/users/octocat/received_events",
288357
+ "type": "User",
288358
+ "site_admin": false
288359
+ },
288360
+ "type": "finder",
288361
+ "state": "accepted"
288362
+ }
288363
+ ]
288364
+ }
288365
+ },
287377
288366
  "simple-user-items-default-response": {
287378
288367
  "summary": "Default response",
287379
288368
  "value": [
@@ -295325,6 +296314,15 @@
295325
296314
  "type": "integer"
295326
296315
  }
295327
296316
  },
296317
+ "protection-rule-id": {
296318
+ "name": "protection_rule_id",
296319
+ "description": "The unique identifier of the protection rule.",
296320
+ "in": "path",
296321
+ "required": true,
296322
+ "schema": {
296323
+ "type": "integer"
296324
+ }
296325
+ },
295328
296326
  "since-user": {
295329
296327
  "name": "since",
295330
296328
  "description": "A user ID. Only return users with an ID greater than this ID.",