@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": {
|
|
@@ -4243,6 +4243,14 @@
|
|
|
4243
4243
|
"write"
|
|
4244
4244
|
]
|
|
4245
4245
|
},
|
|
4246
|
+
"organization_custom_roles": {
|
|
4247
|
+
"type": "string",
|
|
4248
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
4249
|
+
"enum": [
|
|
4250
|
+
"read",
|
|
4251
|
+
"write"
|
|
4252
|
+
]
|
|
4253
|
+
},
|
|
4246
4254
|
"deployments": {
|
|
4247
4255
|
"type": "string",
|
|
4248
4256
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -5355,6 +5363,14 @@
|
|
|
5355
5363
|
"write"
|
|
5356
5364
|
]
|
|
5357
5365
|
},
|
|
5366
|
+
"organization_custom_roles": {
|
|
5367
|
+
"type": "string",
|
|
5368
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
5369
|
+
"enum": [
|
|
5370
|
+
"read",
|
|
5371
|
+
"write"
|
|
5372
|
+
]
|
|
5373
|
+
},
|
|
5358
5374
|
"deployments": {
|
|
5359
5375
|
"type": "string",
|
|
5360
5376
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -6019,6 +6035,14 @@
|
|
|
6019
6035
|
"write"
|
|
6020
6036
|
]
|
|
6021
6037
|
},
|
|
6038
|
+
"organization_custom_roles": {
|
|
6039
|
+
"type": "string",
|
|
6040
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
6041
|
+
"enum": [
|
|
6042
|
+
"read",
|
|
6043
|
+
"write"
|
|
6044
|
+
]
|
|
6045
|
+
},
|
|
6022
6046
|
"deployments": {
|
|
6023
6047
|
"type": "string",
|
|
6024
6048
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -8600,6 +8624,14 @@
|
|
|
8600
8624
|
"write"
|
|
8601
8625
|
]
|
|
8602
8626
|
},
|
|
8627
|
+
"organization_custom_roles": {
|
|
8628
|
+
"type": "string",
|
|
8629
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
8630
|
+
"enum": [
|
|
8631
|
+
"read",
|
|
8632
|
+
"write"
|
|
8633
|
+
]
|
|
8634
|
+
},
|
|
8603
8635
|
"deployments": {
|
|
8604
8636
|
"type": "string",
|
|
8605
8637
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -9389,6 +9421,14 @@
|
|
|
9389
9421
|
"write"
|
|
9390
9422
|
]
|
|
9391
9423
|
},
|
|
9424
|
+
"organization_custom_roles": {
|
|
9425
|
+
"type": "string",
|
|
9426
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
9427
|
+
"enum": [
|
|
9428
|
+
"read",
|
|
9429
|
+
"write"
|
|
9430
|
+
]
|
|
9431
|
+
},
|
|
9392
9432
|
"deployments": {
|
|
9393
9433
|
"type": "string",
|
|
9394
9434
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10042,6 +10082,14 @@
|
|
|
10042
10082
|
"write"
|
|
10043
10083
|
]
|
|
10044
10084
|
},
|
|
10085
|
+
"organization_custom_roles": {
|
|
10086
|
+
"type": "string",
|
|
10087
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10088
|
+
"enum": [
|
|
10089
|
+
"read",
|
|
10090
|
+
"write"
|
|
10091
|
+
]
|
|
10092
|
+
},
|
|
10045
10093
|
"deployments": {
|
|
10046
10094
|
"type": "string",
|
|
10047
10095
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10327,6 +10375,14 @@
|
|
|
10327
10375
|
"write"
|
|
10328
10376
|
]
|
|
10329
10377
|
},
|
|
10378
|
+
"organization_custom_roles": {
|
|
10379
|
+
"type": "string",
|
|
10380
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10381
|
+
"enum": [
|
|
10382
|
+
"read",
|
|
10383
|
+
"write"
|
|
10384
|
+
]
|
|
10385
|
+
},
|
|
10330
10386
|
"deployments": {
|
|
10331
10387
|
"type": "string",
|
|
10332
10388
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -13322,6 +13378,14 @@
|
|
|
13322
13378
|
"write"
|
|
13323
13379
|
]
|
|
13324
13380
|
},
|
|
13381
|
+
"organization_custom_roles": {
|
|
13382
|
+
"type": "string",
|
|
13383
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
13384
|
+
"enum": [
|
|
13385
|
+
"read",
|
|
13386
|
+
"write"
|
|
13387
|
+
]
|
|
13388
|
+
},
|
|
13325
13389
|
"deployments": {
|
|
13326
13390
|
"type": "string",
|
|
13327
13391
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -14165,6 +14229,14 @@
|
|
|
14165
14229
|
"write"
|
|
14166
14230
|
]
|
|
14167
14231
|
},
|
|
14232
|
+
"organization_custom_roles": {
|
|
14233
|
+
"type": "string",
|
|
14234
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
14235
|
+
"enum": [
|
|
14236
|
+
"read",
|
|
14237
|
+
"write"
|
|
14238
|
+
]
|
|
14239
|
+
},
|
|
14168
14240
|
"deployments": {
|
|
14169
14241
|
"type": "string",
|
|
14170
14242
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -14932,6 +15004,14 @@
|
|
|
14932
15004
|
"write"
|
|
14933
15005
|
]
|
|
14934
15006
|
},
|
|
15007
|
+
"organization_custom_roles": {
|
|
15008
|
+
"type": "string",
|
|
15009
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
15010
|
+
"enum": [
|
|
15011
|
+
"read",
|
|
15012
|
+
"write"
|
|
15013
|
+
]
|
|
15014
|
+
},
|
|
14935
15015
|
"deployments": {
|
|
14936
15016
|
"type": "string",
|
|
14937
15017
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -15407,6 +15487,14 @@
|
|
|
15407
15487
|
"write"
|
|
15408
15488
|
]
|
|
15409
15489
|
},
|
|
15490
|
+
"organization_custom_roles": {
|
|
15491
|
+
"type": "string",
|
|
15492
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
15493
|
+
"enum": [
|
|
15494
|
+
"read",
|
|
15495
|
+
"write"
|
|
15496
|
+
]
|
|
15497
|
+
},
|
|
15410
15498
|
"deployments": {
|
|
15411
15499
|
"type": "string",
|
|
15412
15500
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -16704,6 +16792,14 @@
|
|
|
16704
16792
|
"write"
|
|
16705
16793
|
]
|
|
16706
16794
|
},
|
|
16795
|
+
"organization_custom_roles": {
|
|
16796
|
+
"type": "string",
|
|
16797
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
16798
|
+
"enum": [
|
|
16799
|
+
"read",
|
|
16800
|
+
"write"
|
|
16801
|
+
]
|
|
16802
|
+
},
|
|
16707
16803
|
"deployments": {
|
|
16708
16804
|
"type": "string",
|
|
16709
16805
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -17563,6 +17659,14 @@
|
|
|
17563
17659
|
"write"
|
|
17564
17660
|
]
|
|
17565
17661
|
},
|
|
17662
|
+
"organization_custom_roles": {
|
|
17663
|
+
"type": "string",
|
|
17664
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
17665
|
+
"enum": [
|
|
17666
|
+
"read",
|
|
17667
|
+
"write"
|
|
17668
|
+
]
|
|
17669
|
+
},
|
|
17566
17670
|
"deployments": {
|
|
17567
17671
|
"type": "string",
|
|
17568
17672
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -18491,6 +18595,14 @@
|
|
|
18491
18595
|
"write"
|
|
18492
18596
|
]
|
|
18493
18597
|
},
|
|
18598
|
+
"organization_custom_roles": {
|
|
18599
|
+
"type": "string",
|
|
18600
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
18601
|
+
"enum": [
|
|
18602
|
+
"read",
|
|
18603
|
+
"write"
|
|
18604
|
+
]
|
|
18605
|
+
},
|
|
18494
18606
|
"deployments": {
|
|
18495
18607
|
"type": "string",
|
|
18496
18608
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -19163,6 +19275,14 @@
|
|
|
19163
19275
|
"write"
|
|
19164
19276
|
]
|
|
19165
19277
|
},
|
|
19278
|
+
"organization_custom_roles": {
|
|
19279
|
+
"type": "string",
|
|
19280
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
19281
|
+
"enum": [
|
|
19282
|
+
"read",
|
|
19283
|
+
"write"
|
|
19284
|
+
]
|
|
19285
|
+
},
|
|
19166
19286
|
"deployments": {
|
|
19167
19287
|
"type": "string",
|
|
19168
19288
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -20069,6 +20189,14 @@
|
|
|
20069
20189
|
"write"
|
|
20070
20190
|
]
|
|
20071
20191
|
},
|
|
20192
|
+
"organization_custom_roles": {
|
|
20193
|
+
"type": "string",
|
|
20194
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
20195
|
+
"enum": [
|
|
20196
|
+
"read",
|
|
20197
|
+
"write"
|
|
20198
|
+
]
|
|
20199
|
+
},
|
|
20072
20200
|
"deployments": {
|
|
20073
20201
|
"type": "string",
|
|
20074
20202
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -20741,6 +20869,14 @@
|
|
|
20741
20869
|
"write"
|
|
20742
20870
|
]
|
|
20743
20871
|
},
|
|
20872
|
+
"organization_custom_roles": {
|
|
20873
|
+
"type": "string",
|
|
20874
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
20875
|
+
"enum": [
|
|
20876
|
+
"read",
|
|
20877
|
+
"write"
|
|
20878
|
+
]
|
|
20879
|
+
},
|
|
20744
20880
|
"deployments": {
|
|
20745
20881
|
"type": "string",
|
|
20746
20882
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -21525,6 +21661,14 @@
|
|
|
21525
21661
|
"write"
|
|
21526
21662
|
]
|
|
21527
21663
|
},
|
|
21664
|
+
"organization_custom_roles": {
|
|
21665
|
+
"type": "string",
|
|
21666
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
21667
|
+
"enum": [
|
|
21668
|
+
"read",
|
|
21669
|
+
"write"
|
|
21670
|
+
]
|
|
21671
|
+
},
|
|
21528
21672
|
"deployments": {
|
|
21529
21673
|
"type": "string",
|
|
21530
21674
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -22336,6 +22480,14 @@
|
|
|
22336
22480
|
"write"
|
|
22337
22481
|
]
|
|
22338
22482
|
},
|
|
22483
|
+
"organization_custom_roles": {
|
|
22484
|
+
"type": "string",
|
|
22485
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
22486
|
+
"enum": [
|
|
22487
|
+
"read",
|
|
22488
|
+
"write"
|
|
22489
|
+
]
|
|
22490
|
+
},
|
|
22339
22491
|
"deployments": {
|
|
22340
22492
|
"type": "string",
|
|
22341
22493
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -83667,6 +83819,14 @@
|
|
|
83667
83819
|
"write"
|
|
83668
83820
|
]
|
|
83669
83821
|
},
|
|
83822
|
+
"organization_custom_roles": {
|
|
83823
|
+
"type": "string",
|
|
83824
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
83825
|
+
"enum": [
|
|
83826
|
+
"read",
|
|
83827
|
+
"write"
|
|
83828
|
+
]
|
|
83829
|
+
},
|
|
83670
83830
|
"deployments": {
|
|
83671
83831
|
"type": "string",
|
|
83672
83832
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -84470,6 +84630,14 @@
|
|
|
84470
84630
|
"write"
|
|
84471
84631
|
]
|
|
84472
84632
|
},
|
|
84633
|
+
"organization_custom_roles": {
|
|
84634
|
+
"type": "string",
|
|
84635
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
84636
|
+
"enum": [
|
|
84637
|
+
"read",
|
|
84638
|
+
"write"
|
|
84639
|
+
]
|
|
84640
|
+
},
|
|
84473
84641
|
"deployments": {
|
|
84474
84642
|
"type": "string",
|
|
84475
84643
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -113326,13 +113494,6 @@
|
|
|
113326
113494
|
"permission": {
|
|
113327
113495
|
"type": "string",
|
|
113328
113496
|
"description": "The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.",
|
|
113329
|
-
"enum": [
|
|
113330
|
-
"pull",
|
|
113331
|
-
"push",
|
|
113332
|
-
"admin",
|
|
113333
|
-
"maintain",
|
|
113334
|
-
"triage"
|
|
113335
|
-
],
|
|
113336
113497
|
"default": "push"
|
|
113337
113498
|
}
|
|
113338
113499
|
}
|
|
@@ -130748,7 +130909,7 @@
|
|
|
130748
130909
|
"/repos/{owner}/{repo}/actions/permissions/access": {
|
|
130749
130910
|
"get": {
|
|
130750
130911
|
"summary": "Get the level of access for workflows outside of the repository",
|
|
130751
|
-
"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
|
|
130912
|
+
"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/enterprise-server@3.6/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.",
|
|
130752
130913
|
"tags": [
|
|
130753
130914
|
"actions"
|
|
130754
130915
|
],
|
|
@@ -130817,6 +130978,164 @@
|
|
|
130817
130978
|
"category": "actions",
|
|
130818
130979
|
"subcategory": "permissions"
|
|
130819
130980
|
},
|
|
130981
|
+
"x-octokit": {}
|
|
130982
|
+
},
|
|
130983
|
+
"put": {
|
|
130984
|
+
"summary": "Set the level of access for workflows outside of the repository",
|
|
130985
|
+
"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/enterprise-server@3.6/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.",
|
|
130986
|
+
"tags": [
|
|
130987
|
+
"actions"
|
|
130988
|
+
],
|
|
130989
|
+
"operationId": "actions/set-workflow-access-to-repository",
|
|
130990
|
+
"externalDocs": {
|
|
130991
|
+
"description": "API method documentation",
|
|
130992
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-workflow-access-to-a-repository"
|
|
130993
|
+
},
|
|
130994
|
+
"parameters": [
|
|
130995
|
+
{
|
|
130996
|
+
"name": "owner",
|
|
130997
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
130998
|
+
"in": "path",
|
|
130999
|
+
"required": true,
|
|
131000
|
+
"schema": {
|
|
131001
|
+
"type": "string"
|
|
131002
|
+
}
|
|
131003
|
+
},
|
|
131004
|
+
{
|
|
131005
|
+
"name": "repo",
|
|
131006
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
131007
|
+
"in": "path",
|
|
131008
|
+
"required": true,
|
|
131009
|
+
"schema": {
|
|
131010
|
+
"type": "string"
|
|
131011
|
+
}
|
|
131012
|
+
}
|
|
131013
|
+
],
|
|
131014
|
+
"requestBody": {
|
|
131015
|
+
"required": true,
|
|
131016
|
+
"content": {
|
|
131017
|
+
"application/json": {
|
|
131018
|
+
"schema": {
|
|
131019
|
+
"type": "object",
|
|
131020
|
+
"properties": {
|
|
131021
|
+
"access_level": {
|
|
131022
|
+
"type": "string",
|
|
131023
|
+
"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.",
|
|
131024
|
+
"enum": [
|
|
131025
|
+
"none",
|
|
131026
|
+
"organization",
|
|
131027
|
+
"enterprise"
|
|
131028
|
+
]
|
|
131029
|
+
}
|
|
131030
|
+
},
|
|
131031
|
+
"required": [
|
|
131032
|
+
"access_level"
|
|
131033
|
+
]
|
|
131034
|
+
},
|
|
131035
|
+
"examples": {
|
|
131036
|
+
"default": {
|
|
131037
|
+
"value": {
|
|
131038
|
+
"access_level": "organization"
|
|
131039
|
+
}
|
|
131040
|
+
}
|
|
131041
|
+
}
|
|
131042
|
+
}
|
|
131043
|
+
}
|
|
131044
|
+
},
|
|
131045
|
+
"responses": {
|
|
131046
|
+
"204": {
|
|
131047
|
+
"description": "Response"
|
|
131048
|
+
}
|
|
131049
|
+
},
|
|
131050
|
+
"x-github": {
|
|
131051
|
+
"githubCloudOnly": false,
|
|
131052
|
+
"enabledForGitHubApps": true,
|
|
131053
|
+
"previews": [],
|
|
131054
|
+
"category": "actions",
|
|
131055
|
+
"subcategory": "permissions"
|
|
131056
|
+
},
|
|
131057
|
+
"x-octokit": {}
|
|
131058
|
+
}
|
|
131059
|
+
},
|
|
131060
|
+
"/repos/{owner}/{repo}/actions/permissions/selected-actions": {
|
|
131061
|
+
"get": {
|
|
131062
|
+
"summary": "Get allowed actions for a repository",
|
|
131063
|
+
"description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
|
|
131064
|
+
"operationId": "actions/get-allowed-actions-repository",
|
|
131065
|
+
"tags": [
|
|
131066
|
+
"actions"
|
|
131067
|
+
],
|
|
131068
|
+
"externalDocs": {
|
|
131069
|
+
"description": "API method documentation",
|
|
131070
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-allowed-actions-for-a-repository"
|
|
131071
|
+
},
|
|
131072
|
+
"parameters": [
|
|
131073
|
+
{
|
|
131074
|
+
"name": "owner",
|
|
131075
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
131076
|
+
"in": "path",
|
|
131077
|
+
"required": true,
|
|
131078
|
+
"schema": {
|
|
131079
|
+
"type": "string"
|
|
131080
|
+
}
|
|
131081
|
+
},
|
|
131082
|
+
{
|
|
131083
|
+
"name": "repo",
|
|
131084
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
131085
|
+
"in": "path",
|
|
131086
|
+
"required": true,
|
|
131087
|
+
"schema": {
|
|
131088
|
+
"type": "string"
|
|
131089
|
+
}
|
|
131090
|
+
}
|
|
131091
|
+
],
|
|
131092
|
+
"responses": {
|
|
131093
|
+
"200": {
|
|
131094
|
+
"description": "Response",
|
|
131095
|
+
"content": {
|
|
131096
|
+
"application/json": {
|
|
131097
|
+
"schema": {
|
|
131098
|
+
"type": "object",
|
|
131099
|
+
"properties": {
|
|
131100
|
+
"github_owned_allowed": {
|
|
131101
|
+
"type": "boolean",
|
|
131102
|
+
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
131103
|
+
},
|
|
131104
|
+
"patterns_allowed": {
|
|
131105
|
+
"type": "array",
|
|
131106
|
+
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
131107
|
+
"items": {
|
|
131108
|
+
"type": "string"
|
|
131109
|
+
}
|
|
131110
|
+
}
|
|
131111
|
+
},
|
|
131112
|
+
"required": [
|
|
131113
|
+
"github_owned_allowed",
|
|
131114
|
+
"patterns_allowed"
|
|
131115
|
+
]
|
|
131116
|
+
},
|
|
131117
|
+
"examples": {
|
|
131118
|
+
"default": {
|
|
131119
|
+
"value": {
|
|
131120
|
+
"github_owned_allowed": true,
|
|
131121
|
+
"verified_allowed": false,
|
|
131122
|
+
"patterns_allowed": [
|
|
131123
|
+
"monalisa/octocat@*",
|
|
131124
|
+
"docker/*"
|
|
131125
|
+
]
|
|
131126
|
+
}
|
|
131127
|
+
}
|
|
131128
|
+
}
|
|
131129
|
+
}
|
|
131130
|
+
}
|
|
131131
|
+
}
|
|
131132
|
+
},
|
|
131133
|
+
"x-github": {
|
|
131134
|
+
"enabledForGitHubApps": true,
|
|
131135
|
+
"githubCloudOnly": false,
|
|
131136
|
+
"category": "actions",
|
|
131137
|
+
"subcategory": "permissions"
|
|
131138
|
+
},
|
|
130820
131139
|
"x-octokit": {
|
|
130821
131140
|
"diff": {
|
|
130822
131141
|
"api.github.com": {
|
|
@@ -130826,185 +131145,15 @@
|
|
|
130826
131145
|
}
|
|
130827
131146
|
},
|
|
130828
131147
|
"put": {
|
|
130829
|
-
"summary": "Set
|
|
130830
|
-
"description": "Sets the
|
|
131148
|
+
"summary": "Set allowed actions for a repository",
|
|
131149
|
+
"description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
|
|
131150
|
+
"operationId": "actions/set-allowed-actions-repository",
|
|
130831
131151
|
"tags": [
|
|
130832
131152
|
"actions"
|
|
130833
131153
|
],
|
|
130834
|
-
"operationId": "actions/set-workflow-access-to-repository",
|
|
130835
131154
|
"externalDocs": {
|
|
130836
131155
|
"description": "API method documentation",
|
|
130837
|
-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-
|
|
130838
|
-
},
|
|
130839
|
-
"parameters": [
|
|
130840
|
-
{
|
|
130841
|
-
"name": "owner",
|
|
130842
|
-
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
130843
|
-
"in": "path",
|
|
130844
|
-
"required": true,
|
|
130845
|
-
"schema": {
|
|
130846
|
-
"type": "string"
|
|
130847
|
-
}
|
|
130848
|
-
},
|
|
130849
|
-
{
|
|
130850
|
-
"name": "repo",
|
|
130851
|
-
"description": "The name of the repository. The name is not case sensitive.",
|
|
130852
|
-
"in": "path",
|
|
130853
|
-
"required": true,
|
|
130854
|
-
"schema": {
|
|
130855
|
-
"type": "string"
|
|
130856
|
-
}
|
|
130857
|
-
}
|
|
130858
|
-
],
|
|
130859
|
-
"requestBody": {
|
|
130860
|
-
"required": true,
|
|
130861
|
-
"content": {
|
|
130862
|
-
"application/json": {
|
|
130863
|
-
"schema": {
|
|
130864
|
-
"type": "object",
|
|
130865
|
-
"properties": {
|
|
130866
|
-
"access_level": {
|
|
130867
|
-
"type": "string",
|
|
130868
|
-
"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.",
|
|
130869
|
-
"enum": [
|
|
130870
|
-
"none",
|
|
130871
|
-
"organization",
|
|
130872
|
-
"enterprise"
|
|
130873
|
-
]
|
|
130874
|
-
}
|
|
130875
|
-
},
|
|
130876
|
-
"required": [
|
|
130877
|
-
"access_level"
|
|
130878
|
-
]
|
|
130879
|
-
},
|
|
130880
|
-
"examples": {
|
|
130881
|
-
"default": {
|
|
130882
|
-
"value": {
|
|
130883
|
-
"access_level": "organization"
|
|
130884
|
-
}
|
|
130885
|
-
}
|
|
130886
|
-
}
|
|
130887
|
-
}
|
|
130888
|
-
}
|
|
130889
|
-
},
|
|
130890
|
-
"responses": {
|
|
130891
|
-
"204": {
|
|
130892
|
-
"description": "Response"
|
|
130893
|
-
}
|
|
130894
|
-
},
|
|
130895
|
-
"x-github": {
|
|
130896
|
-
"githubCloudOnly": false,
|
|
130897
|
-
"enabledForGitHubApps": true,
|
|
130898
|
-
"previews": [],
|
|
130899
|
-
"category": "actions",
|
|
130900
|
-
"subcategory": "permissions"
|
|
130901
|
-
},
|
|
130902
|
-
"x-octokit": {
|
|
130903
|
-
"diff": {
|
|
130904
|
-
"api.github.com": {
|
|
130905
|
-
"type": "changed"
|
|
130906
|
-
}
|
|
130907
|
-
}
|
|
130908
|
-
}
|
|
130909
|
-
}
|
|
130910
|
-
},
|
|
130911
|
-
"/repos/{owner}/{repo}/actions/permissions/selected-actions": {
|
|
130912
|
-
"get": {
|
|
130913
|
-
"summary": "Get allowed actions for a repository",
|
|
130914
|
-
"description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
|
|
130915
|
-
"operationId": "actions/get-allowed-actions-repository",
|
|
130916
|
-
"tags": [
|
|
130917
|
-
"actions"
|
|
130918
|
-
],
|
|
130919
|
-
"externalDocs": {
|
|
130920
|
-
"description": "API method documentation",
|
|
130921
|
-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#get-allowed-actions-for-a-repository"
|
|
130922
|
-
},
|
|
130923
|
-
"parameters": [
|
|
130924
|
-
{
|
|
130925
|
-
"name": "owner",
|
|
130926
|
-
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
130927
|
-
"in": "path",
|
|
130928
|
-
"required": true,
|
|
130929
|
-
"schema": {
|
|
130930
|
-
"type": "string"
|
|
130931
|
-
}
|
|
130932
|
-
},
|
|
130933
|
-
{
|
|
130934
|
-
"name": "repo",
|
|
130935
|
-
"description": "The name of the repository. The name is not case sensitive.",
|
|
130936
|
-
"in": "path",
|
|
130937
|
-
"required": true,
|
|
130938
|
-
"schema": {
|
|
130939
|
-
"type": "string"
|
|
130940
|
-
}
|
|
130941
|
-
}
|
|
130942
|
-
],
|
|
130943
|
-
"responses": {
|
|
130944
|
-
"200": {
|
|
130945
|
-
"description": "Response",
|
|
130946
|
-
"content": {
|
|
130947
|
-
"application/json": {
|
|
130948
|
-
"schema": {
|
|
130949
|
-
"type": "object",
|
|
130950
|
-
"properties": {
|
|
130951
|
-
"github_owned_allowed": {
|
|
130952
|
-
"type": "boolean",
|
|
130953
|
-
"description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization."
|
|
130954
|
-
},
|
|
130955
|
-
"patterns_allowed": {
|
|
130956
|
-
"type": "array",
|
|
130957
|
-
"description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"",
|
|
130958
|
-
"items": {
|
|
130959
|
-
"type": "string"
|
|
130960
|
-
}
|
|
130961
|
-
}
|
|
130962
|
-
},
|
|
130963
|
-
"required": [
|
|
130964
|
-
"github_owned_allowed",
|
|
130965
|
-
"patterns_allowed"
|
|
130966
|
-
]
|
|
130967
|
-
},
|
|
130968
|
-
"examples": {
|
|
130969
|
-
"default": {
|
|
130970
|
-
"value": {
|
|
130971
|
-
"github_owned_allowed": true,
|
|
130972
|
-
"verified_allowed": false,
|
|
130973
|
-
"patterns_allowed": [
|
|
130974
|
-
"monalisa/octocat@*",
|
|
130975
|
-
"docker/*"
|
|
130976
|
-
]
|
|
130977
|
-
}
|
|
130978
|
-
}
|
|
130979
|
-
}
|
|
130980
|
-
}
|
|
130981
|
-
}
|
|
130982
|
-
}
|
|
130983
|
-
},
|
|
130984
|
-
"x-github": {
|
|
130985
|
-
"enabledForGitHubApps": true,
|
|
130986
|
-
"githubCloudOnly": false,
|
|
130987
|
-
"category": "actions",
|
|
130988
|
-
"subcategory": "permissions"
|
|
130989
|
-
},
|
|
130990
|
-
"x-octokit": {
|
|
130991
|
-
"diff": {
|
|
130992
|
-
"api.github.com": {
|
|
130993
|
-
"type": "changed"
|
|
130994
|
-
}
|
|
130995
|
-
}
|
|
130996
|
-
}
|
|
130997
|
-
},
|
|
130998
|
-
"put": {
|
|
130999
|
-
"summary": "Set allowed actions for a repository",
|
|
131000
|
-
"description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.",
|
|
131001
|
-
"operationId": "actions/set-allowed-actions-repository",
|
|
131002
|
-
"tags": [
|
|
131003
|
-
"actions"
|
|
131004
|
-
],
|
|
131005
|
-
"externalDocs": {
|
|
131006
|
-
"description": "API method documentation",
|
|
131007
|
-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-allowed-actions-for-a-repository"
|
|
131156
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/actions#set-allowed-actions-for-a-repository"
|
|
131008
131157
|
},
|
|
131009
131158
|
"parameters": [
|
|
131010
131159
|
{
|
|
@@ -195648,13 +195797,6 @@
|
|
|
195648
195797
|
"permission": {
|
|
195649
195798
|
"type": "string",
|
|
195650
195799
|
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**",
|
|
195651
|
-
"enum": [
|
|
195652
|
-
"pull",
|
|
195653
|
-
"push",
|
|
195654
|
-
"admin",
|
|
195655
|
-
"maintain",
|
|
195656
|
-
"triage"
|
|
195657
|
-
],
|
|
195658
195800
|
"default": "push"
|
|
195659
195801
|
}
|
|
195660
195802
|
}
|
|
@@ -215725,7 +215867,13 @@
|
|
|
215725
215867
|
"type": "object",
|
|
215726
215868
|
"properties": {
|
|
215727
215869
|
"type": {
|
|
215728
|
-
"type": "string"
|
|
215870
|
+
"type": "string",
|
|
215871
|
+
"enum": [
|
|
215872
|
+
"dir",
|
|
215873
|
+
"file",
|
|
215874
|
+
"submodule",
|
|
215875
|
+
"symlink"
|
|
215876
|
+
]
|
|
215729
215877
|
},
|
|
215730
215878
|
"size": {
|
|
215731
215879
|
"type": "integer"
|
|
@@ -215806,7 +215954,10 @@
|
|
|
215806
215954
|
"type": "object",
|
|
215807
215955
|
"properties": {
|
|
215808
215956
|
"type": {
|
|
215809
|
-
"type": "string"
|
|
215957
|
+
"type": "string",
|
|
215958
|
+
"enum": [
|
|
215959
|
+
"file"
|
|
215960
|
+
]
|
|
215810
215961
|
},
|
|
215811
215962
|
"encoding": {
|
|
215812
215963
|
"type": "string"
|
|
@@ -215899,7 +216050,10 @@
|
|
|
215899
216050
|
"type": "object",
|
|
215900
216051
|
"properties": {
|
|
215901
216052
|
"type": {
|
|
215902
|
-
"type": "string"
|
|
216053
|
+
"type": "string",
|
|
216054
|
+
"enum": [
|
|
216055
|
+
"symlink"
|
|
216056
|
+
]
|
|
215903
216057
|
},
|
|
215904
216058
|
"target": {
|
|
215905
216059
|
"type": "string"
|
|
@@ -215975,12 +216129,15 @@
|
|
|
215975
216129
|
]
|
|
215976
216130
|
},
|
|
215977
216131
|
{
|
|
215978
|
-
"title": "
|
|
215979
|
-
"description": "An object describing a
|
|
216132
|
+
"title": "Submodule Content",
|
|
216133
|
+
"description": "An object describing a submodule",
|
|
215980
216134
|
"type": "object",
|
|
215981
216135
|
"properties": {
|
|
215982
216136
|
"type": {
|
|
215983
|
-
"type": "string"
|
|
216137
|
+
"type": "string",
|
|
216138
|
+
"enum": [
|
|
216139
|
+
"submodule"
|
|
216140
|
+
]
|
|
215984
216141
|
},
|
|
215985
216142
|
"submodule_git_url": {
|
|
215986
216143
|
"type": "string",
|
|
@@ -222549,15 +222706,15 @@
|
|
|
222549
222706
|
},
|
|
222550
222707
|
"/repos/{owner}/{repo}/environments": {
|
|
222551
222708
|
"get": {
|
|
222552
|
-
"summary": "
|
|
222553
|
-
"description": "
|
|
222709
|
+
"summary": "List environments",
|
|
222710
|
+
"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.",
|
|
222554
222711
|
"tags": [
|
|
222555
222712
|
"repos"
|
|
222556
222713
|
],
|
|
222557
222714
|
"operationId": "repos/get-all-environments",
|
|
222558
222715
|
"externalDocs": {
|
|
222559
222716
|
"description": "API method documentation",
|
|
222560
|
-
"url": "https://docs.github.com/enterprise-server@3.6/rest/
|
|
222717
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/environments#list-environments"
|
|
222561
222718
|
},
|
|
222562
222719
|
"parameters": [
|
|
222563
222720
|
{
|
|
@@ -223156,7 +223313,7 @@
|
|
|
223156
223313
|
"x-github": {
|
|
223157
223314
|
"githubCloudOnly": false,
|
|
223158
223315
|
"enabledForGitHubApps": true,
|
|
223159
|
-
"category": "
|
|
223316
|
+
"category": "deployments",
|
|
223160
223317
|
"subcategory": "environments"
|
|
223161
223318
|
},
|
|
223162
223319
|
"x-octokit": {}
|
|
@@ -223165,7 +223322,7 @@
|
|
|
223165
223322
|
"/repos/{owner}/{repo}/environments/{environment_name}": {
|
|
223166
223323
|
"get": {
|
|
223167
223324
|
"summary": "Get an environment",
|
|
223168
|
-
"description": "
|
|
223325
|
+
"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.",
|
|
223169
223326
|
"tags": [
|
|
223170
223327
|
"repos"
|
|
223171
223328
|
],
|
|
@@ -223197,7 +223354,7 @@
|
|
|
223197
223354
|
"name": "environment_name",
|
|
223198
223355
|
"in": "path",
|
|
223199
223356
|
"required": true,
|
|
223200
|
-
"description": "The name of the environment",
|
|
223357
|
+
"description": "The name of the environment.",
|
|
223201
223358
|
"schema": {
|
|
223202
223359
|
"type": "string"
|
|
223203
223360
|
}
|
|
@@ -223751,7 +223908,7 @@
|
|
|
223751
223908
|
},
|
|
223752
223909
|
"put": {
|
|
223753
223910
|
"summary": "Create or update an environment",
|
|
223754
|
-
"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:**
|
|
223911
|
+
"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.",
|
|
223755
223912
|
"tags": [
|
|
223756
223913
|
"repos"
|
|
223757
223914
|
],
|
|
@@ -223783,7 +223940,7 @@
|
|
|
223783
223940
|
"name": "environment_name",
|
|
223784
223941
|
"in": "path",
|
|
223785
223942
|
"required": true,
|
|
223786
|
-
"description": "The name of the environment",
|
|
223943
|
+
"description": "The name of the environment.",
|
|
223787
223944
|
"schema": {
|
|
223788
223945
|
"type": "string"
|
|
223789
223946
|
}
|
|
@@ -223847,6 +224004,27 @@
|
|
|
223847
224004
|
}
|
|
223848
224005
|
},
|
|
223849
224006
|
"additionalProperties": false
|
|
224007
|
+
},
|
|
224008
|
+
"examples": {
|
|
224009
|
+
"default": {
|
|
224010
|
+
"value": {
|
|
224011
|
+
"wait_timer": 30,
|
|
224012
|
+
"reviewers": [
|
|
224013
|
+
{
|
|
224014
|
+
"type": "User",
|
|
224015
|
+
"id": 1
|
|
224016
|
+
},
|
|
224017
|
+
{
|
|
224018
|
+
"type": "Team",
|
|
224019
|
+
"id": 1
|
|
224020
|
+
}
|
|
224021
|
+
],
|
|
224022
|
+
"deployment_branch_policy": {
|
|
224023
|
+
"protected_branches": false,
|
|
224024
|
+
"custom_branch_policies": true
|
|
224025
|
+
}
|
|
224026
|
+
}
|
|
224027
|
+
}
|
|
223850
224028
|
}
|
|
223851
224029
|
}
|
|
223852
224030
|
}
|
|
@@ -224457,7 +224635,7 @@
|
|
|
224457
224635
|
"name": "environment_name",
|
|
224458
224636
|
"in": "path",
|
|
224459
224637
|
"required": true,
|
|
224460
|
-
"description": "The name of the environment",
|
|
224638
|
+
"description": "The name of the environment.",
|
|
224461
224639
|
"schema": {
|
|
224462
224640
|
"type": "string"
|
|
224463
224641
|
}
|
|
@@ -224477,6 +224655,559 @@
|
|
|
224477
224655
|
"x-octokit": {}
|
|
224478
224656
|
}
|
|
224479
224657
|
},
|
|
224658
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
|
|
224659
|
+
"get": {
|
|
224660
|
+
"summary": "List deployment branch policies",
|
|
224661
|
+
"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.",
|
|
224662
|
+
"tags": [
|
|
224663
|
+
"repos"
|
|
224664
|
+
],
|
|
224665
|
+
"operationId": "repos/list-deployment-branch-policies",
|
|
224666
|
+
"externalDocs": {
|
|
224667
|
+
"description": "API method documentation",
|
|
224668
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#list-deployment-branch-policies"
|
|
224669
|
+
},
|
|
224670
|
+
"parameters": [
|
|
224671
|
+
{
|
|
224672
|
+
"name": "owner",
|
|
224673
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
224674
|
+
"in": "path",
|
|
224675
|
+
"required": true,
|
|
224676
|
+
"schema": {
|
|
224677
|
+
"type": "string"
|
|
224678
|
+
}
|
|
224679
|
+
},
|
|
224680
|
+
{
|
|
224681
|
+
"name": "repo",
|
|
224682
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
224683
|
+
"in": "path",
|
|
224684
|
+
"required": true,
|
|
224685
|
+
"schema": {
|
|
224686
|
+
"type": "string"
|
|
224687
|
+
}
|
|
224688
|
+
},
|
|
224689
|
+
{
|
|
224690
|
+
"name": "environment_name",
|
|
224691
|
+
"in": "path",
|
|
224692
|
+
"required": true,
|
|
224693
|
+
"description": "The name of the environment.",
|
|
224694
|
+
"schema": {
|
|
224695
|
+
"type": "string"
|
|
224696
|
+
}
|
|
224697
|
+
},
|
|
224698
|
+
{
|
|
224699
|
+
"name": "per_page",
|
|
224700
|
+
"description": "The number of results per page (max 100).",
|
|
224701
|
+
"in": "query",
|
|
224702
|
+
"schema": {
|
|
224703
|
+
"type": "integer",
|
|
224704
|
+
"default": 30
|
|
224705
|
+
}
|
|
224706
|
+
},
|
|
224707
|
+
{
|
|
224708
|
+
"name": "page",
|
|
224709
|
+
"description": "Page number of the results to fetch.",
|
|
224710
|
+
"in": "query",
|
|
224711
|
+
"schema": {
|
|
224712
|
+
"type": "integer",
|
|
224713
|
+
"default": 1
|
|
224714
|
+
}
|
|
224715
|
+
}
|
|
224716
|
+
],
|
|
224717
|
+
"responses": {
|
|
224718
|
+
"200": {
|
|
224719
|
+
"description": "Response",
|
|
224720
|
+
"content": {
|
|
224721
|
+
"application/json": {
|
|
224722
|
+
"schema": {
|
|
224723
|
+
"type": "object",
|
|
224724
|
+
"properties": {
|
|
224725
|
+
"total_count": {
|
|
224726
|
+
"description": "The number of deployment branch policies for the environment.",
|
|
224727
|
+
"type": "integer",
|
|
224728
|
+
"example": 2
|
|
224729
|
+
},
|
|
224730
|
+
"branch_policies": {
|
|
224731
|
+
"type": "array",
|
|
224732
|
+
"items": {
|
|
224733
|
+
"title": "Deployment branch policy",
|
|
224734
|
+
"description": "Details of a deployment branch policy.",
|
|
224735
|
+
"type": "object",
|
|
224736
|
+
"properties": {
|
|
224737
|
+
"id": {
|
|
224738
|
+
"description": "The unique identifier of the branch policy.",
|
|
224739
|
+
"type": "integer",
|
|
224740
|
+
"example": 361471
|
|
224741
|
+
},
|
|
224742
|
+
"node_id": {
|
|
224743
|
+
"type": "string",
|
|
224744
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
224745
|
+
},
|
|
224746
|
+
"name": {
|
|
224747
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
224748
|
+
"type": "string",
|
|
224749
|
+
"example": "release/*"
|
|
224750
|
+
}
|
|
224751
|
+
}
|
|
224752
|
+
}
|
|
224753
|
+
}
|
|
224754
|
+
},
|
|
224755
|
+
"required": [
|
|
224756
|
+
"total_count",
|
|
224757
|
+
"branch_policies"
|
|
224758
|
+
]
|
|
224759
|
+
},
|
|
224760
|
+
"examples": {
|
|
224761
|
+
"default": {
|
|
224762
|
+
"value": {
|
|
224763
|
+
"total_count": 2,
|
|
224764
|
+
"branch_policies": [
|
|
224765
|
+
{
|
|
224766
|
+
"id": 361471,
|
|
224767
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
|
|
224768
|
+
"name": "release/*"
|
|
224769
|
+
},
|
|
224770
|
+
{
|
|
224771
|
+
"id": 361472,
|
|
224772
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
|
|
224773
|
+
"name": "main"
|
|
224774
|
+
}
|
|
224775
|
+
]
|
|
224776
|
+
}
|
|
224777
|
+
}
|
|
224778
|
+
}
|
|
224779
|
+
}
|
|
224780
|
+
}
|
|
224781
|
+
}
|
|
224782
|
+
},
|
|
224783
|
+
"x-github": {
|
|
224784
|
+
"githubCloudOnly": false,
|
|
224785
|
+
"enabledForGitHubApps": true,
|
|
224786
|
+
"category": "deployments",
|
|
224787
|
+
"subcategory": "branch-policies"
|
|
224788
|
+
},
|
|
224789
|
+
"x-octokit": {}
|
|
224790
|
+
},
|
|
224791
|
+
"post": {
|
|
224792
|
+
"summary": "Create a deployment branch policy",
|
|
224793
|
+
"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.",
|
|
224794
|
+
"tags": [
|
|
224795
|
+
"repos"
|
|
224796
|
+
],
|
|
224797
|
+
"operationId": "repos/create-deployment-branch-policy",
|
|
224798
|
+
"externalDocs": {
|
|
224799
|
+
"description": "API method documentation",
|
|
224800
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#create-deployment-branch-policy"
|
|
224801
|
+
},
|
|
224802
|
+
"parameters": [
|
|
224803
|
+
{
|
|
224804
|
+
"name": "owner",
|
|
224805
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
224806
|
+
"in": "path",
|
|
224807
|
+
"required": true,
|
|
224808
|
+
"schema": {
|
|
224809
|
+
"type": "string"
|
|
224810
|
+
}
|
|
224811
|
+
},
|
|
224812
|
+
{
|
|
224813
|
+
"name": "repo",
|
|
224814
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
224815
|
+
"in": "path",
|
|
224816
|
+
"required": true,
|
|
224817
|
+
"schema": {
|
|
224818
|
+
"type": "string"
|
|
224819
|
+
}
|
|
224820
|
+
},
|
|
224821
|
+
{
|
|
224822
|
+
"name": "environment_name",
|
|
224823
|
+
"in": "path",
|
|
224824
|
+
"required": true,
|
|
224825
|
+
"description": "The name of the environment.",
|
|
224826
|
+
"schema": {
|
|
224827
|
+
"type": "string"
|
|
224828
|
+
}
|
|
224829
|
+
}
|
|
224830
|
+
],
|
|
224831
|
+
"requestBody": {
|
|
224832
|
+
"required": true,
|
|
224833
|
+
"content": {
|
|
224834
|
+
"application/json": {
|
|
224835
|
+
"schema": {
|
|
224836
|
+
"title": "Deployment branch policy name pattern",
|
|
224837
|
+
"type": "object",
|
|
224838
|
+
"properties": {
|
|
224839
|
+
"name": {
|
|
224840
|
+
"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).",
|
|
224841
|
+
"type": "string",
|
|
224842
|
+
"example": "release/*"
|
|
224843
|
+
}
|
|
224844
|
+
},
|
|
224845
|
+
"required": [
|
|
224846
|
+
"name"
|
|
224847
|
+
]
|
|
224848
|
+
},
|
|
224849
|
+
"examples": {
|
|
224850
|
+
"example-wildcard": {
|
|
224851
|
+
"summary": "Example of a wildcard name pattern",
|
|
224852
|
+
"value": {
|
|
224853
|
+
"name": "release/*"
|
|
224854
|
+
}
|
|
224855
|
+
},
|
|
224856
|
+
"example-single-branch": {
|
|
224857
|
+
"summary": "Example of a single branch name pattern",
|
|
224858
|
+
"value": {
|
|
224859
|
+
"name": "main"
|
|
224860
|
+
}
|
|
224861
|
+
}
|
|
224862
|
+
}
|
|
224863
|
+
}
|
|
224864
|
+
}
|
|
224865
|
+
},
|
|
224866
|
+
"responses": {
|
|
224867
|
+
"200": {
|
|
224868
|
+
"description": "Response",
|
|
224869
|
+
"content": {
|
|
224870
|
+
"application/json": {
|
|
224871
|
+
"schema": {
|
|
224872
|
+
"title": "Deployment branch policy",
|
|
224873
|
+
"description": "Details of a deployment branch policy.",
|
|
224874
|
+
"type": "object",
|
|
224875
|
+
"properties": {
|
|
224876
|
+
"id": {
|
|
224877
|
+
"description": "The unique identifier of the branch policy.",
|
|
224878
|
+
"type": "integer",
|
|
224879
|
+
"example": 361471
|
|
224880
|
+
},
|
|
224881
|
+
"node_id": {
|
|
224882
|
+
"type": "string",
|
|
224883
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
224884
|
+
},
|
|
224885
|
+
"name": {
|
|
224886
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
224887
|
+
"type": "string",
|
|
224888
|
+
"example": "release/*"
|
|
224889
|
+
}
|
|
224890
|
+
}
|
|
224891
|
+
},
|
|
224892
|
+
"examples": {
|
|
224893
|
+
"example-wildcard": {
|
|
224894
|
+
"value": {
|
|
224895
|
+
"id": 364662,
|
|
224896
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
224897
|
+
"name": "release/*"
|
|
224898
|
+
}
|
|
224899
|
+
},
|
|
224900
|
+
"example-single-branch": {
|
|
224901
|
+
"value": {
|
|
224902
|
+
"id": 364663,
|
|
224903
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
224904
|
+
"name": "main"
|
|
224905
|
+
}
|
|
224906
|
+
}
|
|
224907
|
+
}
|
|
224908
|
+
}
|
|
224909
|
+
}
|
|
224910
|
+
},
|
|
224911
|
+
"303": {
|
|
224912
|
+
"description": "Response if the same branch name pattern already exists"
|
|
224913
|
+
},
|
|
224914
|
+
"404": {
|
|
224915
|
+
"description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
|
|
224916
|
+
}
|
|
224917
|
+
},
|
|
224918
|
+
"x-github": {
|
|
224919
|
+
"githubCloudOnly": false,
|
|
224920
|
+
"enabledForGitHubApps": true,
|
|
224921
|
+
"category": "deployments",
|
|
224922
|
+
"subcategory": "branch-policies"
|
|
224923
|
+
},
|
|
224924
|
+
"x-octokit": {}
|
|
224925
|
+
}
|
|
224926
|
+
},
|
|
224927
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
224928
|
+
"get": {
|
|
224929
|
+
"summary": "Get a deployment branch policy",
|
|
224930
|
+
"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.",
|
|
224931
|
+
"tags": [
|
|
224932
|
+
"repos"
|
|
224933
|
+
],
|
|
224934
|
+
"operationId": "repos/get-deployment-branch-policy",
|
|
224935
|
+
"externalDocs": {
|
|
224936
|
+
"description": "API method documentation",
|
|
224937
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#get-deployment-branch-policy"
|
|
224938
|
+
},
|
|
224939
|
+
"parameters": [
|
|
224940
|
+
{
|
|
224941
|
+
"name": "owner",
|
|
224942
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
224943
|
+
"in": "path",
|
|
224944
|
+
"required": true,
|
|
224945
|
+
"schema": {
|
|
224946
|
+
"type": "string"
|
|
224947
|
+
}
|
|
224948
|
+
},
|
|
224949
|
+
{
|
|
224950
|
+
"name": "repo",
|
|
224951
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
224952
|
+
"in": "path",
|
|
224953
|
+
"required": true,
|
|
224954
|
+
"schema": {
|
|
224955
|
+
"type": "string"
|
|
224956
|
+
}
|
|
224957
|
+
},
|
|
224958
|
+
{
|
|
224959
|
+
"name": "environment_name",
|
|
224960
|
+
"in": "path",
|
|
224961
|
+
"required": true,
|
|
224962
|
+
"description": "The name of the environment.",
|
|
224963
|
+
"schema": {
|
|
224964
|
+
"type": "string"
|
|
224965
|
+
}
|
|
224966
|
+
},
|
|
224967
|
+
{
|
|
224968
|
+
"name": "branch_policy_id",
|
|
224969
|
+
"in": "path",
|
|
224970
|
+
"required": true,
|
|
224971
|
+
"description": "The unique identifier of the branch policy.",
|
|
224972
|
+
"schema": {
|
|
224973
|
+
"type": "integer"
|
|
224974
|
+
}
|
|
224975
|
+
}
|
|
224976
|
+
],
|
|
224977
|
+
"responses": {
|
|
224978
|
+
"200": {
|
|
224979
|
+
"description": "Response",
|
|
224980
|
+
"content": {
|
|
224981
|
+
"application/json": {
|
|
224982
|
+
"schema": {
|
|
224983
|
+
"title": "Deployment branch policy",
|
|
224984
|
+
"description": "Details of a deployment branch policy.",
|
|
224985
|
+
"type": "object",
|
|
224986
|
+
"properties": {
|
|
224987
|
+
"id": {
|
|
224988
|
+
"description": "The unique identifier of the branch policy.",
|
|
224989
|
+
"type": "integer",
|
|
224990
|
+
"example": 361471
|
|
224991
|
+
},
|
|
224992
|
+
"node_id": {
|
|
224993
|
+
"type": "string",
|
|
224994
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
224995
|
+
},
|
|
224996
|
+
"name": {
|
|
224997
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
224998
|
+
"type": "string",
|
|
224999
|
+
"example": "release/*"
|
|
225000
|
+
}
|
|
225001
|
+
}
|
|
225002
|
+
},
|
|
225003
|
+
"examples": {
|
|
225004
|
+
"default": {
|
|
225005
|
+
"value": {
|
|
225006
|
+
"id": 364662,
|
|
225007
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
225008
|
+
"name": "release/*"
|
|
225009
|
+
}
|
|
225010
|
+
}
|
|
225011
|
+
}
|
|
225012
|
+
}
|
|
225013
|
+
}
|
|
225014
|
+
}
|
|
225015
|
+
},
|
|
225016
|
+
"x-github": {
|
|
225017
|
+
"githubCloudOnly": false,
|
|
225018
|
+
"enabledForGitHubApps": true,
|
|
225019
|
+
"category": "deployments",
|
|
225020
|
+
"subcategory": "branch-policies"
|
|
225021
|
+
},
|
|
225022
|
+
"x-octokit": {}
|
|
225023
|
+
},
|
|
225024
|
+
"put": {
|
|
225025
|
+
"summary": "Update a deployment branch policy",
|
|
225026
|
+
"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.",
|
|
225027
|
+
"tags": [
|
|
225028
|
+
"repos"
|
|
225029
|
+
],
|
|
225030
|
+
"operationId": "repos/update-deployment-branch-policy",
|
|
225031
|
+
"externalDocs": {
|
|
225032
|
+
"description": "API method documentation",
|
|
225033
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#update-deployment-branch-policy"
|
|
225034
|
+
},
|
|
225035
|
+
"parameters": [
|
|
225036
|
+
{
|
|
225037
|
+
"name": "owner",
|
|
225038
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
225039
|
+
"in": "path",
|
|
225040
|
+
"required": true,
|
|
225041
|
+
"schema": {
|
|
225042
|
+
"type": "string"
|
|
225043
|
+
}
|
|
225044
|
+
},
|
|
225045
|
+
{
|
|
225046
|
+
"name": "repo",
|
|
225047
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
225048
|
+
"in": "path",
|
|
225049
|
+
"required": true,
|
|
225050
|
+
"schema": {
|
|
225051
|
+
"type": "string"
|
|
225052
|
+
}
|
|
225053
|
+
},
|
|
225054
|
+
{
|
|
225055
|
+
"name": "environment_name",
|
|
225056
|
+
"in": "path",
|
|
225057
|
+
"required": true,
|
|
225058
|
+
"description": "The name of the environment.",
|
|
225059
|
+
"schema": {
|
|
225060
|
+
"type": "string"
|
|
225061
|
+
}
|
|
225062
|
+
},
|
|
225063
|
+
{
|
|
225064
|
+
"name": "branch_policy_id",
|
|
225065
|
+
"in": "path",
|
|
225066
|
+
"required": true,
|
|
225067
|
+
"description": "The unique identifier of the branch policy.",
|
|
225068
|
+
"schema": {
|
|
225069
|
+
"type": "integer"
|
|
225070
|
+
}
|
|
225071
|
+
}
|
|
225072
|
+
],
|
|
225073
|
+
"requestBody": {
|
|
225074
|
+
"required": true,
|
|
225075
|
+
"content": {
|
|
225076
|
+
"application/json": {
|
|
225077
|
+
"schema": {
|
|
225078
|
+
"title": "Deployment branch policy name pattern",
|
|
225079
|
+
"type": "object",
|
|
225080
|
+
"properties": {
|
|
225081
|
+
"name": {
|
|
225082
|
+
"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).",
|
|
225083
|
+
"type": "string",
|
|
225084
|
+
"example": "release/*"
|
|
225085
|
+
}
|
|
225086
|
+
},
|
|
225087
|
+
"required": [
|
|
225088
|
+
"name"
|
|
225089
|
+
]
|
|
225090
|
+
},
|
|
225091
|
+
"examples": {
|
|
225092
|
+
"default": {
|
|
225093
|
+
"value": {
|
|
225094
|
+
"name": "release/*"
|
|
225095
|
+
}
|
|
225096
|
+
}
|
|
225097
|
+
}
|
|
225098
|
+
}
|
|
225099
|
+
}
|
|
225100
|
+
},
|
|
225101
|
+
"responses": {
|
|
225102
|
+
"200": {
|
|
225103
|
+
"description": "Response",
|
|
225104
|
+
"content": {
|
|
225105
|
+
"application/json": {
|
|
225106
|
+
"schema": {
|
|
225107
|
+
"title": "Deployment branch policy",
|
|
225108
|
+
"description": "Details of a deployment branch policy.",
|
|
225109
|
+
"type": "object",
|
|
225110
|
+
"properties": {
|
|
225111
|
+
"id": {
|
|
225112
|
+
"description": "The unique identifier of the branch policy.",
|
|
225113
|
+
"type": "integer",
|
|
225114
|
+
"example": 361471
|
|
225115
|
+
},
|
|
225116
|
+
"node_id": {
|
|
225117
|
+
"type": "string",
|
|
225118
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
225119
|
+
},
|
|
225120
|
+
"name": {
|
|
225121
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
225122
|
+
"type": "string",
|
|
225123
|
+
"example": "release/*"
|
|
225124
|
+
}
|
|
225125
|
+
}
|
|
225126
|
+
},
|
|
225127
|
+
"examples": {
|
|
225128
|
+
"default": {
|
|
225129
|
+
"value": {
|
|
225130
|
+
"id": 364662,
|
|
225131
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
225132
|
+
"name": "release/*"
|
|
225133
|
+
}
|
|
225134
|
+
}
|
|
225135
|
+
}
|
|
225136
|
+
}
|
|
225137
|
+
}
|
|
225138
|
+
}
|
|
225139
|
+
},
|
|
225140
|
+
"x-github": {
|
|
225141
|
+
"githubCloudOnly": false,
|
|
225142
|
+
"enabledForGitHubApps": true,
|
|
225143
|
+
"category": "deployments",
|
|
225144
|
+
"subcategory": "branch-policies"
|
|
225145
|
+
},
|
|
225146
|
+
"x-octokit": {}
|
|
225147
|
+
},
|
|
225148
|
+
"delete": {
|
|
225149
|
+
"summary": "Delete a deployment branch policy",
|
|
225150
|
+
"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.",
|
|
225151
|
+
"tags": [
|
|
225152
|
+
"repos"
|
|
225153
|
+
],
|
|
225154
|
+
"operationId": "repos/delete-deployment-branch-policy",
|
|
225155
|
+
"externalDocs": {
|
|
225156
|
+
"description": "API method documentation",
|
|
225157
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/deployments/branch-policies#delete-deployment-branch-policy"
|
|
225158
|
+
},
|
|
225159
|
+
"parameters": [
|
|
225160
|
+
{
|
|
225161
|
+
"name": "owner",
|
|
225162
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
225163
|
+
"in": "path",
|
|
225164
|
+
"required": true,
|
|
225165
|
+
"schema": {
|
|
225166
|
+
"type": "string"
|
|
225167
|
+
}
|
|
225168
|
+
},
|
|
225169
|
+
{
|
|
225170
|
+
"name": "repo",
|
|
225171
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
225172
|
+
"in": "path",
|
|
225173
|
+
"required": true,
|
|
225174
|
+
"schema": {
|
|
225175
|
+
"type": "string"
|
|
225176
|
+
}
|
|
225177
|
+
},
|
|
225178
|
+
{
|
|
225179
|
+
"name": "environment_name",
|
|
225180
|
+
"in": "path",
|
|
225181
|
+
"required": true,
|
|
225182
|
+
"description": "The name of the environment.",
|
|
225183
|
+
"schema": {
|
|
225184
|
+
"type": "string"
|
|
225185
|
+
}
|
|
225186
|
+
},
|
|
225187
|
+
{
|
|
225188
|
+
"name": "branch_policy_id",
|
|
225189
|
+
"in": "path",
|
|
225190
|
+
"required": true,
|
|
225191
|
+
"description": "The unique identifier of the branch policy.",
|
|
225192
|
+
"schema": {
|
|
225193
|
+
"type": "integer"
|
|
225194
|
+
}
|
|
225195
|
+
}
|
|
225196
|
+
],
|
|
225197
|
+
"responses": {
|
|
225198
|
+
"204": {
|
|
225199
|
+
"description": "Response"
|
|
225200
|
+
}
|
|
225201
|
+
},
|
|
225202
|
+
"x-github": {
|
|
225203
|
+
"githubCloudOnly": false,
|
|
225204
|
+
"enabledForGitHubApps": true,
|
|
225205
|
+
"category": "deployments",
|
|
225206
|
+
"subcategory": "branch-policies"
|
|
225207
|
+
},
|
|
225208
|
+
"x-octokit": {}
|
|
225209
|
+
}
|
|
225210
|
+
},
|
|
224480
225211
|
"/repos/{owner}/{repo}/events": {
|
|
224481
225212
|
"get": {
|
|
224482
225213
|
"summary": "List repository events",
|
|
@@ -240995,6 +241726,14 @@
|
|
|
240995
241726
|
"write"
|
|
240996
241727
|
]
|
|
240997
241728
|
},
|
|
241729
|
+
"organization_custom_roles": {
|
|
241730
|
+
"type": "string",
|
|
241731
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
241732
|
+
"enum": [
|
|
241733
|
+
"read",
|
|
241734
|
+
"write"
|
|
241735
|
+
]
|
|
241736
|
+
},
|
|
240998
241737
|
"deployments": {
|
|
240999
241738
|
"type": "string",
|
|
241000
241739
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -340375,287 +341114,293 @@
|
|
|
340375
341114
|
"type": "object",
|
|
340376
341115
|
"properties": {
|
|
340377
341116
|
"type": {
|
|
340378
|
-
"type": "string"
|
|
340379
|
-
},
|
|
340380
|
-
"encoding": {
|
|
340381
|
-
"type": "string"
|
|
340382
|
-
},
|
|
340383
|
-
"size": {
|
|
340384
|
-
"type": "integer"
|
|
340385
|
-
},
|
|
340386
|
-
"name": {
|
|
340387
|
-
"type": "string"
|
|
340388
|
-
},
|
|
340389
|
-
"path": {
|
|
340390
|
-
"type": "string"
|
|
340391
|
-
},
|
|
340392
|
-
"content": {
|
|
340393
|
-
"type": "string"
|
|
340394
|
-
},
|
|
340395
|
-
"sha": {
|
|
340396
|
-
"type": "string"
|
|
340397
|
-
},
|
|
340398
|
-
"url": {
|
|
340399
341117
|
"type": "string",
|
|
340400
|
-
"
|
|
340401
|
-
|
|
340402
|
-
|
|
340403
|
-
|
|
340404
|
-
|
|
340405
|
-
"
|
|
340406
|
-
},
|
|
340407
|
-
"
|
|
340408
|
-
"type": "
|
|
340409
|
-
|
|
340410
|
-
|
|
340411
|
-
|
|
340412
|
-
|
|
340413
|
-
|
|
340414
|
-
"
|
|
340415
|
-
|
|
340416
|
-
|
|
340417
|
-
|
|
340418
|
-
|
|
340419
|
-
|
|
340420
|
-
|
|
340421
|
-
|
|
340422
|
-
|
|
340423
|
-
|
|
340424
|
-
|
|
340425
|
-
|
|
340426
|
-
|
|
340427
|
-
|
|
340428
|
-
|
|
340429
|
-
|
|
340430
|
-
|
|
340431
|
-
|
|
340432
|
-
|
|
340433
|
-
|
|
340434
|
-
|
|
340435
|
-
|
|
340436
|
-
|
|
340437
|
-
|
|
340438
|
-
|
|
341118
|
+
"enum": [
|
|
341119
|
+
"file"
|
|
341120
|
+
]
|
|
341121
|
+
},
|
|
341122
|
+
"encoding": {
|
|
341123
|
+
"type": "string"
|
|
341124
|
+
},
|
|
341125
|
+
"size": {
|
|
341126
|
+
"type": "integer"
|
|
341127
|
+
},
|
|
341128
|
+
"name": {
|
|
341129
|
+
"type": "string"
|
|
341130
|
+
},
|
|
341131
|
+
"path": {
|
|
341132
|
+
"type": "string"
|
|
341133
|
+
},
|
|
341134
|
+
"content": {
|
|
341135
|
+
"type": "string"
|
|
341136
|
+
},
|
|
341137
|
+
"sha": {
|
|
341138
|
+
"type": "string"
|
|
341139
|
+
},
|
|
341140
|
+
"url": {
|
|
341141
|
+
"type": "string",
|
|
341142
|
+
"format": "uri"
|
|
341143
|
+
},
|
|
341144
|
+
"git_url": {
|
|
341145
|
+
"type": "string",
|
|
341146
|
+
"format": "uri",
|
|
341147
|
+
"nullable": true
|
|
341148
|
+
},
|
|
341149
|
+
"html_url": {
|
|
341150
|
+
"type": "string",
|
|
341151
|
+
"format": "uri",
|
|
341152
|
+
"nullable": true
|
|
341153
|
+
},
|
|
341154
|
+
"download_url": {
|
|
341155
|
+
"type": "string",
|
|
341156
|
+
"format": "uri",
|
|
341157
|
+
"nullable": true
|
|
341158
|
+
},
|
|
341159
|
+
"_links": {
|
|
341160
|
+
"type": "object",
|
|
341161
|
+
"properties": {
|
|
341162
|
+
"git": {
|
|
341163
|
+
"type": "string",
|
|
341164
|
+
"format": "uri",
|
|
341165
|
+
"nullable": true
|
|
341166
|
+
},
|
|
341167
|
+
"html": {
|
|
341168
|
+
"type": "string",
|
|
341169
|
+
"format": "uri",
|
|
341170
|
+
"nullable": true
|
|
341171
|
+
},
|
|
341172
|
+
"self": {
|
|
341173
|
+
"type": "string",
|
|
341174
|
+
"format": "uri"
|
|
341175
|
+
}
|
|
341176
|
+
},
|
|
341177
|
+
"required": [
|
|
341178
|
+
"git",
|
|
341179
|
+
"html",
|
|
341180
|
+
"self"
|
|
341181
|
+
]
|
|
341182
|
+
},
|
|
341183
|
+
"target": {
|
|
341184
|
+
"type": "string",
|
|
341185
|
+
"example": "\"actual/actual.md\""
|
|
341186
|
+
},
|
|
341187
|
+
"submodule_git_url": {
|
|
341188
|
+
"type": "string",
|
|
341189
|
+
"example": "\"git://example.com/defunkt/dotjs.git\""
|
|
341190
|
+
}
|
|
341191
|
+
},
|
|
341192
|
+
"required": [
|
|
341193
|
+
"_links",
|
|
341194
|
+
"git_url",
|
|
341195
|
+
"html_url",
|
|
341196
|
+
"download_url",
|
|
341197
|
+
"name",
|
|
341198
|
+
"path",
|
|
341199
|
+
"sha",
|
|
341200
|
+
"size",
|
|
341201
|
+
"type",
|
|
341202
|
+
"url",
|
|
341203
|
+
"content",
|
|
341204
|
+
"encoding"
|
|
341205
|
+
]
|
|
341206
|
+
},
|
|
341207
|
+
"examples": {
|
|
341208
|
+
"default": {
|
|
341209
|
+
"value": {
|
|
341210
|
+
"type": "file",
|
|
341211
|
+
"encoding": "base64",
|
|
341212
|
+
"size": 5362,
|
|
341213
|
+
"name": "README.md",
|
|
341214
|
+
"path": "README.md",
|
|
341215
|
+
"content": "encoded content ...",
|
|
341216
|
+
"sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
341217
|
+
"url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
341218
|
+
"git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
341219
|
+
"html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
|
|
341220
|
+
"download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
|
|
341221
|
+
"_links": {
|
|
341222
|
+
"git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
341223
|
+
"self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
341224
|
+
"html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
|
|
341225
|
+
}
|
|
341226
|
+
}
|
|
341227
|
+
}
|
|
341228
|
+
}
|
|
341229
|
+
}
|
|
341230
|
+
}
|
|
341231
|
+
},
|
|
341232
|
+
"404": {
|
|
341233
|
+
"description": "Resource not found",
|
|
341234
|
+
"content": {
|
|
341235
|
+
"application/json": {
|
|
341236
|
+
"schema": {
|
|
341237
|
+
"title": "Basic Error",
|
|
341238
|
+
"description": "Basic Error",
|
|
341239
|
+
"type": "object",
|
|
341240
|
+
"properties": {
|
|
341241
|
+
"message": {
|
|
341242
|
+
"type": "string"
|
|
341243
|
+
},
|
|
341244
|
+
"documentation_url": {
|
|
341245
|
+
"type": "string"
|
|
341246
|
+
},
|
|
341247
|
+
"url": {
|
|
341248
|
+
"type": "string"
|
|
341249
|
+
},
|
|
341250
|
+
"status": {
|
|
341251
|
+
"type": "string"
|
|
341252
|
+
}
|
|
341253
|
+
}
|
|
341254
|
+
}
|
|
341255
|
+
}
|
|
341256
|
+
}
|
|
341257
|
+
},
|
|
341258
|
+
"422": {
|
|
341259
|
+
"description": "Validation failed",
|
|
341260
|
+
"content": {
|
|
341261
|
+
"application/json": {
|
|
341262
|
+
"schema": {
|
|
341263
|
+
"title": "Validation Error",
|
|
341264
|
+
"description": "Validation Error",
|
|
341265
|
+
"type": "object",
|
|
341266
|
+
"required": [
|
|
341267
|
+
"message",
|
|
341268
|
+
"documentation_url"
|
|
341269
|
+
],
|
|
341270
|
+
"properties": {
|
|
341271
|
+
"message": {
|
|
341272
|
+
"type": "string"
|
|
341273
|
+
},
|
|
341274
|
+
"documentation_url": {
|
|
341275
|
+
"type": "string"
|
|
341276
|
+
},
|
|
341277
|
+
"errors": {
|
|
341278
|
+
"type": "array",
|
|
341279
|
+
"items": {
|
|
341280
|
+
"type": "object",
|
|
341281
|
+
"required": [
|
|
341282
|
+
"code"
|
|
341283
|
+
],
|
|
341284
|
+
"properties": {
|
|
341285
|
+
"resource": {
|
|
341286
|
+
"type": "string"
|
|
341287
|
+
},
|
|
341288
|
+
"field": {
|
|
341289
|
+
"type": "string"
|
|
341290
|
+
},
|
|
341291
|
+
"message": {
|
|
341292
|
+
"type": "string"
|
|
341293
|
+
},
|
|
341294
|
+
"code": {
|
|
341295
|
+
"type": "string"
|
|
341296
|
+
},
|
|
341297
|
+
"index": {
|
|
341298
|
+
"type": "integer"
|
|
341299
|
+
},
|
|
341300
|
+
"value": {
|
|
341301
|
+
"oneOf": [
|
|
341302
|
+
{
|
|
341303
|
+
"type": "string",
|
|
341304
|
+
"nullable": true
|
|
341305
|
+
},
|
|
341306
|
+
{
|
|
341307
|
+
"type": "integer",
|
|
341308
|
+
"nullable": true
|
|
341309
|
+
},
|
|
341310
|
+
{
|
|
341311
|
+
"type": "array",
|
|
341312
|
+
"nullable": true,
|
|
341313
|
+
"items": {
|
|
341314
|
+
"type": "string"
|
|
341315
|
+
}
|
|
341316
|
+
}
|
|
341317
|
+
]
|
|
341318
|
+
}
|
|
341319
|
+
}
|
|
341320
|
+
}
|
|
341321
|
+
}
|
|
341322
|
+
}
|
|
341323
|
+
}
|
|
341324
|
+
}
|
|
341325
|
+
}
|
|
341326
|
+
}
|
|
341327
|
+
},
|
|
341328
|
+
"x-github": {
|
|
341329
|
+
"githubCloudOnly": false,
|
|
341330
|
+
"enabledForGitHubApps": true,
|
|
341331
|
+
"category": "repos",
|
|
341332
|
+
"subcategory": "contents"
|
|
341333
|
+
},
|
|
341334
|
+
"x-octokit": {}
|
|
341335
|
+
}
|
|
341336
|
+
},
|
|
341337
|
+
"/repos/{owner}/{repo}/readme/{dir}": {
|
|
341338
|
+
"get": {
|
|
341339
|
+
"summary": "Get a repository README for a directory",
|
|
341340
|
+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
|
|
341341
|
+
"tags": [
|
|
341342
|
+
"repos"
|
|
341343
|
+
],
|
|
341344
|
+
"operationId": "repos/get-readme-in-directory",
|
|
341345
|
+
"externalDocs": {
|
|
341346
|
+
"description": "API method documentation",
|
|
341347
|
+
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-repository-directory-readme"
|
|
341348
|
+
},
|
|
341349
|
+
"parameters": [
|
|
341350
|
+
{
|
|
341351
|
+
"name": "owner",
|
|
341352
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
341353
|
+
"in": "path",
|
|
341354
|
+
"required": true,
|
|
341355
|
+
"schema": {
|
|
341356
|
+
"type": "string"
|
|
341357
|
+
}
|
|
341358
|
+
},
|
|
341359
|
+
{
|
|
341360
|
+
"name": "repo",
|
|
341361
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
341362
|
+
"in": "path",
|
|
341363
|
+
"required": true,
|
|
341364
|
+
"schema": {
|
|
341365
|
+
"type": "string"
|
|
341366
|
+
}
|
|
341367
|
+
},
|
|
341368
|
+
{
|
|
341369
|
+
"name": "dir",
|
|
341370
|
+
"description": "The alternate path to look for a README file",
|
|
341371
|
+
"in": "path",
|
|
341372
|
+
"required": true,
|
|
341373
|
+
"schema": {
|
|
341374
|
+
"type": "string"
|
|
341375
|
+
},
|
|
341376
|
+
"x-multi-segment": true
|
|
341377
|
+
},
|
|
341378
|
+
{
|
|
341379
|
+
"name": "ref",
|
|
341380
|
+
"description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
|
|
341381
|
+
"in": "query",
|
|
341382
|
+
"required": false,
|
|
341383
|
+
"schema": {
|
|
341384
|
+
"type": "string"
|
|
341385
|
+
}
|
|
341386
|
+
}
|
|
341387
|
+
],
|
|
341388
|
+
"responses": {
|
|
341389
|
+
"200": {
|
|
341390
|
+
"description": "Response",
|
|
341391
|
+
"content": {
|
|
341392
|
+
"application/json": {
|
|
341393
|
+
"schema": {
|
|
341394
|
+
"title": "Content File",
|
|
341395
|
+
"description": "Content File",
|
|
341396
|
+
"type": "object",
|
|
341397
|
+
"properties": {
|
|
341398
|
+
"type": {
|
|
341399
|
+
"type": "string",
|
|
341400
|
+
"enum": [
|
|
341401
|
+
"file"
|
|
340439
341402
|
]
|
|
340440
341403
|
},
|
|
340441
|
-
"target": {
|
|
340442
|
-
"type": "string",
|
|
340443
|
-
"example": "\"actual/actual.md\""
|
|
340444
|
-
},
|
|
340445
|
-
"submodule_git_url": {
|
|
340446
|
-
"type": "string",
|
|
340447
|
-
"example": "\"git://example.com/defunkt/dotjs.git\""
|
|
340448
|
-
}
|
|
340449
|
-
},
|
|
340450
|
-
"required": [
|
|
340451
|
-
"_links",
|
|
340452
|
-
"git_url",
|
|
340453
|
-
"html_url",
|
|
340454
|
-
"download_url",
|
|
340455
|
-
"name",
|
|
340456
|
-
"path",
|
|
340457
|
-
"sha",
|
|
340458
|
-
"size",
|
|
340459
|
-
"type",
|
|
340460
|
-
"url",
|
|
340461
|
-
"content",
|
|
340462
|
-
"encoding"
|
|
340463
|
-
]
|
|
340464
|
-
},
|
|
340465
|
-
"examples": {
|
|
340466
|
-
"default": {
|
|
340467
|
-
"value": {
|
|
340468
|
-
"type": "file",
|
|
340469
|
-
"encoding": "base64",
|
|
340470
|
-
"size": 5362,
|
|
340471
|
-
"name": "README.md",
|
|
340472
|
-
"path": "README.md",
|
|
340473
|
-
"content": "encoded content ...",
|
|
340474
|
-
"sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
340475
|
-
"url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
340476
|
-
"git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
340477
|
-
"html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
|
|
340478
|
-
"download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
|
|
340479
|
-
"_links": {
|
|
340480
|
-
"git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
340481
|
-
"self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
340482
|
-
"html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
|
|
340483
|
-
}
|
|
340484
|
-
}
|
|
340485
|
-
}
|
|
340486
|
-
}
|
|
340487
|
-
}
|
|
340488
|
-
}
|
|
340489
|
-
},
|
|
340490
|
-
"404": {
|
|
340491
|
-
"description": "Resource not found",
|
|
340492
|
-
"content": {
|
|
340493
|
-
"application/json": {
|
|
340494
|
-
"schema": {
|
|
340495
|
-
"title": "Basic Error",
|
|
340496
|
-
"description": "Basic Error",
|
|
340497
|
-
"type": "object",
|
|
340498
|
-
"properties": {
|
|
340499
|
-
"message": {
|
|
340500
|
-
"type": "string"
|
|
340501
|
-
},
|
|
340502
|
-
"documentation_url": {
|
|
340503
|
-
"type": "string"
|
|
340504
|
-
},
|
|
340505
|
-
"url": {
|
|
340506
|
-
"type": "string"
|
|
340507
|
-
},
|
|
340508
|
-
"status": {
|
|
340509
|
-
"type": "string"
|
|
340510
|
-
}
|
|
340511
|
-
}
|
|
340512
|
-
}
|
|
340513
|
-
}
|
|
340514
|
-
}
|
|
340515
|
-
},
|
|
340516
|
-
"422": {
|
|
340517
|
-
"description": "Validation failed",
|
|
340518
|
-
"content": {
|
|
340519
|
-
"application/json": {
|
|
340520
|
-
"schema": {
|
|
340521
|
-
"title": "Validation Error",
|
|
340522
|
-
"description": "Validation Error",
|
|
340523
|
-
"type": "object",
|
|
340524
|
-
"required": [
|
|
340525
|
-
"message",
|
|
340526
|
-
"documentation_url"
|
|
340527
|
-
],
|
|
340528
|
-
"properties": {
|
|
340529
|
-
"message": {
|
|
340530
|
-
"type": "string"
|
|
340531
|
-
},
|
|
340532
|
-
"documentation_url": {
|
|
340533
|
-
"type": "string"
|
|
340534
|
-
},
|
|
340535
|
-
"errors": {
|
|
340536
|
-
"type": "array",
|
|
340537
|
-
"items": {
|
|
340538
|
-
"type": "object",
|
|
340539
|
-
"required": [
|
|
340540
|
-
"code"
|
|
340541
|
-
],
|
|
340542
|
-
"properties": {
|
|
340543
|
-
"resource": {
|
|
340544
|
-
"type": "string"
|
|
340545
|
-
},
|
|
340546
|
-
"field": {
|
|
340547
|
-
"type": "string"
|
|
340548
|
-
},
|
|
340549
|
-
"message": {
|
|
340550
|
-
"type": "string"
|
|
340551
|
-
},
|
|
340552
|
-
"code": {
|
|
340553
|
-
"type": "string"
|
|
340554
|
-
},
|
|
340555
|
-
"index": {
|
|
340556
|
-
"type": "integer"
|
|
340557
|
-
},
|
|
340558
|
-
"value": {
|
|
340559
|
-
"oneOf": [
|
|
340560
|
-
{
|
|
340561
|
-
"type": "string",
|
|
340562
|
-
"nullable": true
|
|
340563
|
-
},
|
|
340564
|
-
{
|
|
340565
|
-
"type": "integer",
|
|
340566
|
-
"nullable": true
|
|
340567
|
-
},
|
|
340568
|
-
{
|
|
340569
|
-
"type": "array",
|
|
340570
|
-
"nullable": true,
|
|
340571
|
-
"items": {
|
|
340572
|
-
"type": "string"
|
|
340573
|
-
}
|
|
340574
|
-
}
|
|
340575
|
-
]
|
|
340576
|
-
}
|
|
340577
|
-
}
|
|
340578
|
-
}
|
|
340579
|
-
}
|
|
340580
|
-
}
|
|
340581
|
-
}
|
|
340582
|
-
}
|
|
340583
|
-
}
|
|
340584
|
-
}
|
|
340585
|
-
},
|
|
340586
|
-
"x-github": {
|
|
340587
|
-
"githubCloudOnly": false,
|
|
340588
|
-
"enabledForGitHubApps": true,
|
|
340589
|
-
"category": "repos",
|
|
340590
|
-
"subcategory": "contents"
|
|
340591
|
-
},
|
|
340592
|
-
"x-octokit": {}
|
|
340593
|
-
}
|
|
340594
|
-
},
|
|
340595
|
-
"/repos/{owner}/{repo}/readme/{dir}": {
|
|
340596
|
-
"get": {
|
|
340597
|
-
"summary": "Get a repository README for a directory",
|
|
340598
|
-
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.6/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
|
|
340599
|
-
"tags": [
|
|
340600
|
-
"repos"
|
|
340601
|
-
],
|
|
340602
|
-
"operationId": "repos/get-readme-in-directory",
|
|
340603
|
-
"externalDocs": {
|
|
340604
|
-
"description": "API method documentation",
|
|
340605
|
-
"url": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#get-a-repository-directory-readme"
|
|
340606
|
-
},
|
|
340607
|
-
"parameters": [
|
|
340608
|
-
{
|
|
340609
|
-
"name": "owner",
|
|
340610
|
-
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
340611
|
-
"in": "path",
|
|
340612
|
-
"required": true,
|
|
340613
|
-
"schema": {
|
|
340614
|
-
"type": "string"
|
|
340615
|
-
}
|
|
340616
|
-
},
|
|
340617
|
-
{
|
|
340618
|
-
"name": "repo",
|
|
340619
|
-
"description": "The name of the repository. The name is not case sensitive.",
|
|
340620
|
-
"in": "path",
|
|
340621
|
-
"required": true,
|
|
340622
|
-
"schema": {
|
|
340623
|
-
"type": "string"
|
|
340624
|
-
}
|
|
340625
|
-
},
|
|
340626
|
-
{
|
|
340627
|
-
"name": "dir",
|
|
340628
|
-
"description": "The alternate path to look for a README file",
|
|
340629
|
-
"in": "path",
|
|
340630
|
-
"required": true,
|
|
340631
|
-
"schema": {
|
|
340632
|
-
"type": "string"
|
|
340633
|
-
},
|
|
340634
|
-
"x-multi-segment": true
|
|
340635
|
-
},
|
|
340636
|
-
{
|
|
340637
|
-
"name": "ref",
|
|
340638
|
-
"description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
|
|
340639
|
-
"in": "query",
|
|
340640
|
-
"required": false,
|
|
340641
|
-
"schema": {
|
|
340642
|
-
"type": "string"
|
|
340643
|
-
}
|
|
340644
|
-
}
|
|
340645
|
-
],
|
|
340646
|
-
"responses": {
|
|
340647
|
-
"200": {
|
|
340648
|
-
"description": "Response",
|
|
340649
|
-
"content": {
|
|
340650
|
-
"application/json": {
|
|
340651
|
-
"schema": {
|
|
340652
|
-
"title": "Content File",
|
|
340653
|
-
"description": "Content File",
|
|
340654
|
-
"type": "object",
|
|
340655
|
-
"properties": {
|
|
340656
|
-
"type": {
|
|
340657
|
-
"type": "string"
|
|
340658
|
-
},
|
|
340659
341404
|
"encoding": {
|
|
340660
341405
|
"type": "string"
|
|
340661
341406
|
},
|
|
@@ -357803,7 +358548,7 @@
|
|
|
357803
358548
|
"name": "environment_name",
|
|
357804
358549
|
"in": "path",
|
|
357805
358550
|
"required": true,
|
|
357806
|
-
"description": "The name of the environment",
|
|
358551
|
+
"description": "The name of the environment.",
|
|
357807
358552
|
"schema": {
|
|
357808
358553
|
"type": "string"
|
|
357809
358554
|
}
|
|
@@ -357938,7 +358683,7 @@
|
|
|
357938
358683
|
"name": "environment_name",
|
|
357939
358684
|
"in": "path",
|
|
357940
358685
|
"required": true,
|
|
357941
|
-
"description": "The name of the environment",
|
|
358686
|
+
"description": "The name of the environment.",
|
|
357942
358687
|
"schema": {
|
|
357943
358688
|
"type": "string"
|
|
357944
358689
|
}
|
|
@@ -358033,7 +358778,7 @@
|
|
|
358033
358778
|
"name": "environment_name",
|
|
358034
358779
|
"in": "path",
|
|
358035
358780
|
"required": true,
|
|
358036
|
-
"description": "The name of the environment",
|
|
358781
|
+
"description": "The name of the environment.",
|
|
358037
358782
|
"schema": {
|
|
358038
358783
|
"type": "string"
|
|
358039
358784
|
}
|
|
@@ -358124,7 +358869,7 @@
|
|
|
358124
358869
|
"name": "environment_name",
|
|
358125
358870
|
"in": "path",
|
|
358126
358871
|
"required": true,
|
|
358127
|
-
"description": "The name of the environment",
|
|
358872
|
+
"description": "The name of the environment.",
|
|
358128
358873
|
"schema": {
|
|
358129
358874
|
"type": "string"
|
|
358130
358875
|
}
|
|
@@ -358229,7 +358974,7 @@
|
|
|
358229
358974
|
"name": "environment_name",
|
|
358230
358975
|
"in": "path",
|
|
358231
358976
|
"required": true,
|
|
358232
|
-
"description": "The name of the environment",
|
|
358977
|
+
"description": "The name of the environment.",
|
|
358233
358978
|
"schema": {
|
|
358234
358979
|
"type": "string"
|
|
358235
358980
|
}
|
|
@@ -385743,6 +386488,14 @@
|
|
|
385743
386488
|
"write"
|
|
385744
386489
|
]
|
|
385745
386490
|
},
|
|
386491
|
+
"organization_custom_roles": {
|
|
386492
|
+
"type": "string",
|
|
386493
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
386494
|
+
"enum": [
|
|
386495
|
+
"read",
|
|
386496
|
+
"write"
|
|
386497
|
+
]
|
|
386498
|
+
},
|
|
385746
386499
|
"deployments": {
|
|
385747
386500
|
"type": "string",
|
|
385748
386501
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -422225,6 +422978,14 @@
|
|
|
422225
422978
|
"write"
|
|
422226
422979
|
]
|
|
422227
422980
|
},
|
|
422981
|
+
"organization_custom_roles": {
|
|
422982
|
+
"type": "string",
|
|
422983
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
422984
|
+
"enum": [
|
|
422985
|
+
"read",
|
|
422986
|
+
"write"
|
|
422987
|
+
]
|
|
422988
|
+
},
|
|
422228
422989
|
"deployments": {
|
|
422229
422990
|
"type": "string",
|
|
422230
422991
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -436089,6 +436850,12 @@
|
|
|
436089
436850
|
"text/plain": {
|
|
436090
436851
|
"schema": {
|
|
436091
436852
|
"type": "string"
|
|
436853
|
+
},
|
|
436854
|
+
"examples": {
|
|
436855
|
+
"default": {
|
|
436856
|
+
"summary": "Example response",
|
|
436857
|
+
"value": "Responsive is better than fast"
|
|
436858
|
+
}
|
|
436092
436859
|
}
|
|
436093
436860
|
}
|
|
436094
436861
|
}
|
|
@@ -438128,6 +438895,50 @@
|
|
|
438128
438895
|
}
|
|
438129
438896
|
}
|
|
438130
438897
|
},
|
|
438898
|
+
"/enterprises/{enterprise}/consumed-licenses": {
|
|
438899
|
+
"get": {
|
|
438900
|
+
"summary": "List enterprise consumed licenses",
|
|
438901
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
|
|
438902
|
+
"tags": [
|
|
438903
|
+
"enterprise-admin"
|
|
438904
|
+
],
|
|
438905
|
+
"operationId": "enterprise-admin/get-consumed-licenses",
|
|
438906
|
+
"externalDocs": {
|
|
438907
|
+
"description": "API method documentation",
|
|
438908
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
|
|
438909
|
+
},
|
|
438910
|
+
"x-octokit": {
|
|
438911
|
+
"api.github.com": "removed"
|
|
438912
|
+
},
|
|
438913
|
+
"responses": {
|
|
438914
|
+
"501": {
|
|
438915
|
+
"description": "Not Implemented"
|
|
438916
|
+
}
|
|
438917
|
+
}
|
|
438918
|
+
}
|
|
438919
|
+
},
|
|
438920
|
+
"/enterprises/{enterprise}/license-sync-status": {
|
|
438921
|
+
"get": {
|
|
438922
|
+
"summary": "Get a license sync status",
|
|
438923
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
|
|
438924
|
+
"tags": [
|
|
438925
|
+
"enterprise-admin"
|
|
438926
|
+
],
|
|
438927
|
+
"operationId": "enterprise-admin/get-license-sync-status",
|
|
438928
|
+
"externalDocs": {
|
|
438929
|
+
"description": "API method documentation",
|
|
438930
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
|
|
438931
|
+
},
|
|
438932
|
+
"x-octokit": {
|
|
438933
|
+
"api.github.com": "removed"
|
|
438934
|
+
},
|
|
438935
|
+
"responses": {
|
|
438936
|
+
"501": {
|
|
438937
|
+
"description": "Not Implemented"
|
|
438938
|
+
}
|
|
438939
|
+
}
|
|
438940
|
+
}
|
|
438941
|
+
},
|
|
438131
438942
|
"/enterprises/{enterprise}/settings/billing/actions": {
|
|
438132
438943
|
"get": {
|
|
438133
438944
|
"summary": "Get GitHub Actions billing for an enterprise",
|