@octokit/openapi 7.0.0 → 7.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/api.github.com.deref.json +1523 -250
- package/generated/api.github.com.json +803 -61
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +17 -8
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +9 -8
- package/generated/ghes-3.2.deref.json +1108 -313
- package/generated/ghes-3.2.json +451 -31
- package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +16 -0
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +209 -1
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +9 -1
- package/generated/ghes-3.3.deref.json +1108 -313
- package/generated/ghes-3.3.json +451 -31
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -8
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -8
- package/generated/ghes-3.4.deref.json +1092 -313
- package/generated/ghes-3.4.json +451 -31
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +17 -8
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +9 -8
- package/generated/ghes-3.5.deref.json +1094 -315
- package/generated/ghes-3.5.json +453 -33
- package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +94 -56
- package/generated/ghes-3.6-diff-to-api.github.com.deref.json +89 -164
- package/generated/ghes-3.6-diff-to-api.github.com.json +9 -130
- package/generated/ghes-3.6.deref.json +1299 -488
- package/generated/ghes-3.6.json +499 -47
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +38 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +49 -8
- package/generated/github.ae-diff-to-api.github.com.json +9 -8
- package/generated/github.ae.deref.json +783 -32
- package/generated/github.ae.json +495 -31
- package/index.js +2 -0
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.3.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": {
|
|
@@ -3576,6 +3576,105 @@
|
|
|
3576
3576
|
"x-octokit": {}
|
|
3577
3577
|
}
|
|
3578
3578
|
},
|
|
3579
|
+
"/enterprises/{enterprise}/consumed-licenses": {
|
|
3580
|
+
"get": {
|
|
3581
|
+
"summary": "List enterprise consumed licenses",
|
|
3582
|
+
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
|
|
3583
|
+
"tags": [
|
|
3584
|
+
"enterprise-admin"
|
|
3585
|
+
],
|
|
3586
|
+
"operationId": "enterprise-admin/get-consumed-licenses",
|
|
3587
|
+
"externalDocs": {
|
|
3588
|
+
"description": "API method documentation",
|
|
3589
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
|
|
3590
|
+
},
|
|
3591
|
+
"parameters": [
|
|
3592
|
+
{
|
|
3593
|
+
"$ref": "#/components/parameters/enterprise"
|
|
3594
|
+
},
|
|
3595
|
+
{
|
|
3596
|
+
"$ref": "#/components/parameters/per-page"
|
|
3597
|
+
},
|
|
3598
|
+
{
|
|
3599
|
+
"$ref": "#/components/parameters/page"
|
|
3600
|
+
}
|
|
3601
|
+
],
|
|
3602
|
+
"responses": {
|
|
3603
|
+
"200": {
|
|
3604
|
+
"description": "Consumed Licenses Response",
|
|
3605
|
+
"content": {
|
|
3606
|
+
"application/json": {
|
|
3607
|
+
"schema": {
|
|
3608
|
+
"$ref": "#/components/schemas/get-consumed-licenses"
|
|
3609
|
+
},
|
|
3610
|
+
"examples": {
|
|
3611
|
+
"default": {
|
|
3612
|
+
"$ref": "#/components/examples/get-consumed-licenses"
|
|
3613
|
+
}
|
|
3614
|
+
}
|
|
3615
|
+
}
|
|
3616
|
+
},
|
|
3617
|
+
"headers": {
|
|
3618
|
+
"Link": {
|
|
3619
|
+
"$ref": "#/components/headers/link"
|
|
3620
|
+
}
|
|
3621
|
+
}
|
|
3622
|
+
}
|
|
3623
|
+
},
|
|
3624
|
+
"x-github": {
|
|
3625
|
+
"githubCloudOnly": true,
|
|
3626
|
+
"enabledForGitHubApps": false,
|
|
3627
|
+
"previews": [],
|
|
3628
|
+
"category": "enterprise-admin",
|
|
3629
|
+
"subcategory": "license"
|
|
3630
|
+
},
|
|
3631
|
+
"x-octokit": {}
|
|
3632
|
+
}
|
|
3633
|
+
},
|
|
3634
|
+
"/enterprises/{enterprise}/license-sync-status": {
|
|
3635
|
+
"get": {
|
|
3636
|
+
"summary": "Get a license sync status",
|
|
3637
|
+
"description": "Gets information about the status of a license sync job for an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
|
|
3638
|
+
"tags": [
|
|
3639
|
+
"enterprise-admin"
|
|
3640
|
+
],
|
|
3641
|
+
"operationId": "enterprise-admin/get-license-sync-status",
|
|
3642
|
+
"externalDocs": {
|
|
3643
|
+
"description": "API method documentation",
|
|
3644
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
|
|
3645
|
+
},
|
|
3646
|
+
"parameters": [
|
|
3647
|
+
{
|
|
3648
|
+
"$ref": "#/components/parameters/enterprise"
|
|
3649
|
+
}
|
|
3650
|
+
],
|
|
3651
|
+
"responses": {
|
|
3652
|
+
"200": {
|
|
3653
|
+
"description": "License Sync Status Response",
|
|
3654
|
+
"content": {
|
|
3655
|
+
"application/json": {
|
|
3656
|
+
"schema": {
|
|
3657
|
+
"$ref": "#/components/schemas/get-license-sync-status"
|
|
3658
|
+
},
|
|
3659
|
+
"examples": {
|
|
3660
|
+
"default": {
|
|
3661
|
+
"$ref": "#/components/examples/get-license-sync-status"
|
|
3662
|
+
}
|
|
3663
|
+
}
|
|
3664
|
+
}
|
|
3665
|
+
}
|
|
3666
|
+
}
|
|
3667
|
+
},
|
|
3668
|
+
"x-github": {
|
|
3669
|
+
"githubCloudOnly": true,
|
|
3670
|
+
"enabledForGitHubApps": false,
|
|
3671
|
+
"previews": [],
|
|
3672
|
+
"category": "enterprise-admin",
|
|
3673
|
+
"subcategory": "license"
|
|
3674
|
+
},
|
|
3675
|
+
"x-octokit": {}
|
|
3676
|
+
}
|
|
3677
|
+
},
|
|
3579
3678
|
"/enterprises/{enterprise}/secret-scanning/alerts": {
|
|
3580
3679
|
"get": {
|
|
3581
3680
|
"summary": "List secret scanning alerts for an enterprise",
|
|
@@ -17139,14 +17238,7 @@
|
|
|
17139
17238
|
"properties": {
|
|
17140
17239
|
"permission": {
|
|
17141
17240
|
"type": "string",
|
|
17142
|
-
"description": "The permission to grant the team on this repository.
|
|
17143
|
-
"enum": [
|
|
17144
|
-
"pull",
|
|
17145
|
-
"push",
|
|
17146
|
-
"admin",
|
|
17147
|
-
"maintain",
|
|
17148
|
-
"triage"
|
|
17149
|
-
],
|
|
17241
|
+
"description": "The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
|
|
17150
17242
|
"default": "push"
|
|
17151
17243
|
}
|
|
17152
17244
|
}
|
|
@@ -20155,7 +20247,7 @@
|
|
|
20155
20247
|
"/repos/{owner}/{repo}/actions/permissions/access": {
|
|
20156
20248
|
"get": {
|
|
20157
20249
|
"summary": "Get the level of access for workflows outside of the repository",
|
|
20158
|
-
"description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal
|
|
20250
|
+
"description": "Gets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
|
|
20159
20251
|
"tags": [
|
|
20160
20252
|
"actions"
|
|
20161
20253
|
],
|
|
@@ -20200,7 +20292,7 @@
|
|
|
20200
20292
|
},
|
|
20201
20293
|
"put": {
|
|
20202
20294
|
"summary": "Set the level of access for workflows outside of the repository",
|
|
20203
|
-
"description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal
|
|
20295
|
+
"description": "Sets the level of access that workflows outside of the repository have to actions and reusable workflows in the repository.\nThis endpoint only applies to internal repositories. For more information, see \"[Managing GitHub Actions settings for a repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the\nrepository `administration` permission to use this endpoint.",
|
|
20204
20296
|
"tags": [
|
|
20205
20297
|
"actions"
|
|
20206
20298
|
],
|
|
@@ -28025,8 +28117,8 @@
|
|
|
28025
28117
|
"examples": {
|
|
28026
28118
|
"default": {
|
|
28027
28119
|
"value": {
|
|
28028
|
-
"
|
|
28029
|
-
"
|
|
28120
|
+
"ref": "main",
|
|
28121
|
+
"machine": "standardLinux32gb"
|
|
28030
28122
|
}
|
|
28031
28123
|
}
|
|
28032
28124
|
}
|
|
@@ -28064,6 +28156,9 @@
|
|
|
28064
28156
|
}
|
|
28065
28157
|
}
|
|
28066
28158
|
},
|
|
28159
|
+
"400": {
|
|
28160
|
+
"$ref": "#/components/responses/bad_request"
|
|
28161
|
+
},
|
|
28067
28162
|
"401": {
|
|
28068
28163
|
"$ref": "#/components/responses/requires_authentication"
|
|
28069
28164
|
},
|
|
@@ -28787,14 +28882,7 @@
|
|
|
28787
28882
|
"properties": {
|
|
28788
28883
|
"permission": {
|
|
28789
28884
|
"type": "string",
|
|
28790
|
-
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**
|
|
28791
|
-
"enum": [
|
|
28792
|
-
"pull",
|
|
28793
|
-
"push",
|
|
28794
|
-
"admin",
|
|
28795
|
-
"maintain",
|
|
28796
|
-
"triage"
|
|
28797
|
-
],
|
|
28885
|
+
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any.",
|
|
28798
28886
|
"default": "push"
|
|
28799
28887
|
}
|
|
28800
28888
|
}
|
|
@@ -31916,15 +32004,15 @@
|
|
|
31916
32004
|
},
|
|
31917
32005
|
"/repos/{owner}/{repo}/environments": {
|
|
31918
32006
|
"get": {
|
|
31919
|
-
"summary": "
|
|
31920
|
-
"description": "
|
|
32007
|
+
"summary": "List environments",
|
|
32008
|
+
"description": "Lists the environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
|
|
31921
32009
|
"tags": [
|
|
31922
32010
|
"repos"
|
|
31923
32011
|
],
|
|
31924
32012
|
"operationId": "repos/get-all-environments",
|
|
31925
32013
|
"externalDocs": {
|
|
31926
32014
|
"description": "API method documentation",
|
|
31927
|
-
"url": "https://docs.github.com/rest/
|
|
32015
|
+
"url": "https://docs.github.com/rest/deployments/environments#list-environments"
|
|
31928
32016
|
},
|
|
31929
32017
|
"parameters": [
|
|
31930
32018
|
{
|
|
@@ -31973,7 +32061,7 @@
|
|
|
31973
32061
|
"x-github": {
|
|
31974
32062
|
"githubCloudOnly": false,
|
|
31975
32063
|
"enabledForGitHubApps": true,
|
|
31976
|
-
"category": "
|
|
32064
|
+
"category": "deployments",
|
|
31977
32065
|
"subcategory": "environments"
|
|
31978
32066
|
},
|
|
31979
32067
|
"x-octokit": {}
|
|
@@ -31982,7 +32070,7 @@
|
|
|
31982
32070
|
"/repos/{owner}/{repo}/environments/{environment_name}": {
|
|
31983
32071
|
"get": {
|
|
31984
32072
|
"summary": "Get an environment",
|
|
31985
|
-
"description": "
|
|
32073
|
+
"description": "**Note:** To get information about name patterns that branches must match in order to deploy to this environment, see \"[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy).\"\n\nAnyone with read access to the repository can use this endpoint. If the\nrepository is private, you must use an access token with the `repo` scope. GitHub\nApps must have the `actions:read` permission to use this endpoint.",
|
|
31986
32074
|
"tags": [
|
|
31987
32075
|
"repos"
|
|
31988
32076
|
],
|
|
@@ -32029,7 +32117,7 @@
|
|
|
32029
32117
|
},
|
|
32030
32118
|
"put": {
|
|
32031
32119
|
"summary": "Create or update an environment",
|
|
32032
|
-
"description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:**
|
|
32120
|
+
"description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see \"[Deployment branch policies](/rest/deployments/branch-policies).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
32033
32121
|
"tags": [
|
|
32034
32122
|
"repos"
|
|
32035
32123
|
],
|
|
@@ -32079,10 +32167,31 @@
|
|
|
32079
32167
|
}
|
|
32080
32168
|
},
|
|
32081
32169
|
"deployment_branch_policy": {
|
|
32082
|
-
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
32170
|
+
"$ref": "#/components/schemas/deployment-branch-policy-settings"
|
|
32083
32171
|
}
|
|
32084
32172
|
},
|
|
32085
32173
|
"additionalProperties": false
|
|
32174
|
+
},
|
|
32175
|
+
"examples": {
|
|
32176
|
+
"default": {
|
|
32177
|
+
"value": {
|
|
32178
|
+
"wait_timer": 30,
|
|
32179
|
+
"reviewers": [
|
|
32180
|
+
{
|
|
32181
|
+
"type": "User",
|
|
32182
|
+
"id": 1
|
|
32183
|
+
},
|
|
32184
|
+
{
|
|
32185
|
+
"type": "Team",
|
|
32186
|
+
"id": 1
|
|
32187
|
+
}
|
|
32188
|
+
],
|
|
32189
|
+
"deployment_branch_policy": {
|
|
32190
|
+
"protected_branches": false,
|
|
32191
|
+
"custom_branch_policies": true
|
|
32192
|
+
}
|
|
32193
|
+
}
|
|
32194
|
+
}
|
|
32086
32195
|
}
|
|
32087
32196
|
}
|
|
32088
32197
|
}
|
|
@@ -32158,6 +32267,315 @@
|
|
|
32158
32267
|
"x-octokit": {}
|
|
32159
32268
|
}
|
|
32160
32269
|
},
|
|
32270
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
|
|
32271
|
+
"get": {
|
|
32272
|
+
"summary": "List deployment branch policies",
|
|
32273
|
+
"description": "Lists the deployment branch policies for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
|
|
32274
|
+
"tags": [
|
|
32275
|
+
"repos"
|
|
32276
|
+
],
|
|
32277
|
+
"operationId": "repos/list-deployment-branch-policies",
|
|
32278
|
+
"externalDocs": {
|
|
32279
|
+
"description": "API method documentation",
|
|
32280
|
+
"url": "https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies"
|
|
32281
|
+
},
|
|
32282
|
+
"parameters": [
|
|
32283
|
+
{
|
|
32284
|
+
"$ref": "#/components/parameters/owner"
|
|
32285
|
+
},
|
|
32286
|
+
{
|
|
32287
|
+
"$ref": "#/components/parameters/repo"
|
|
32288
|
+
},
|
|
32289
|
+
{
|
|
32290
|
+
"$ref": "#/components/parameters/environment-name"
|
|
32291
|
+
},
|
|
32292
|
+
{
|
|
32293
|
+
"$ref": "#/components/parameters/per-page"
|
|
32294
|
+
},
|
|
32295
|
+
{
|
|
32296
|
+
"$ref": "#/components/parameters/page"
|
|
32297
|
+
}
|
|
32298
|
+
],
|
|
32299
|
+
"responses": {
|
|
32300
|
+
"200": {
|
|
32301
|
+
"description": "Response",
|
|
32302
|
+
"content": {
|
|
32303
|
+
"application/json": {
|
|
32304
|
+
"schema": {
|
|
32305
|
+
"type": "object",
|
|
32306
|
+
"properties": {
|
|
32307
|
+
"total_count": {
|
|
32308
|
+
"description": "The number of deployment branch policies for the environment.",
|
|
32309
|
+
"type": "integer",
|
|
32310
|
+
"example": 2
|
|
32311
|
+
},
|
|
32312
|
+
"branch_policies": {
|
|
32313
|
+
"type": "array",
|
|
32314
|
+
"items": {
|
|
32315
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
32316
|
+
}
|
|
32317
|
+
}
|
|
32318
|
+
},
|
|
32319
|
+
"required": [
|
|
32320
|
+
"total_count",
|
|
32321
|
+
"branch_policies"
|
|
32322
|
+
]
|
|
32323
|
+
},
|
|
32324
|
+
"examples": {
|
|
32325
|
+
"default": {
|
|
32326
|
+
"$ref": "#/components/examples/deployment-branch-policies-list"
|
|
32327
|
+
}
|
|
32328
|
+
}
|
|
32329
|
+
}
|
|
32330
|
+
}
|
|
32331
|
+
}
|
|
32332
|
+
},
|
|
32333
|
+
"x-github": {
|
|
32334
|
+
"githubCloudOnly": false,
|
|
32335
|
+
"enabledForGitHubApps": true,
|
|
32336
|
+
"category": "deployments",
|
|
32337
|
+
"subcategory": "branch-policies"
|
|
32338
|
+
},
|
|
32339
|
+
"x-octokit": {}
|
|
32340
|
+
},
|
|
32341
|
+
"post": {
|
|
32342
|
+
"summary": "Create a deployment branch policy",
|
|
32343
|
+
"description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
32344
|
+
"tags": [
|
|
32345
|
+
"repos"
|
|
32346
|
+
],
|
|
32347
|
+
"operationId": "repos/create-deployment-branch-policy",
|
|
32348
|
+
"externalDocs": {
|
|
32349
|
+
"description": "API method documentation",
|
|
32350
|
+
"url": "https://docs.github.com/rest/deployments/branch-policies#create-deployment-branch-policy"
|
|
32351
|
+
},
|
|
32352
|
+
"parameters": [
|
|
32353
|
+
{
|
|
32354
|
+
"$ref": "#/components/parameters/owner"
|
|
32355
|
+
},
|
|
32356
|
+
{
|
|
32357
|
+
"$ref": "#/components/parameters/repo"
|
|
32358
|
+
},
|
|
32359
|
+
{
|
|
32360
|
+
"$ref": "#/components/parameters/environment-name"
|
|
32361
|
+
}
|
|
32362
|
+
],
|
|
32363
|
+
"requestBody": {
|
|
32364
|
+
"required": true,
|
|
32365
|
+
"content": {
|
|
32366
|
+
"application/json": {
|
|
32367
|
+
"schema": {
|
|
32368
|
+
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
|
|
32369
|
+
},
|
|
32370
|
+
"examples": {
|
|
32371
|
+
"example-wildcard": {
|
|
32372
|
+
"summary": "Example of a wildcard name pattern",
|
|
32373
|
+
"value": {
|
|
32374
|
+
"name": "release/*"
|
|
32375
|
+
}
|
|
32376
|
+
},
|
|
32377
|
+
"example-single-branch": {
|
|
32378
|
+
"summary": "Example of a single branch name pattern",
|
|
32379
|
+
"value": {
|
|
32380
|
+
"name": "main"
|
|
32381
|
+
}
|
|
32382
|
+
}
|
|
32383
|
+
}
|
|
32384
|
+
}
|
|
32385
|
+
}
|
|
32386
|
+
},
|
|
32387
|
+
"responses": {
|
|
32388
|
+
"200": {
|
|
32389
|
+
"description": "Response",
|
|
32390
|
+
"content": {
|
|
32391
|
+
"application/json": {
|
|
32392
|
+
"schema": {
|
|
32393
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
32394
|
+
},
|
|
32395
|
+
"examples": {
|
|
32396
|
+
"example-wildcard": {
|
|
32397
|
+
"$ref": "#/components/examples/deployment-branch-policy-wildcard"
|
|
32398
|
+
},
|
|
32399
|
+
"example-single-branch": {
|
|
32400
|
+
"$ref": "#/components/examples/deployment-branch-policy-single-branch"
|
|
32401
|
+
}
|
|
32402
|
+
}
|
|
32403
|
+
}
|
|
32404
|
+
}
|
|
32405
|
+
},
|
|
32406
|
+
"303": {
|
|
32407
|
+
"description": "Response if the same branch name pattern already exists"
|
|
32408
|
+
},
|
|
32409
|
+
"404": {
|
|
32410
|
+
"description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
|
|
32411
|
+
}
|
|
32412
|
+
},
|
|
32413
|
+
"x-github": {
|
|
32414
|
+
"githubCloudOnly": false,
|
|
32415
|
+
"enabledForGitHubApps": true,
|
|
32416
|
+
"category": "deployments",
|
|
32417
|
+
"subcategory": "branch-policies"
|
|
32418
|
+
},
|
|
32419
|
+
"x-octokit": {}
|
|
32420
|
+
}
|
|
32421
|
+
},
|
|
32422
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
32423
|
+
"get": {
|
|
32424
|
+
"summary": "Get a deployment branch policy",
|
|
32425
|
+
"description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.",
|
|
32426
|
+
"tags": [
|
|
32427
|
+
"repos"
|
|
32428
|
+
],
|
|
32429
|
+
"operationId": "repos/get-deployment-branch-policy",
|
|
32430
|
+
"externalDocs": {
|
|
32431
|
+
"description": "API method documentation",
|
|
32432
|
+
"url": "https://docs.github.com/rest/deployments/branch-policies#get-deployment-branch-policy"
|
|
32433
|
+
},
|
|
32434
|
+
"parameters": [
|
|
32435
|
+
{
|
|
32436
|
+
"$ref": "#/components/parameters/owner"
|
|
32437
|
+
},
|
|
32438
|
+
{
|
|
32439
|
+
"$ref": "#/components/parameters/repo"
|
|
32440
|
+
},
|
|
32441
|
+
{
|
|
32442
|
+
"$ref": "#/components/parameters/environment-name"
|
|
32443
|
+
},
|
|
32444
|
+
{
|
|
32445
|
+
"$ref": "#/components/parameters/branch-policy-id"
|
|
32446
|
+
}
|
|
32447
|
+
],
|
|
32448
|
+
"responses": {
|
|
32449
|
+
"200": {
|
|
32450
|
+
"description": "Response",
|
|
32451
|
+
"content": {
|
|
32452
|
+
"application/json": {
|
|
32453
|
+
"schema": {
|
|
32454
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
32455
|
+
},
|
|
32456
|
+
"examples": {
|
|
32457
|
+
"default": {
|
|
32458
|
+
"$ref": "#/components/examples/deployment-branch-policy-wildcard"
|
|
32459
|
+
}
|
|
32460
|
+
}
|
|
32461
|
+
}
|
|
32462
|
+
}
|
|
32463
|
+
}
|
|
32464
|
+
},
|
|
32465
|
+
"x-github": {
|
|
32466
|
+
"githubCloudOnly": false,
|
|
32467
|
+
"enabledForGitHubApps": true,
|
|
32468
|
+
"category": "deployments",
|
|
32469
|
+
"subcategory": "branch-policies"
|
|
32470
|
+
},
|
|
32471
|
+
"x-octokit": {}
|
|
32472
|
+
},
|
|
32473
|
+
"put": {
|
|
32474
|
+
"summary": "Update a deployment branch policy",
|
|
32475
|
+
"description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
32476
|
+
"tags": [
|
|
32477
|
+
"repos"
|
|
32478
|
+
],
|
|
32479
|
+
"operationId": "repos/update-deployment-branch-policy",
|
|
32480
|
+
"externalDocs": {
|
|
32481
|
+
"description": "API method documentation",
|
|
32482
|
+
"url": "https://docs.github.com/rest/deployments/branch-policies#update-deployment-branch-policy"
|
|
32483
|
+
},
|
|
32484
|
+
"parameters": [
|
|
32485
|
+
{
|
|
32486
|
+
"$ref": "#/components/parameters/owner"
|
|
32487
|
+
},
|
|
32488
|
+
{
|
|
32489
|
+
"$ref": "#/components/parameters/repo"
|
|
32490
|
+
},
|
|
32491
|
+
{
|
|
32492
|
+
"$ref": "#/components/parameters/environment-name"
|
|
32493
|
+
},
|
|
32494
|
+
{
|
|
32495
|
+
"$ref": "#/components/parameters/branch-policy-id"
|
|
32496
|
+
}
|
|
32497
|
+
],
|
|
32498
|
+
"requestBody": {
|
|
32499
|
+
"required": true,
|
|
32500
|
+
"content": {
|
|
32501
|
+
"application/json": {
|
|
32502
|
+
"schema": {
|
|
32503
|
+
"$ref": "#/components/schemas/deployment-branch-policy-name-pattern"
|
|
32504
|
+
},
|
|
32505
|
+
"examples": {
|
|
32506
|
+
"default": {
|
|
32507
|
+
"value": {
|
|
32508
|
+
"name": "release/*"
|
|
32509
|
+
}
|
|
32510
|
+
}
|
|
32511
|
+
}
|
|
32512
|
+
}
|
|
32513
|
+
}
|
|
32514
|
+
},
|
|
32515
|
+
"responses": {
|
|
32516
|
+
"200": {
|
|
32517
|
+
"description": "Response",
|
|
32518
|
+
"content": {
|
|
32519
|
+
"application/json": {
|
|
32520
|
+
"schema": {
|
|
32521
|
+
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
32522
|
+
},
|
|
32523
|
+
"examples": {
|
|
32524
|
+
"default": {
|
|
32525
|
+
"$ref": "#/components/examples/deployment-branch-policy-wildcard"
|
|
32526
|
+
}
|
|
32527
|
+
}
|
|
32528
|
+
}
|
|
32529
|
+
}
|
|
32530
|
+
}
|
|
32531
|
+
},
|
|
32532
|
+
"x-github": {
|
|
32533
|
+
"githubCloudOnly": false,
|
|
32534
|
+
"enabledForGitHubApps": true,
|
|
32535
|
+
"category": "deployments",
|
|
32536
|
+
"subcategory": "branch-policies"
|
|
32537
|
+
},
|
|
32538
|
+
"x-octokit": {}
|
|
32539
|
+
},
|
|
32540
|
+
"delete": {
|
|
32541
|
+
"summary": "Delete a deployment branch policy",
|
|
32542
|
+
"description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.",
|
|
32543
|
+
"tags": [
|
|
32544
|
+
"repos"
|
|
32545
|
+
],
|
|
32546
|
+
"operationId": "repos/delete-deployment-branch-policy",
|
|
32547
|
+
"externalDocs": {
|
|
32548
|
+
"description": "API method documentation",
|
|
32549
|
+
"url": "https://docs.github.com/rest/deployments/branch-policies#delete-deployment-branch-policy"
|
|
32550
|
+
},
|
|
32551
|
+
"parameters": [
|
|
32552
|
+
{
|
|
32553
|
+
"$ref": "#/components/parameters/owner"
|
|
32554
|
+
},
|
|
32555
|
+
{
|
|
32556
|
+
"$ref": "#/components/parameters/repo"
|
|
32557
|
+
},
|
|
32558
|
+
{
|
|
32559
|
+
"$ref": "#/components/parameters/environment-name"
|
|
32560
|
+
},
|
|
32561
|
+
{
|
|
32562
|
+
"$ref": "#/components/parameters/branch-policy-id"
|
|
32563
|
+
}
|
|
32564
|
+
],
|
|
32565
|
+
"responses": {
|
|
32566
|
+
"204": {
|
|
32567
|
+
"description": "Response"
|
|
32568
|
+
}
|
|
32569
|
+
},
|
|
32570
|
+
"x-github": {
|
|
32571
|
+
"githubCloudOnly": false,
|
|
32572
|
+
"enabledForGitHubApps": true,
|
|
32573
|
+
"category": "deployments",
|
|
32574
|
+
"subcategory": "branch-policies"
|
|
32575
|
+
},
|
|
32576
|
+
"x-octokit": {}
|
|
32577
|
+
}
|
|
32578
|
+
},
|
|
32161
32579
|
"/repos/{owner}/{repo}/events": {
|
|
32162
32580
|
"get": {
|
|
32163
32581
|
"summary": "List repository events",
|
|
@@ -58275,6 +58693,12 @@
|
|
|
58275
58693
|
"text/plain": {
|
|
58276
58694
|
"schema": {
|
|
58277
58695
|
"type": "string"
|
|
58696
|
+
},
|
|
58697
|
+
"examples": {
|
|
58698
|
+
"default": {
|
|
58699
|
+
"summary": "Example response",
|
|
58700
|
+
"value": "Responsive is better than fast"
|
|
58701
|
+
}
|
|
58278
58702
|
}
|
|
58279
58703
|
}
|
|
58280
58704
|
}
|
|
@@ -59399,6 +59823,14 @@
|
|
|
59399
59823
|
"write"
|
|
59400
59824
|
]
|
|
59401
59825
|
},
|
|
59826
|
+
"organization_custom_roles": {
|
|
59827
|
+
"type": "string",
|
|
59828
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
59829
|
+
"enum": [
|
|
59830
|
+
"read",
|
|
59831
|
+
"write"
|
|
59832
|
+
]
|
|
59833
|
+
},
|
|
59402
59834
|
"deployments": {
|
|
59403
59835
|
"type": "string",
|
|
59404
59836
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -62252,6 +62684,129 @@
|
|
|
62252
62684
|
"repository"
|
|
62253
62685
|
]
|
|
62254
62686
|
},
|
|
62687
|
+
"get-consumed-licenses": {
|
|
62688
|
+
"title": "Enterprise Consumed Licenses",
|
|
62689
|
+
"description": "A breakdown of the licenses consumed by an enterprise.",
|
|
62690
|
+
"properties": {
|
|
62691
|
+
"total_seats_consumed": {
|
|
62692
|
+
"type": "integer"
|
|
62693
|
+
},
|
|
62694
|
+
"total_seats_purchased": {
|
|
62695
|
+
"type": "integer"
|
|
62696
|
+
},
|
|
62697
|
+
"users": {
|
|
62698
|
+
"type": "array",
|
|
62699
|
+
"items": {
|
|
62700
|
+
"type": "object",
|
|
62701
|
+
"properties": {
|
|
62702
|
+
"github_com_login": {
|
|
62703
|
+
"type": "string"
|
|
62704
|
+
},
|
|
62705
|
+
"github_com_name": {
|
|
62706
|
+
"type": "string",
|
|
62707
|
+
"nullable": true
|
|
62708
|
+
},
|
|
62709
|
+
"github_com_profile": {
|
|
62710
|
+
"type": "string",
|
|
62711
|
+
"nullable": true
|
|
62712
|
+
},
|
|
62713
|
+
"license_type": {
|
|
62714
|
+
"type": "string"
|
|
62715
|
+
},
|
|
62716
|
+
"github_com_member_roles": {
|
|
62717
|
+
"type": "array",
|
|
62718
|
+
"items": {
|
|
62719
|
+
"type": "string"
|
|
62720
|
+
}
|
|
62721
|
+
},
|
|
62722
|
+
"github_com_enterprise_role": {
|
|
62723
|
+
"type": "string",
|
|
62724
|
+
"nullable": true
|
|
62725
|
+
},
|
|
62726
|
+
"visual_studio_subscription_user": {
|
|
62727
|
+
"type": "boolean"
|
|
62728
|
+
},
|
|
62729
|
+
"github_com_verified_domain_emails": {
|
|
62730
|
+
"type": "array",
|
|
62731
|
+
"items": {
|
|
62732
|
+
"type": "string"
|
|
62733
|
+
}
|
|
62734
|
+
},
|
|
62735
|
+
"github_com_saml_name_id": {
|
|
62736
|
+
"type": "string",
|
|
62737
|
+
"nullable": true
|
|
62738
|
+
},
|
|
62739
|
+
"enterprise_server_user": {
|
|
62740
|
+
"type": "boolean",
|
|
62741
|
+
"nullable": true
|
|
62742
|
+
},
|
|
62743
|
+
"enterprise_server_emails": {
|
|
62744
|
+
"type": "array",
|
|
62745
|
+
"items": {
|
|
62746
|
+
"type": "string"
|
|
62747
|
+
}
|
|
62748
|
+
},
|
|
62749
|
+
"github_com_user": {
|
|
62750
|
+
"type": "boolean"
|
|
62751
|
+
},
|
|
62752
|
+
"total_user_accounts": {
|
|
62753
|
+
"type": "integer"
|
|
62754
|
+
},
|
|
62755
|
+
"enterprise_server_user_ids": {
|
|
62756
|
+
"type": "array",
|
|
62757
|
+
"items": {
|
|
62758
|
+
"type": "string"
|
|
62759
|
+
}
|
|
62760
|
+
},
|
|
62761
|
+
"github_com_orgs_with_pending_invites": {
|
|
62762
|
+
"type": "array",
|
|
62763
|
+
"items": {
|
|
62764
|
+
"type": "string"
|
|
62765
|
+
}
|
|
62766
|
+
},
|
|
62767
|
+
"visual_studio_subscription_email": {
|
|
62768
|
+
"type": "string",
|
|
62769
|
+
"nullable": true
|
|
62770
|
+
}
|
|
62771
|
+
}
|
|
62772
|
+
}
|
|
62773
|
+
}
|
|
62774
|
+
}
|
|
62775
|
+
},
|
|
62776
|
+
"get-license-sync-status": {
|
|
62777
|
+
"title": "License Sync Status",
|
|
62778
|
+
"description": "Information about the status of a license sync job for an enterprise.",
|
|
62779
|
+
"properties": {
|
|
62780
|
+
"server_instances": {
|
|
62781
|
+
"type": "array",
|
|
62782
|
+
"items": {
|
|
62783
|
+
"type": "object",
|
|
62784
|
+
"properties": {
|
|
62785
|
+
"server_id": {
|
|
62786
|
+
"type": "string"
|
|
62787
|
+
},
|
|
62788
|
+
"hostname": {
|
|
62789
|
+
"type": "string"
|
|
62790
|
+
},
|
|
62791
|
+
"last_sync": {
|
|
62792
|
+
"type": "object",
|
|
62793
|
+
"properties": {
|
|
62794
|
+
"date": {
|
|
62795
|
+
"type": "string"
|
|
62796
|
+
},
|
|
62797
|
+
"status": {
|
|
62798
|
+
"type": "string"
|
|
62799
|
+
},
|
|
62800
|
+
"error": {
|
|
62801
|
+
"type": "string"
|
|
62802
|
+
}
|
|
62803
|
+
}
|
|
62804
|
+
}
|
|
62805
|
+
}
|
|
62806
|
+
}
|
|
62807
|
+
}
|
|
62808
|
+
}
|
|
62809
|
+
},
|
|
62255
62810
|
"nullable-alert-updated-at": {
|
|
62256
62811
|
"type": "string",
|
|
62257
62812
|
"description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
@@ -66668,6 +67223,19 @@
|
|
|
66668
67223
|
"description": "Text to show user when codespace idle timeout minutes has been overriden by an organization policy",
|
|
66669
67224
|
"type": "string",
|
|
66670
67225
|
"nullable": true
|
|
67226
|
+
},
|
|
67227
|
+
"retention_period_minutes": {
|
|
67228
|
+
"description": "Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).",
|
|
67229
|
+
"type": "integer",
|
|
67230
|
+
"example": 60,
|
|
67231
|
+
"nullable": true
|
|
67232
|
+
},
|
|
67233
|
+
"retention_expires_at": {
|
|
67234
|
+
"description": "When a codespace will be auto-deleted based on the \"retention_period_minutes\" and \"last_used_at\"",
|
|
67235
|
+
"type": "string",
|
|
67236
|
+
"format": "date-time",
|
|
67237
|
+
"example": "2011-01-26T20:01:12Z",
|
|
67238
|
+
"nullable": true
|
|
66671
67239
|
}
|
|
66672
67240
|
},
|
|
66673
67241
|
"required": [
|
|
@@ -70530,7 +71098,6 @@
|
|
|
70530
71098
|
"description": "Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the\nrepository. `none` means access is only possible from workflows in this repository.",
|
|
70531
71099
|
"enum": [
|
|
70532
71100
|
"none",
|
|
70533
|
-
"user",
|
|
70534
71101
|
"organization",
|
|
70535
71102
|
"enterprise"
|
|
70536
71103
|
]
|
|
@@ -75064,7 +75631,13 @@
|
|
|
75064
75631
|
"type": "object",
|
|
75065
75632
|
"properties": {
|
|
75066
75633
|
"type": {
|
|
75067
|
-
"type": "string"
|
|
75634
|
+
"type": "string",
|
|
75635
|
+
"enum": [
|
|
75636
|
+
"dir",
|
|
75637
|
+
"file",
|
|
75638
|
+
"submodule",
|
|
75639
|
+
"symlink"
|
|
75640
|
+
]
|
|
75068
75641
|
},
|
|
75069
75642
|
"size": {
|
|
75070
75643
|
"type": "integer"
|
|
@@ -75145,7 +75718,10 @@
|
|
|
75145
75718
|
"type": "object",
|
|
75146
75719
|
"properties": {
|
|
75147
75720
|
"type": {
|
|
75148
|
-
"type": "string"
|
|
75721
|
+
"type": "string",
|
|
75722
|
+
"enum": [
|
|
75723
|
+
"file"
|
|
75724
|
+
]
|
|
75149
75725
|
},
|
|
75150
75726
|
"encoding": {
|
|
75151
75727
|
"type": "string"
|
|
@@ -75238,7 +75814,10 @@
|
|
|
75238
75814
|
"type": "object",
|
|
75239
75815
|
"properties": {
|
|
75240
75816
|
"type": {
|
|
75241
|
-
"type": "string"
|
|
75817
|
+
"type": "string",
|
|
75818
|
+
"enum": [
|
|
75819
|
+
"symlink"
|
|
75820
|
+
]
|
|
75242
75821
|
},
|
|
75243
75822
|
"target": {
|
|
75244
75823
|
"type": "string"
|
|
@@ -75314,12 +75893,15 @@
|
|
|
75314
75893
|
]
|
|
75315
75894
|
},
|
|
75316
75895
|
"content-submodule": {
|
|
75317
|
-
"title": "
|
|
75318
|
-
"description": "An object describing a
|
|
75896
|
+
"title": "Submodule Content",
|
|
75897
|
+
"description": "An object describing a submodule",
|
|
75319
75898
|
"type": "object",
|
|
75320
75899
|
"properties": {
|
|
75321
75900
|
"type": {
|
|
75322
|
-
"type": "string"
|
|
75901
|
+
"type": "string",
|
|
75902
|
+
"enum": [
|
|
75903
|
+
"submodule"
|
|
75904
|
+
]
|
|
75323
75905
|
},
|
|
75324
75906
|
"submodule_git_url": {
|
|
75325
75907
|
"type": "string",
|
|
@@ -75766,8 +76348,6 @@
|
|
|
75766
76348
|
}
|
|
75767
76349
|
},
|
|
75768
76350
|
"dependency": {
|
|
75769
|
-
"title": "Dependency",
|
|
75770
|
-
"description": "A single package dependency.",
|
|
75771
76351
|
"type": "object",
|
|
75772
76352
|
"properties": {
|
|
75773
76353
|
"package_url": {
|
|
@@ -75809,8 +76389,6 @@
|
|
|
75809
76389
|
"additionalProperties": false
|
|
75810
76390
|
},
|
|
75811
76391
|
"manifest": {
|
|
75812
|
-
"title": "manifest",
|
|
75813
|
-
"description": "A collection of related dependencies declared in a file or representing a logical group of dependencies.",
|
|
75814
76392
|
"type": "object",
|
|
75815
76393
|
"properties": {
|
|
75816
76394
|
"name": {
|
|
@@ -75833,6 +76411,8 @@
|
|
|
75833
76411
|
"$ref": "#/components/schemas/metadata"
|
|
75834
76412
|
},
|
|
75835
76413
|
"resolved": {
|
|
76414
|
+
"type": "object",
|
|
76415
|
+
"description": "A collection of resolved package dependencies.",
|
|
75836
76416
|
"additionalProperties": {
|
|
75837
76417
|
"$ref": "#/components/schemas/dependency"
|
|
75838
76418
|
}
|
|
@@ -75921,7 +76501,7 @@
|
|
|
75921
76501
|
},
|
|
75922
76502
|
"manifests": {
|
|
75923
76503
|
"type": "object",
|
|
75924
|
-
"description": "A collection of package manifests",
|
|
76504
|
+
"description": "A collection of package manifests, which are a collection of related dependencies declared in a file or representing a logical group of dependencies.",
|
|
75925
76505
|
"additionalProperties": {
|
|
75926
76506
|
"$ref": "#/components/schemas/manifest"
|
|
75927
76507
|
}
|
|
@@ -76055,7 +76635,7 @@
|
|
|
76055
76635
|
"example": 30,
|
|
76056
76636
|
"description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."
|
|
76057
76637
|
},
|
|
76058
|
-
"deployment-branch-policy": {
|
|
76638
|
+
"deployment-branch-policy-settings": {
|
|
76059
76639
|
"type": "object",
|
|
76060
76640
|
"description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
|
|
76061
76641
|
"properties": {
|
|
@@ -76212,7 +76792,7 @@
|
|
|
76212
76792
|
}
|
|
76213
76793
|
},
|
|
76214
76794
|
"deployment_branch_policy": {
|
|
76215
|
-
"$ref": "#/components/schemas/deployment-branch-policy"
|
|
76795
|
+
"$ref": "#/components/schemas/deployment-branch-policy-settings"
|
|
76216
76796
|
}
|
|
76217
76797
|
},
|
|
76218
76798
|
"required": [
|
|
@@ -76225,6 +76805,41 @@
|
|
|
76225
76805
|
"updated_at"
|
|
76226
76806
|
]
|
|
76227
76807
|
},
|
|
76808
|
+
"deployment-branch-policy": {
|
|
76809
|
+
"title": "Deployment branch policy",
|
|
76810
|
+
"description": "Details of a deployment branch policy.",
|
|
76811
|
+
"type": "object",
|
|
76812
|
+
"properties": {
|
|
76813
|
+
"id": {
|
|
76814
|
+
"description": "The unique identifier of the branch policy.",
|
|
76815
|
+
"type": "integer",
|
|
76816
|
+
"example": 361471
|
|
76817
|
+
},
|
|
76818
|
+
"node_id": {
|
|
76819
|
+
"type": "string",
|
|
76820
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
76821
|
+
},
|
|
76822
|
+
"name": {
|
|
76823
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
76824
|
+
"type": "string",
|
|
76825
|
+
"example": "release/*"
|
|
76826
|
+
}
|
|
76827
|
+
}
|
|
76828
|
+
},
|
|
76829
|
+
"deployment-branch-policy-name-pattern": {
|
|
76830
|
+
"title": "Deployment branch policy name pattern",
|
|
76831
|
+
"type": "object",
|
|
76832
|
+
"properties": {
|
|
76833
|
+
"name": {
|
|
76834
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).",
|
|
76835
|
+
"type": "string",
|
|
76836
|
+
"example": "release/*"
|
|
76837
|
+
}
|
|
76838
|
+
},
|
|
76839
|
+
"required": [
|
|
76840
|
+
"name"
|
|
76841
|
+
]
|
|
76842
|
+
},
|
|
76228
76843
|
"short-blob": {
|
|
76229
76844
|
"title": "Short Blob",
|
|
76230
76845
|
"description": "Short Blob",
|
|
@@ -85249,7 +85864,7 @@
|
|
|
85249
85864
|
"node_id"
|
|
85250
85865
|
]
|
|
85251
85866
|
},
|
|
85252
|
-
"merge-group-checks-requested": {
|
|
85867
|
+
"webhook-merge-group-checks-requested": {
|
|
85253
85868
|
"type": "object",
|
|
85254
85869
|
"properties": {
|
|
85255
85870
|
"action": {
|
|
@@ -85258,33 +85873,33 @@
|
|
|
85258
85873
|
"installation": {
|
|
85259
85874
|
"$ref": "#/components/schemas/simple-installation"
|
|
85260
85875
|
},
|
|
85261
|
-
"organization": {
|
|
85262
|
-
"$ref": "#/components/schemas/organization-simple"
|
|
85263
|
-
},
|
|
85264
|
-
"repository": {
|
|
85265
|
-
"$ref": "#/components/schemas/repository"
|
|
85266
|
-
},
|
|
85267
|
-
"sender": {
|
|
85268
|
-
"$ref": "#/components/schemas/simple-user"
|
|
85269
|
-
},
|
|
85270
85876
|
"merge_group": {
|
|
85271
85877
|
"type": "object",
|
|
85272
|
-
"required": [
|
|
85273
|
-
"head_sha",
|
|
85274
|
-
"head_ref",
|
|
85275
|
-
"base_ref"
|
|
85276
|
-
],
|
|
85277
85878
|
"properties": {
|
|
85278
|
-
"
|
|
85879
|
+
"base_ref": {
|
|
85279
85880
|
"type": "string"
|
|
85280
85881
|
},
|
|
85281
85882
|
"head_ref": {
|
|
85282
85883
|
"type": "string"
|
|
85283
85884
|
},
|
|
85284
|
-
"
|
|
85885
|
+
"head_sha": {
|
|
85285
85886
|
"type": "string"
|
|
85286
85887
|
}
|
|
85287
|
-
}
|
|
85888
|
+
},
|
|
85889
|
+
"required": [
|
|
85890
|
+
"head_sha",
|
|
85891
|
+
"head_ref",
|
|
85892
|
+
"base_ref"
|
|
85893
|
+
]
|
|
85894
|
+
},
|
|
85895
|
+
"organization": {
|
|
85896
|
+
"$ref": "#/components/schemas/organization-simple"
|
|
85897
|
+
},
|
|
85898
|
+
"repository": {
|
|
85899
|
+
"$ref": "#/components/schemas/repository"
|
|
85900
|
+
},
|
|
85901
|
+
"sender": {
|
|
85902
|
+
"$ref": "#/components/schemas/simple-user"
|
|
85288
85903
|
}
|
|
85289
85904
|
},
|
|
85290
85905
|
"required": [
|
|
@@ -88440,6 +89055,91 @@
|
|
|
88440
89055
|
}
|
|
88441
89056
|
]
|
|
88442
89057
|
},
|
|
89058
|
+
"get-consumed-licenses": {
|
|
89059
|
+
"value": {
|
|
89060
|
+
"total_seats_consumed": 5000,
|
|
89061
|
+
"total_seats_purchased": 4500,
|
|
89062
|
+
"users": [
|
|
89063
|
+
{
|
|
89064
|
+
"enterprise_server_emails": [
|
|
89065
|
+
"monalisa@github.com"
|
|
89066
|
+
],
|
|
89067
|
+
"github_com_login": "monalisa",
|
|
89068
|
+
"github_com_name": "Mona Lisa",
|
|
89069
|
+
"github_com_profile": "https://github.com/monalisa",
|
|
89070
|
+
"license_type": "enterprise",
|
|
89071
|
+
"github_com_member_roles": [
|
|
89072
|
+
"org1:Owner",
|
|
89073
|
+
"org2:Owner"
|
|
89074
|
+
],
|
|
89075
|
+
"github_com_enterprise_role": "owner",
|
|
89076
|
+
"visual_studio_subscription_user": false,
|
|
89077
|
+
"github_com_verified_domain_emails": [
|
|
89078
|
+
"monalisa@github.com"
|
|
89079
|
+
],
|
|
89080
|
+
"github_com_saml_name_id": "monalisa",
|
|
89081
|
+
"enterprise_server_user": true,
|
|
89082
|
+
"github_com_user": true,
|
|
89083
|
+
"total_user_accounts": 3,
|
|
89084
|
+
"enterprise_server_user_ids": [
|
|
89085
|
+
"example_host_name.com:123",
|
|
89086
|
+
"example_host_name_2:222"
|
|
89087
|
+
],
|
|
89088
|
+
"github_com_orgs_with_pending_invites": [
|
|
89089
|
+
"org1",
|
|
89090
|
+
"org2"
|
|
89091
|
+
],
|
|
89092
|
+
"visual_studio_subscription_email": ""
|
|
89093
|
+
},
|
|
89094
|
+
{
|
|
89095
|
+
"enterprise_server_emails": [
|
|
89096
|
+
"deleonjavier@example.com"
|
|
89097
|
+
],
|
|
89098
|
+
"github_com_login": "",
|
|
89099
|
+
"github_com_name": "",
|
|
89100
|
+
"github_com_profile": "",
|
|
89101
|
+
"license_type": "enterprise",
|
|
89102
|
+
"github_com_member_roles": [],
|
|
89103
|
+
"github_com_enterprise_role": "",
|
|
89104
|
+
"visual_studio_subscription_user": false,
|
|
89105
|
+
"github_com_verified_domain_emails": [],
|
|
89106
|
+
"github_com_saml_name_id": "",
|
|
89107
|
+
"enterprise_server_user": true,
|
|
89108
|
+
"github_com_user": false,
|
|
89109
|
+
"total_user_accounts": 1,
|
|
89110
|
+
"enterprise_server_user_ids": [
|
|
89111
|
+
"example_host_name:123"
|
|
89112
|
+
],
|
|
89113
|
+
"github_com_orgs_with_pending_invites": [],
|
|
89114
|
+
"visual_studio_subscription_email": ""
|
|
89115
|
+
}
|
|
89116
|
+
]
|
|
89117
|
+
}
|
|
89118
|
+
},
|
|
89119
|
+
"get-license-sync-status": {
|
|
89120
|
+
"value": {
|
|
89121
|
+
"server_instances": [
|
|
89122
|
+
{
|
|
89123
|
+
"server_id": "deadbeef1",
|
|
89124
|
+
"hostname": "github.example.com",
|
|
89125
|
+
"last_sync": {
|
|
89126
|
+
"date": "2020-01-01T00:00:00Z",
|
|
89127
|
+
"status": "success",
|
|
89128
|
+
"error": ""
|
|
89129
|
+
}
|
|
89130
|
+
},
|
|
89131
|
+
{
|
|
89132
|
+
"server_id": "filetoffish1",
|
|
89133
|
+
"hostname": "github2.example.com",
|
|
89134
|
+
"last_sync": {
|
|
89135
|
+
"date": "2020-01-01T00:00:00Z",
|
|
89136
|
+
"status": "success",
|
|
89137
|
+
"error": ""
|
|
89138
|
+
}
|
|
89139
|
+
}
|
|
89140
|
+
]
|
|
89141
|
+
}
|
|
89142
|
+
},
|
|
88443
89143
|
"organization-secret-scanning-alert-list": {
|
|
88444
89144
|
"value": [
|
|
88445
89145
|
{
|
|
@@ -91807,6 +92507,8 @@
|
|
|
91807
92507
|
},
|
|
91808
92508
|
"location": "WestUs2",
|
|
91809
92509
|
"idle_timeout_minutes": 60,
|
|
92510
|
+
"retention_period_minutes": "43200,",
|
|
92511
|
+
"retention_expires_at": "null,",
|
|
91810
92512
|
"web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q.github.dev",
|
|
91811
92513
|
"machines_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines",
|
|
91812
92514
|
"start_url": "https://api.github.com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start",
|
|
@@ -100590,6 +101292,37 @@
|
|
|
100590
101292
|
}
|
|
100591
101293
|
}
|
|
100592
101294
|
},
|
|
101295
|
+
"deployment-branch-policies-list": {
|
|
101296
|
+
"value": {
|
|
101297
|
+
"total_count": 2,
|
|
101298
|
+
"branch_policies": [
|
|
101299
|
+
{
|
|
101300
|
+
"id": 361471,
|
|
101301
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
|
|
101302
|
+
"name": "release/*"
|
|
101303
|
+
},
|
|
101304
|
+
{
|
|
101305
|
+
"id": 361472,
|
|
101306
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
|
|
101307
|
+
"name": "main"
|
|
101308
|
+
}
|
|
101309
|
+
]
|
|
101310
|
+
}
|
|
101311
|
+
},
|
|
101312
|
+
"deployment-branch-policy-wildcard": {
|
|
101313
|
+
"value": {
|
|
101314
|
+
"id": 364662,
|
|
101315
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
101316
|
+
"name": "release/*"
|
|
101317
|
+
}
|
|
101318
|
+
},
|
|
101319
|
+
"deployment-branch-policy-single-branch": {
|
|
101320
|
+
"value": {
|
|
101321
|
+
"id": 364663,
|
|
101322
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
101323
|
+
"name": "main"
|
|
101324
|
+
}
|
|
101325
|
+
},
|
|
100593
101326
|
"repo-events-items": {
|
|
100594
101327
|
"value": [
|
|
100595
101328
|
{
|
|
@@ -111240,11 +111973,20 @@
|
|
|
111240
111973
|
"name": "environment_name",
|
|
111241
111974
|
"in": "path",
|
|
111242
111975
|
"required": true,
|
|
111243
|
-
"description": "The name of the environment",
|
|
111976
|
+
"description": "The name of the environment.",
|
|
111244
111977
|
"schema": {
|
|
111245
111978
|
"type": "string"
|
|
111246
111979
|
}
|
|
111247
111980
|
},
|
|
111981
|
+
"branch-policy-id": {
|
|
111982
|
+
"name": "branch_policy_id",
|
|
111983
|
+
"in": "path",
|
|
111984
|
+
"required": true,
|
|
111985
|
+
"description": "The unique identifier of the branch policy.",
|
|
111986
|
+
"schema": {
|
|
111987
|
+
"type": "integer"
|
|
111988
|
+
}
|
|
111989
|
+
},
|
|
111248
111990
|
"since-user": {
|
|
111249
111991
|
"name": "since",
|
|
111250
111992
|
"description": "A user ID. Only return users with an ID greater than this ID.",
|