@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": {
|
|
@@ -4087,6 +4087,14 @@
|
|
|
4087
4087
|
"write"
|
|
4088
4088
|
]
|
|
4089
4089
|
},
|
|
4090
|
+
"organization_custom_roles": {
|
|
4091
|
+
"type": "string",
|
|
4092
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
4093
|
+
"enum": [
|
|
4094
|
+
"read",
|
|
4095
|
+
"write"
|
|
4096
|
+
]
|
|
4097
|
+
},
|
|
4090
4098
|
"deployments": {
|
|
4091
4099
|
"type": "string",
|
|
4092
4100
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -5169,6 +5177,14 @@
|
|
|
5169
5177
|
"write"
|
|
5170
5178
|
]
|
|
5171
5179
|
},
|
|
5180
|
+
"organization_custom_roles": {
|
|
5181
|
+
"type": "string",
|
|
5182
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
5183
|
+
"enum": [
|
|
5184
|
+
"read",
|
|
5185
|
+
"write"
|
|
5186
|
+
]
|
|
5187
|
+
},
|
|
5172
5188
|
"deployments": {
|
|
5173
5189
|
"type": "string",
|
|
5174
5190
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -5833,6 +5849,14 @@
|
|
|
5833
5849
|
"write"
|
|
5834
5850
|
]
|
|
5835
5851
|
},
|
|
5852
|
+
"organization_custom_roles": {
|
|
5853
|
+
"type": "string",
|
|
5854
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
5855
|
+
"enum": [
|
|
5856
|
+
"read",
|
|
5857
|
+
"write"
|
|
5858
|
+
]
|
|
5859
|
+
},
|
|
5836
5860
|
"deployments": {
|
|
5837
5861
|
"type": "string",
|
|
5838
5862
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -8402,6 +8426,14 @@
|
|
|
8402
8426
|
"write"
|
|
8403
8427
|
]
|
|
8404
8428
|
},
|
|
8429
|
+
"organization_custom_roles": {
|
|
8430
|
+
"type": "string",
|
|
8431
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
8432
|
+
"enum": [
|
|
8433
|
+
"read",
|
|
8434
|
+
"write"
|
|
8435
|
+
]
|
|
8436
|
+
},
|
|
8405
8437
|
"deployments": {
|
|
8406
8438
|
"type": "string",
|
|
8407
8439
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -9191,6 +9223,14 @@
|
|
|
9191
9223
|
"write"
|
|
9192
9224
|
]
|
|
9193
9225
|
},
|
|
9226
|
+
"organization_custom_roles": {
|
|
9227
|
+
"type": "string",
|
|
9228
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
9229
|
+
"enum": [
|
|
9230
|
+
"read",
|
|
9231
|
+
"write"
|
|
9232
|
+
]
|
|
9233
|
+
},
|
|
9194
9234
|
"deployments": {
|
|
9195
9235
|
"type": "string",
|
|
9196
9236
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -9844,6 +9884,14 @@
|
|
|
9844
9884
|
"write"
|
|
9845
9885
|
]
|
|
9846
9886
|
},
|
|
9887
|
+
"organization_custom_roles": {
|
|
9888
|
+
"type": "string",
|
|
9889
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
9890
|
+
"enum": [
|
|
9891
|
+
"read",
|
|
9892
|
+
"write"
|
|
9893
|
+
]
|
|
9894
|
+
},
|
|
9847
9895
|
"deployments": {
|
|
9848
9896
|
"type": "string",
|
|
9849
9897
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10129,6 +10177,14 @@
|
|
|
10129
10177
|
"write"
|
|
10130
10178
|
]
|
|
10131
10179
|
},
|
|
10180
|
+
"organization_custom_roles": {
|
|
10181
|
+
"type": "string",
|
|
10182
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10183
|
+
"enum": [
|
|
10184
|
+
"read",
|
|
10185
|
+
"write"
|
|
10186
|
+
]
|
|
10187
|
+
},
|
|
10132
10188
|
"deployments": {
|
|
10133
10189
|
"type": "string",
|
|
10134
10190
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -13104,6 +13160,14 @@
|
|
|
13104
13160
|
"write"
|
|
13105
13161
|
]
|
|
13106
13162
|
},
|
|
13163
|
+
"organization_custom_roles": {
|
|
13164
|
+
"type": "string",
|
|
13165
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
13166
|
+
"enum": [
|
|
13167
|
+
"read",
|
|
13168
|
+
"write"
|
|
13169
|
+
]
|
|
13170
|
+
},
|
|
13107
13171
|
"deployments": {
|
|
13108
13172
|
"type": "string",
|
|
13109
13173
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -13947,6 +14011,14 @@
|
|
|
13947
14011
|
"write"
|
|
13948
14012
|
]
|
|
13949
14013
|
},
|
|
14014
|
+
"organization_custom_roles": {
|
|
14015
|
+
"type": "string",
|
|
14016
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
14017
|
+
"enum": [
|
|
14018
|
+
"read",
|
|
14019
|
+
"write"
|
|
14020
|
+
]
|
|
14021
|
+
},
|
|
13950
14022
|
"deployments": {
|
|
13951
14023
|
"type": "string",
|
|
13952
14024
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -14714,6 +14786,14 @@
|
|
|
14714
14786
|
"write"
|
|
14715
14787
|
]
|
|
14716
14788
|
},
|
|
14789
|
+
"organization_custom_roles": {
|
|
14790
|
+
"type": "string",
|
|
14791
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
14792
|
+
"enum": [
|
|
14793
|
+
"read",
|
|
14794
|
+
"write"
|
|
14795
|
+
]
|
|
14796
|
+
},
|
|
14717
14797
|
"deployments": {
|
|
14718
14798
|
"type": "string",
|
|
14719
14799
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -15189,6 +15269,14 @@
|
|
|
15189
15269
|
"write"
|
|
15190
15270
|
]
|
|
15191
15271
|
},
|
|
15272
|
+
"organization_custom_roles": {
|
|
15273
|
+
"type": "string",
|
|
15274
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
15275
|
+
"enum": [
|
|
15276
|
+
"read",
|
|
15277
|
+
"write"
|
|
15278
|
+
]
|
|
15279
|
+
},
|
|
15192
15280
|
"deployments": {
|
|
15193
15281
|
"type": "string",
|
|
15194
15282
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -16486,6 +16574,14 @@
|
|
|
16486
16574
|
"write"
|
|
16487
16575
|
]
|
|
16488
16576
|
},
|
|
16577
|
+
"organization_custom_roles": {
|
|
16578
|
+
"type": "string",
|
|
16579
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
16580
|
+
"enum": [
|
|
16581
|
+
"read",
|
|
16582
|
+
"write"
|
|
16583
|
+
]
|
|
16584
|
+
},
|
|
16489
16585
|
"deployments": {
|
|
16490
16586
|
"type": "string",
|
|
16491
16587
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -17339,6 +17435,14 @@
|
|
|
17339
17435
|
"write"
|
|
17340
17436
|
]
|
|
17341
17437
|
},
|
|
17438
|
+
"organization_custom_roles": {
|
|
17439
|
+
"type": "string",
|
|
17440
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
17441
|
+
"enum": [
|
|
17442
|
+
"read",
|
|
17443
|
+
"write"
|
|
17444
|
+
]
|
|
17445
|
+
},
|
|
17342
17446
|
"deployments": {
|
|
17343
17447
|
"type": "string",
|
|
17344
17448
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -18261,6 +18365,14 @@
|
|
|
18261
18365
|
"write"
|
|
18262
18366
|
]
|
|
18263
18367
|
},
|
|
18368
|
+
"organization_custom_roles": {
|
|
18369
|
+
"type": "string",
|
|
18370
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
18371
|
+
"enum": [
|
|
18372
|
+
"read",
|
|
18373
|
+
"write"
|
|
18374
|
+
]
|
|
18375
|
+
},
|
|
18264
18376
|
"deployments": {
|
|
18265
18377
|
"type": "string",
|
|
18266
18378
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -18933,6 +19045,14 @@
|
|
|
18933
19045
|
"write"
|
|
18934
19046
|
]
|
|
18935
19047
|
},
|
|
19048
|
+
"organization_custom_roles": {
|
|
19049
|
+
"type": "string",
|
|
19050
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
19051
|
+
"enum": [
|
|
19052
|
+
"read",
|
|
19053
|
+
"write"
|
|
19054
|
+
]
|
|
19055
|
+
},
|
|
18936
19056
|
"deployments": {
|
|
18937
19057
|
"type": "string",
|
|
18938
19058
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -19833,6 +19953,14 @@
|
|
|
19833
19953
|
"write"
|
|
19834
19954
|
]
|
|
19835
19955
|
},
|
|
19956
|
+
"organization_custom_roles": {
|
|
19957
|
+
"type": "string",
|
|
19958
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
19959
|
+
"enum": [
|
|
19960
|
+
"read",
|
|
19961
|
+
"write"
|
|
19962
|
+
]
|
|
19963
|
+
},
|
|
19836
19964
|
"deployments": {
|
|
19837
19965
|
"type": "string",
|
|
19838
19966
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -20505,6 +20633,14 @@
|
|
|
20505
20633
|
"write"
|
|
20506
20634
|
]
|
|
20507
20635
|
},
|
|
20636
|
+
"organization_custom_roles": {
|
|
20637
|
+
"type": "string",
|
|
20638
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
20639
|
+
"enum": [
|
|
20640
|
+
"read",
|
|
20641
|
+
"write"
|
|
20642
|
+
]
|
|
20643
|
+
},
|
|
20508
20644
|
"deployments": {
|
|
20509
20645
|
"type": "string",
|
|
20510
20646
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -21283,6 +21419,14 @@
|
|
|
21283
21419
|
"write"
|
|
21284
21420
|
]
|
|
21285
21421
|
},
|
|
21422
|
+
"organization_custom_roles": {
|
|
21423
|
+
"type": "string",
|
|
21424
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
21425
|
+
"enum": [
|
|
21426
|
+
"read",
|
|
21427
|
+
"write"
|
|
21428
|
+
]
|
|
21429
|
+
},
|
|
21286
21430
|
"deployments": {
|
|
21287
21431
|
"type": "string",
|
|
21288
21432
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -22088,6 +22232,14 @@
|
|
|
22088
22232
|
"write"
|
|
22089
22233
|
]
|
|
22090
22234
|
},
|
|
22235
|
+
"organization_custom_roles": {
|
|
22236
|
+
"type": "string",
|
|
22237
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
22238
|
+
"enum": [
|
|
22239
|
+
"read",
|
|
22240
|
+
"write"
|
|
22241
|
+
]
|
|
22242
|
+
},
|
|
22091
22243
|
"deployments": {
|
|
22092
22244
|
"type": "string",
|
|
22093
22245
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -82908,6 +83060,14 @@
|
|
|
82908
83060
|
"write"
|
|
82909
83061
|
]
|
|
82910
83062
|
},
|
|
83063
|
+
"organization_custom_roles": {
|
|
83064
|
+
"type": "string",
|
|
83065
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
83066
|
+
"enum": [
|
|
83067
|
+
"read",
|
|
83068
|
+
"write"
|
|
83069
|
+
]
|
|
83070
|
+
},
|
|
82911
83071
|
"deployments": {
|
|
82912
83072
|
"type": "string",
|
|
82913
83073
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -83711,6 +83871,14 @@
|
|
|
83711
83871
|
"write"
|
|
83712
83872
|
]
|
|
83713
83873
|
},
|
|
83874
|
+
"organization_custom_roles": {
|
|
83875
|
+
"type": "string",
|
|
83876
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
83877
|
+
"enum": [
|
|
83878
|
+
"read",
|
|
83879
|
+
"write"
|
|
83880
|
+
]
|
|
83881
|
+
},
|
|
83714
83882
|
"deployments": {
|
|
83715
83883
|
"type": "string",
|
|
83716
83884
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -112337,13 +112505,6 @@
|
|
|
112337
112505
|
"permission": {
|
|
112338
112506
|
"type": "string",
|
|
112339
112507
|
"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.",
|
|
112340
|
-
"enum": [
|
|
112341
|
-
"pull",
|
|
112342
|
-
"push",
|
|
112343
|
-
"admin",
|
|
112344
|
-
"maintain",
|
|
112345
|
-
"triage"
|
|
112346
|
-
],
|
|
112347
112508
|
"default": "push"
|
|
112348
112509
|
}
|
|
112349
112510
|
}
|
|
@@ -129675,7 +129836,7 @@
|
|
|
129675
129836
|
"/repos/{owner}/{repo}/actions/permissions/access": {
|
|
129676
129837
|
"get": {
|
|
129677
129838
|
"summary": "Get the level of access for workflows outside of the repository",
|
|
129678
|
-
"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
|
|
129839
|
+
"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.5/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.",
|
|
129679
129840
|
"tags": [
|
|
129680
129841
|
"actions"
|
|
129681
129842
|
],
|
|
@@ -129748,7 +129909,7 @@
|
|
|
129748
129909
|
},
|
|
129749
129910
|
"put": {
|
|
129750
129911
|
"summary": "Set the level of access for workflows outside of the repository",
|
|
129751
|
-
"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
|
|
129912
|
+
"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.5/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.",
|
|
129752
129913
|
"tags": [
|
|
129753
129914
|
"actions"
|
|
129754
129915
|
],
|
|
@@ -194132,13 +194293,6 @@
|
|
|
194132
194293
|
"permission": {
|
|
194133
194294
|
"type": "string",
|
|
194134
194295
|
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**",
|
|
194135
|
-
"enum": [
|
|
194136
|
-
"pull",
|
|
194137
|
-
"push",
|
|
194138
|
-
"admin",
|
|
194139
|
-
"maintain",
|
|
194140
|
-
"triage"
|
|
194141
|
-
],
|
|
194142
194296
|
"default": "push"
|
|
194143
194297
|
}
|
|
194144
194298
|
}
|
|
@@ -214187,7 +214341,13 @@
|
|
|
214187
214341
|
"type": "object",
|
|
214188
214342
|
"properties": {
|
|
214189
214343
|
"type": {
|
|
214190
|
-
"type": "string"
|
|
214344
|
+
"type": "string",
|
|
214345
|
+
"enum": [
|
|
214346
|
+
"dir",
|
|
214347
|
+
"file",
|
|
214348
|
+
"submodule",
|
|
214349
|
+
"symlink"
|
|
214350
|
+
]
|
|
214191
214351
|
},
|
|
214192
214352
|
"size": {
|
|
214193
214353
|
"type": "integer"
|
|
@@ -214268,7 +214428,10 @@
|
|
|
214268
214428
|
"type": "object",
|
|
214269
214429
|
"properties": {
|
|
214270
214430
|
"type": {
|
|
214271
|
-
"type": "string"
|
|
214431
|
+
"type": "string",
|
|
214432
|
+
"enum": [
|
|
214433
|
+
"file"
|
|
214434
|
+
]
|
|
214272
214435
|
},
|
|
214273
214436
|
"encoding": {
|
|
214274
214437
|
"type": "string"
|
|
@@ -214361,7 +214524,10 @@
|
|
|
214361
214524
|
"type": "object",
|
|
214362
214525
|
"properties": {
|
|
214363
214526
|
"type": {
|
|
214364
|
-
"type": "string"
|
|
214527
|
+
"type": "string",
|
|
214528
|
+
"enum": [
|
|
214529
|
+
"symlink"
|
|
214530
|
+
]
|
|
214365
214531
|
},
|
|
214366
214532
|
"target": {
|
|
214367
214533
|
"type": "string"
|
|
@@ -214437,12 +214603,15 @@
|
|
|
214437
214603
|
]
|
|
214438
214604
|
},
|
|
214439
214605
|
{
|
|
214440
|
-
"title": "
|
|
214441
|
-
"description": "An object describing a
|
|
214606
|
+
"title": "Submodule Content",
|
|
214607
|
+
"description": "An object describing a submodule",
|
|
214442
214608
|
"type": "object",
|
|
214443
214609
|
"properties": {
|
|
214444
214610
|
"type": {
|
|
214445
|
-
"type": "string"
|
|
214611
|
+
"type": "string",
|
|
214612
|
+
"enum": [
|
|
214613
|
+
"submodule"
|
|
214614
|
+
]
|
|
214446
214615
|
},
|
|
214447
214616
|
"submodule_git_url": {
|
|
214448
214617
|
"type": "string",
|
|
@@ -220749,15 +220918,15 @@
|
|
|
220749
220918
|
},
|
|
220750
220919
|
"/repos/{owner}/{repo}/environments": {
|
|
220751
220920
|
"get": {
|
|
220752
|
-
"summary": "
|
|
220753
|
-
"description": "
|
|
220921
|
+
"summary": "List environments",
|
|
220922
|
+
"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.",
|
|
220754
220923
|
"tags": [
|
|
220755
220924
|
"repos"
|
|
220756
220925
|
],
|
|
220757
220926
|
"operationId": "repos/get-all-environments",
|
|
220758
220927
|
"externalDocs": {
|
|
220759
220928
|
"description": "API method documentation",
|
|
220760
|
-
"url": "https://docs.github.com/enterprise-server@3.5/rest/
|
|
220929
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/environments#list-environments"
|
|
220761
220930
|
},
|
|
220762
220931
|
"parameters": [
|
|
220763
220932
|
{
|
|
@@ -221356,7 +221525,7 @@
|
|
|
221356
221525
|
"x-github": {
|
|
221357
221526
|
"githubCloudOnly": false,
|
|
221358
221527
|
"enabledForGitHubApps": true,
|
|
221359
|
-
"category": "
|
|
221528
|
+
"category": "deployments",
|
|
221360
221529
|
"subcategory": "environments"
|
|
221361
221530
|
},
|
|
221362
221531
|
"x-octokit": {}
|
|
@@ -221365,7 +221534,7 @@
|
|
|
221365
221534
|
"/repos/{owner}/{repo}/environments/{environment_name}": {
|
|
221366
221535
|
"get": {
|
|
221367
221536
|
"summary": "Get an environment",
|
|
221368
|
-
"description": "
|
|
221537
|
+
"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.",
|
|
221369
221538
|
"tags": [
|
|
221370
221539
|
"repos"
|
|
221371
221540
|
],
|
|
@@ -221397,7 +221566,7 @@
|
|
|
221397
221566
|
"name": "environment_name",
|
|
221398
221567
|
"in": "path",
|
|
221399
221568
|
"required": true,
|
|
221400
|
-
"description": "The name of the environment",
|
|
221569
|
+
"description": "The name of the environment.",
|
|
221401
221570
|
"schema": {
|
|
221402
221571
|
"type": "string"
|
|
221403
221572
|
}
|
|
@@ -221951,7 +222120,7 @@
|
|
|
221951
222120
|
},
|
|
221952
222121
|
"put": {
|
|
221953
222122
|
"summary": "Create or update an environment",
|
|
221954
|
-
"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:**
|
|
222123
|
+
"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.",
|
|
221955
222124
|
"tags": [
|
|
221956
222125
|
"repos"
|
|
221957
222126
|
],
|
|
@@ -221983,7 +222152,7 @@
|
|
|
221983
222152
|
"name": "environment_name",
|
|
221984
222153
|
"in": "path",
|
|
221985
222154
|
"required": true,
|
|
221986
|
-
"description": "The name of the environment",
|
|
222155
|
+
"description": "The name of the environment.",
|
|
221987
222156
|
"schema": {
|
|
221988
222157
|
"type": "string"
|
|
221989
222158
|
}
|
|
@@ -222047,6 +222216,27 @@
|
|
|
222047
222216
|
}
|
|
222048
222217
|
},
|
|
222049
222218
|
"additionalProperties": false
|
|
222219
|
+
},
|
|
222220
|
+
"examples": {
|
|
222221
|
+
"default": {
|
|
222222
|
+
"value": {
|
|
222223
|
+
"wait_timer": 30,
|
|
222224
|
+
"reviewers": [
|
|
222225
|
+
{
|
|
222226
|
+
"type": "User",
|
|
222227
|
+
"id": 1
|
|
222228
|
+
},
|
|
222229
|
+
{
|
|
222230
|
+
"type": "Team",
|
|
222231
|
+
"id": 1
|
|
222232
|
+
}
|
|
222233
|
+
],
|
|
222234
|
+
"deployment_branch_policy": {
|
|
222235
|
+
"protected_branches": false,
|
|
222236
|
+
"custom_branch_policies": true
|
|
222237
|
+
}
|
|
222238
|
+
}
|
|
222239
|
+
}
|
|
222050
222240
|
}
|
|
222051
222241
|
}
|
|
222052
222242
|
}
|
|
@@ -222657,7 +222847,7 @@
|
|
|
222657
222847
|
"name": "environment_name",
|
|
222658
222848
|
"in": "path",
|
|
222659
222849
|
"required": true,
|
|
222660
|
-
"description": "The name of the environment",
|
|
222850
|
+
"description": "The name of the environment.",
|
|
222661
222851
|
"schema": {
|
|
222662
222852
|
"type": "string"
|
|
222663
222853
|
}
|
|
@@ -222677,6 +222867,559 @@
|
|
|
222677
222867
|
"x-octokit": {}
|
|
222678
222868
|
}
|
|
222679
222869
|
},
|
|
222870
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
|
|
222871
|
+
"get": {
|
|
222872
|
+
"summary": "List deployment branch policies",
|
|
222873
|
+
"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.",
|
|
222874
|
+
"tags": [
|
|
222875
|
+
"repos"
|
|
222876
|
+
],
|
|
222877
|
+
"operationId": "repos/list-deployment-branch-policies",
|
|
222878
|
+
"externalDocs": {
|
|
222879
|
+
"description": "API method documentation",
|
|
222880
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#list-deployment-branch-policies"
|
|
222881
|
+
},
|
|
222882
|
+
"parameters": [
|
|
222883
|
+
{
|
|
222884
|
+
"name": "owner",
|
|
222885
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
222886
|
+
"in": "path",
|
|
222887
|
+
"required": true,
|
|
222888
|
+
"schema": {
|
|
222889
|
+
"type": "string"
|
|
222890
|
+
}
|
|
222891
|
+
},
|
|
222892
|
+
{
|
|
222893
|
+
"name": "repo",
|
|
222894
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
222895
|
+
"in": "path",
|
|
222896
|
+
"required": true,
|
|
222897
|
+
"schema": {
|
|
222898
|
+
"type": "string"
|
|
222899
|
+
}
|
|
222900
|
+
},
|
|
222901
|
+
{
|
|
222902
|
+
"name": "environment_name",
|
|
222903
|
+
"in": "path",
|
|
222904
|
+
"required": true,
|
|
222905
|
+
"description": "The name of the environment.",
|
|
222906
|
+
"schema": {
|
|
222907
|
+
"type": "string"
|
|
222908
|
+
}
|
|
222909
|
+
},
|
|
222910
|
+
{
|
|
222911
|
+
"name": "per_page",
|
|
222912
|
+
"description": "The number of results per page (max 100).",
|
|
222913
|
+
"in": "query",
|
|
222914
|
+
"schema": {
|
|
222915
|
+
"type": "integer",
|
|
222916
|
+
"default": 30
|
|
222917
|
+
}
|
|
222918
|
+
},
|
|
222919
|
+
{
|
|
222920
|
+
"name": "page",
|
|
222921
|
+
"description": "Page number of the results to fetch.",
|
|
222922
|
+
"in": "query",
|
|
222923
|
+
"schema": {
|
|
222924
|
+
"type": "integer",
|
|
222925
|
+
"default": 1
|
|
222926
|
+
}
|
|
222927
|
+
}
|
|
222928
|
+
],
|
|
222929
|
+
"responses": {
|
|
222930
|
+
"200": {
|
|
222931
|
+
"description": "Response",
|
|
222932
|
+
"content": {
|
|
222933
|
+
"application/json": {
|
|
222934
|
+
"schema": {
|
|
222935
|
+
"type": "object",
|
|
222936
|
+
"properties": {
|
|
222937
|
+
"total_count": {
|
|
222938
|
+
"description": "The number of deployment branch policies for the environment.",
|
|
222939
|
+
"type": "integer",
|
|
222940
|
+
"example": 2
|
|
222941
|
+
},
|
|
222942
|
+
"branch_policies": {
|
|
222943
|
+
"type": "array",
|
|
222944
|
+
"items": {
|
|
222945
|
+
"title": "Deployment branch policy",
|
|
222946
|
+
"description": "Details of a deployment branch policy.",
|
|
222947
|
+
"type": "object",
|
|
222948
|
+
"properties": {
|
|
222949
|
+
"id": {
|
|
222950
|
+
"description": "The unique identifier of the branch policy.",
|
|
222951
|
+
"type": "integer",
|
|
222952
|
+
"example": 361471
|
|
222953
|
+
},
|
|
222954
|
+
"node_id": {
|
|
222955
|
+
"type": "string",
|
|
222956
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
222957
|
+
},
|
|
222958
|
+
"name": {
|
|
222959
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
222960
|
+
"type": "string",
|
|
222961
|
+
"example": "release/*"
|
|
222962
|
+
}
|
|
222963
|
+
}
|
|
222964
|
+
}
|
|
222965
|
+
}
|
|
222966
|
+
},
|
|
222967
|
+
"required": [
|
|
222968
|
+
"total_count",
|
|
222969
|
+
"branch_policies"
|
|
222970
|
+
]
|
|
222971
|
+
},
|
|
222972
|
+
"examples": {
|
|
222973
|
+
"default": {
|
|
222974
|
+
"value": {
|
|
222975
|
+
"total_count": 2,
|
|
222976
|
+
"branch_policies": [
|
|
222977
|
+
{
|
|
222978
|
+
"id": 361471,
|
|
222979
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
|
|
222980
|
+
"name": "release/*"
|
|
222981
|
+
},
|
|
222982
|
+
{
|
|
222983
|
+
"id": 361472,
|
|
222984
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
|
|
222985
|
+
"name": "main"
|
|
222986
|
+
}
|
|
222987
|
+
]
|
|
222988
|
+
}
|
|
222989
|
+
}
|
|
222990
|
+
}
|
|
222991
|
+
}
|
|
222992
|
+
}
|
|
222993
|
+
}
|
|
222994
|
+
},
|
|
222995
|
+
"x-github": {
|
|
222996
|
+
"githubCloudOnly": false,
|
|
222997
|
+
"enabledForGitHubApps": true,
|
|
222998
|
+
"category": "deployments",
|
|
222999
|
+
"subcategory": "branch-policies"
|
|
223000
|
+
},
|
|
223001
|
+
"x-octokit": {}
|
|
223002
|
+
},
|
|
223003
|
+
"post": {
|
|
223004
|
+
"summary": "Create a deployment branch policy",
|
|
223005
|
+
"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.",
|
|
223006
|
+
"tags": [
|
|
223007
|
+
"repos"
|
|
223008
|
+
],
|
|
223009
|
+
"operationId": "repos/create-deployment-branch-policy",
|
|
223010
|
+
"externalDocs": {
|
|
223011
|
+
"description": "API method documentation",
|
|
223012
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#create-deployment-branch-policy"
|
|
223013
|
+
},
|
|
223014
|
+
"parameters": [
|
|
223015
|
+
{
|
|
223016
|
+
"name": "owner",
|
|
223017
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
223018
|
+
"in": "path",
|
|
223019
|
+
"required": true,
|
|
223020
|
+
"schema": {
|
|
223021
|
+
"type": "string"
|
|
223022
|
+
}
|
|
223023
|
+
},
|
|
223024
|
+
{
|
|
223025
|
+
"name": "repo",
|
|
223026
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
223027
|
+
"in": "path",
|
|
223028
|
+
"required": true,
|
|
223029
|
+
"schema": {
|
|
223030
|
+
"type": "string"
|
|
223031
|
+
}
|
|
223032
|
+
},
|
|
223033
|
+
{
|
|
223034
|
+
"name": "environment_name",
|
|
223035
|
+
"in": "path",
|
|
223036
|
+
"required": true,
|
|
223037
|
+
"description": "The name of the environment.",
|
|
223038
|
+
"schema": {
|
|
223039
|
+
"type": "string"
|
|
223040
|
+
}
|
|
223041
|
+
}
|
|
223042
|
+
],
|
|
223043
|
+
"requestBody": {
|
|
223044
|
+
"required": true,
|
|
223045
|
+
"content": {
|
|
223046
|
+
"application/json": {
|
|
223047
|
+
"schema": {
|
|
223048
|
+
"title": "Deployment branch policy name pattern",
|
|
223049
|
+
"type": "object",
|
|
223050
|
+
"properties": {
|
|
223051
|
+
"name": {
|
|
223052
|
+
"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).",
|
|
223053
|
+
"type": "string",
|
|
223054
|
+
"example": "release/*"
|
|
223055
|
+
}
|
|
223056
|
+
},
|
|
223057
|
+
"required": [
|
|
223058
|
+
"name"
|
|
223059
|
+
]
|
|
223060
|
+
},
|
|
223061
|
+
"examples": {
|
|
223062
|
+
"example-wildcard": {
|
|
223063
|
+
"summary": "Example of a wildcard name pattern",
|
|
223064
|
+
"value": {
|
|
223065
|
+
"name": "release/*"
|
|
223066
|
+
}
|
|
223067
|
+
},
|
|
223068
|
+
"example-single-branch": {
|
|
223069
|
+
"summary": "Example of a single branch name pattern",
|
|
223070
|
+
"value": {
|
|
223071
|
+
"name": "main"
|
|
223072
|
+
}
|
|
223073
|
+
}
|
|
223074
|
+
}
|
|
223075
|
+
}
|
|
223076
|
+
}
|
|
223077
|
+
},
|
|
223078
|
+
"responses": {
|
|
223079
|
+
"200": {
|
|
223080
|
+
"description": "Response",
|
|
223081
|
+
"content": {
|
|
223082
|
+
"application/json": {
|
|
223083
|
+
"schema": {
|
|
223084
|
+
"title": "Deployment branch policy",
|
|
223085
|
+
"description": "Details of a deployment branch policy.",
|
|
223086
|
+
"type": "object",
|
|
223087
|
+
"properties": {
|
|
223088
|
+
"id": {
|
|
223089
|
+
"description": "The unique identifier of the branch policy.",
|
|
223090
|
+
"type": "integer",
|
|
223091
|
+
"example": 361471
|
|
223092
|
+
},
|
|
223093
|
+
"node_id": {
|
|
223094
|
+
"type": "string",
|
|
223095
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
223096
|
+
},
|
|
223097
|
+
"name": {
|
|
223098
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
223099
|
+
"type": "string",
|
|
223100
|
+
"example": "release/*"
|
|
223101
|
+
}
|
|
223102
|
+
}
|
|
223103
|
+
},
|
|
223104
|
+
"examples": {
|
|
223105
|
+
"example-wildcard": {
|
|
223106
|
+
"value": {
|
|
223107
|
+
"id": 364662,
|
|
223108
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
223109
|
+
"name": "release/*"
|
|
223110
|
+
}
|
|
223111
|
+
},
|
|
223112
|
+
"example-single-branch": {
|
|
223113
|
+
"value": {
|
|
223114
|
+
"id": 364663,
|
|
223115
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
223116
|
+
"name": "main"
|
|
223117
|
+
}
|
|
223118
|
+
}
|
|
223119
|
+
}
|
|
223120
|
+
}
|
|
223121
|
+
}
|
|
223122
|
+
},
|
|
223123
|
+
"303": {
|
|
223124
|
+
"description": "Response if the same branch name pattern already exists"
|
|
223125
|
+
},
|
|
223126
|
+
"404": {
|
|
223127
|
+
"description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
|
|
223128
|
+
}
|
|
223129
|
+
},
|
|
223130
|
+
"x-github": {
|
|
223131
|
+
"githubCloudOnly": false,
|
|
223132
|
+
"enabledForGitHubApps": true,
|
|
223133
|
+
"category": "deployments",
|
|
223134
|
+
"subcategory": "branch-policies"
|
|
223135
|
+
},
|
|
223136
|
+
"x-octokit": {}
|
|
223137
|
+
}
|
|
223138
|
+
},
|
|
223139
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
223140
|
+
"get": {
|
|
223141
|
+
"summary": "Get a deployment branch policy",
|
|
223142
|
+
"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.",
|
|
223143
|
+
"tags": [
|
|
223144
|
+
"repos"
|
|
223145
|
+
],
|
|
223146
|
+
"operationId": "repos/get-deployment-branch-policy",
|
|
223147
|
+
"externalDocs": {
|
|
223148
|
+
"description": "API method documentation",
|
|
223149
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#get-deployment-branch-policy"
|
|
223150
|
+
},
|
|
223151
|
+
"parameters": [
|
|
223152
|
+
{
|
|
223153
|
+
"name": "owner",
|
|
223154
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
223155
|
+
"in": "path",
|
|
223156
|
+
"required": true,
|
|
223157
|
+
"schema": {
|
|
223158
|
+
"type": "string"
|
|
223159
|
+
}
|
|
223160
|
+
},
|
|
223161
|
+
{
|
|
223162
|
+
"name": "repo",
|
|
223163
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
223164
|
+
"in": "path",
|
|
223165
|
+
"required": true,
|
|
223166
|
+
"schema": {
|
|
223167
|
+
"type": "string"
|
|
223168
|
+
}
|
|
223169
|
+
},
|
|
223170
|
+
{
|
|
223171
|
+
"name": "environment_name",
|
|
223172
|
+
"in": "path",
|
|
223173
|
+
"required": true,
|
|
223174
|
+
"description": "The name of the environment.",
|
|
223175
|
+
"schema": {
|
|
223176
|
+
"type": "string"
|
|
223177
|
+
}
|
|
223178
|
+
},
|
|
223179
|
+
{
|
|
223180
|
+
"name": "branch_policy_id",
|
|
223181
|
+
"in": "path",
|
|
223182
|
+
"required": true,
|
|
223183
|
+
"description": "The unique identifier of the branch policy.",
|
|
223184
|
+
"schema": {
|
|
223185
|
+
"type": "integer"
|
|
223186
|
+
}
|
|
223187
|
+
}
|
|
223188
|
+
],
|
|
223189
|
+
"responses": {
|
|
223190
|
+
"200": {
|
|
223191
|
+
"description": "Response",
|
|
223192
|
+
"content": {
|
|
223193
|
+
"application/json": {
|
|
223194
|
+
"schema": {
|
|
223195
|
+
"title": "Deployment branch policy",
|
|
223196
|
+
"description": "Details of a deployment branch policy.",
|
|
223197
|
+
"type": "object",
|
|
223198
|
+
"properties": {
|
|
223199
|
+
"id": {
|
|
223200
|
+
"description": "The unique identifier of the branch policy.",
|
|
223201
|
+
"type": "integer",
|
|
223202
|
+
"example": 361471
|
|
223203
|
+
},
|
|
223204
|
+
"node_id": {
|
|
223205
|
+
"type": "string",
|
|
223206
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
223207
|
+
},
|
|
223208
|
+
"name": {
|
|
223209
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
223210
|
+
"type": "string",
|
|
223211
|
+
"example": "release/*"
|
|
223212
|
+
}
|
|
223213
|
+
}
|
|
223214
|
+
},
|
|
223215
|
+
"examples": {
|
|
223216
|
+
"default": {
|
|
223217
|
+
"value": {
|
|
223218
|
+
"id": 364662,
|
|
223219
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
223220
|
+
"name": "release/*"
|
|
223221
|
+
}
|
|
223222
|
+
}
|
|
223223
|
+
}
|
|
223224
|
+
}
|
|
223225
|
+
}
|
|
223226
|
+
}
|
|
223227
|
+
},
|
|
223228
|
+
"x-github": {
|
|
223229
|
+
"githubCloudOnly": false,
|
|
223230
|
+
"enabledForGitHubApps": true,
|
|
223231
|
+
"category": "deployments",
|
|
223232
|
+
"subcategory": "branch-policies"
|
|
223233
|
+
},
|
|
223234
|
+
"x-octokit": {}
|
|
223235
|
+
},
|
|
223236
|
+
"put": {
|
|
223237
|
+
"summary": "Update a deployment branch policy",
|
|
223238
|
+
"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.",
|
|
223239
|
+
"tags": [
|
|
223240
|
+
"repos"
|
|
223241
|
+
],
|
|
223242
|
+
"operationId": "repos/update-deployment-branch-policy",
|
|
223243
|
+
"externalDocs": {
|
|
223244
|
+
"description": "API method documentation",
|
|
223245
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#update-deployment-branch-policy"
|
|
223246
|
+
},
|
|
223247
|
+
"parameters": [
|
|
223248
|
+
{
|
|
223249
|
+
"name": "owner",
|
|
223250
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
223251
|
+
"in": "path",
|
|
223252
|
+
"required": true,
|
|
223253
|
+
"schema": {
|
|
223254
|
+
"type": "string"
|
|
223255
|
+
}
|
|
223256
|
+
},
|
|
223257
|
+
{
|
|
223258
|
+
"name": "repo",
|
|
223259
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
223260
|
+
"in": "path",
|
|
223261
|
+
"required": true,
|
|
223262
|
+
"schema": {
|
|
223263
|
+
"type": "string"
|
|
223264
|
+
}
|
|
223265
|
+
},
|
|
223266
|
+
{
|
|
223267
|
+
"name": "environment_name",
|
|
223268
|
+
"in": "path",
|
|
223269
|
+
"required": true,
|
|
223270
|
+
"description": "The name of the environment.",
|
|
223271
|
+
"schema": {
|
|
223272
|
+
"type": "string"
|
|
223273
|
+
}
|
|
223274
|
+
},
|
|
223275
|
+
{
|
|
223276
|
+
"name": "branch_policy_id",
|
|
223277
|
+
"in": "path",
|
|
223278
|
+
"required": true,
|
|
223279
|
+
"description": "The unique identifier of the branch policy.",
|
|
223280
|
+
"schema": {
|
|
223281
|
+
"type": "integer"
|
|
223282
|
+
}
|
|
223283
|
+
}
|
|
223284
|
+
],
|
|
223285
|
+
"requestBody": {
|
|
223286
|
+
"required": true,
|
|
223287
|
+
"content": {
|
|
223288
|
+
"application/json": {
|
|
223289
|
+
"schema": {
|
|
223290
|
+
"title": "Deployment branch policy name pattern",
|
|
223291
|
+
"type": "object",
|
|
223292
|
+
"properties": {
|
|
223293
|
+
"name": {
|
|
223294
|
+
"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).",
|
|
223295
|
+
"type": "string",
|
|
223296
|
+
"example": "release/*"
|
|
223297
|
+
}
|
|
223298
|
+
},
|
|
223299
|
+
"required": [
|
|
223300
|
+
"name"
|
|
223301
|
+
]
|
|
223302
|
+
},
|
|
223303
|
+
"examples": {
|
|
223304
|
+
"default": {
|
|
223305
|
+
"value": {
|
|
223306
|
+
"name": "release/*"
|
|
223307
|
+
}
|
|
223308
|
+
}
|
|
223309
|
+
}
|
|
223310
|
+
}
|
|
223311
|
+
}
|
|
223312
|
+
},
|
|
223313
|
+
"responses": {
|
|
223314
|
+
"200": {
|
|
223315
|
+
"description": "Response",
|
|
223316
|
+
"content": {
|
|
223317
|
+
"application/json": {
|
|
223318
|
+
"schema": {
|
|
223319
|
+
"title": "Deployment branch policy",
|
|
223320
|
+
"description": "Details of a deployment branch policy.",
|
|
223321
|
+
"type": "object",
|
|
223322
|
+
"properties": {
|
|
223323
|
+
"id": {
|
|
223324
|
+
"description": "The unique identifier of the branch policy.",
|
|
223325
|
+
"type": "integer",
|
|
223326
|
+
"example": 361471
|
|
223327
|
+
},
|
|
223328
|
+
"node_id": {
|
|
223329
|
+
"type": "string",
|
|
223330
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
223331
|
+
},
|
|
223332
|
+
"name": {
|
|
223333
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
223334
|
+
"type": "string",
|
|
223335
|
+
"example": "release/*"
|
|
223336
|
+
}
|
|
223337
|
+
}
|
|
223338
|
+
},
|
|
223339
|
+
"examples": {
|
|
223340
|
+
"default": {
|
|
223341
|
+
"value": {
|
|
223342
|
+
"id": 364662,
|
|
223343
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
223344
|
+
"name": "release/*"
|
|
223345
|
+
}
|
|
223346
|
+
}
|
|
223347
|
+
}
|
|
223348
|
+
}
|
|
223349
|
+
}
|
|
223350
|
+
}
|
|
223351
|
+
},
|
|
223352
|
+
"x-github": {
|
|
223353
|
+
"githubCloudOnly": false,
|
|
223354
|
+
"enabledForGitHubApps": true,
|
|
223355
|
+
"category": "deployments",
|
|
223356
|
+
"subcategory": "branch-policies"
|
|
223357
|
+
},
|
|
223358
|
+
"x-octokit": {}
|
|
223359
|
+
},
|
|
223360
|
+
"delete": {
|
|
223361
|
+
"summary": "Delete a deployment branch policy",
|
|
223362
|
+
"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.",
|
|
223363
|
+
"tags": [
|
|
223364
|
+
"repos"
|
|
223365
|
+
],
|
|
223366
|
+
"operationId": "repos/delete-deployment-branch-policy",
|
|
223367
|
+
"externalDocs": {
|
|
223368
|
+
"description": "API method documentation",
|
|
223369
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/deployments/branch-policies#delete-deployment-branch-policy"
|
|
223370
|
+
},
|
|
223371
|
+
"parameters": [
|
|
223372
|
+
{
|
|
223373
|
+
"name": "owner",
|
|
223374
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
223375
|
+
"in": "path",
|
|
223376
|
+
"required": true,
|
|
223377
|
+
"schema": {
|
|
223378
|
+
"type": "string"
|
|
223379
|
+
}
|
|
223380
|
+
},
|
|
223381
|
+
{
|
|
223382
|
+
"name": "repo",
|
|
223383
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
223384
|
+
"in": "path",
|
|
223385
|
+
"required": true,
|
|
223386
|
+
"schema": {
|
|
223387
|
+
"type": "string"
|
|
223388
|
+
}
|
|
223389
|
+
},
|
|
223390
|
+
{
|
|
223391
|
+
"name": "environment_name",
|
|
223392
|
+
"in": "path",
|
|
223393
|
+
"required": true,
|
|
223394
|
+
"description": "The name of the environment.",
|
|
223395
|
+
"schema": {
|
|
223396
|
+
"type": "string"
|
|
223397
|
+
}
|
|
223398
|
+
},
|
|
223399
|
+
{
|
|
223400
|
+
"name": "branch_policy_id",
|
|
223401
|
+
"in": "path",
|
|
223402
|
+
"required": true,
|
|
223403
|
+
"description": "The unique identifier of the branch policy.",
|
|
223404
|
+
"schema": {
|
|
223405
|
+
"type": "integer"
|
|
223406
|
+
}
|
|
223407
|
+
}
|
|
223408
|
+
],
|
|
223409
|
+
"responses": {
|
|
223410
|
+
"204": {
|
|
223411
|
+
"description": "Response"
|
|
223412
|
+
}
|
|
223413
|
+
},
|
|
223414
|
+
"x-github": {
|
|
223415
|
+
"githubCloudOnly": false,
|
|
223416
|
+
"enabledForGitHubApps": true,
|
|
223417
|
+
"category": "deployments",
|
|
223418
|
+
"subcategory": "branch-policies"
|
|
223419
|
+
},
|
|
223420
|
+
"x-octokit": {}
|
|
223421
|
+
}
|
|
223422
|
+
},
|
|
222680
223423
|
"/repos/{owner}/{repo}/events": {
|
|
222681
223424
|
"get": {
|
|
222682
223425
|
"summary": "List repository events",
|
|
@@ -239163,6 +239906,14 @@
|
|
|
239163
239906
|
"write"
|
|
239164
239907
|
]
|
|
239165
239908
|
},
|
|
239909
|
+
"organization_custom_roles": {
|
|
239910
|
+
"type": "string",
|
|
239911
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
239912
|
+
"enum": [
|
|
239913
|
+
"read",
|
|
239914
|
+
"write"
|
|
239915
|
+
]
|
|
239916
|
+
},
|
|
239166
239917
|
"deployments": {
|
|
239167
239918
|
"type": "string",
|
|
239168
239919
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -338437,287 +339188,293 @@
|
|
|
338437
339188
|
"type": "object",
|
|
338438
339189
|
"properties": {
|
|
338439
339190
|
"type": {
|
|
338440
|
-
"type": "string"
|
|
338441
|
-
},
|
|
338442
|
-
"encoding": {
|
|
338443
|
-
"type": "string"
|
|
338444
|
-
},
|
|
338445
|
-
"size": {
|
|
338446
|
-
"type": "integer"
|
|
338447
|
-
},
|
|
338448
|
-
"name": {
|
|
338449
|
-
"type": "string"
|
|
338450
|
-
},
|
|
338451
|
-
"path": {
|
|
338452
|
-
"type": "string"
|
|
338453
|
-
},
|
|
338454
|
-
"content": {
|
|
338455
|
-
"type": "string"
|
|
338456
|
-
},
|
|
338457
|
-
"sha": {
|
|
338458
|
-
"type": "string"
|
|
338459
|
-
},
|
|
338460
|
-
"url": {
|
|
338461
|
-
"type": "string",
|
|
338462
|
-
"format": "uri"
|
|
338463
|
-
},
|
|
338464
|
-
"git_url": {
|
|
338465
|
-
"type": "string",
|
|
338466
|
-
"format": "uri",
|
|
338467
|
-
"nullable": true
|
|
338468
|
-
},
|
|
338469
|
-
"html_url": {
|
|
338470
339191
|
"type": "string",
|
|
338471
|
-
"
|
|
338472
|
-
|
|
338473
|
-
|
|
338474
|
-
|
|
338475
|
-
|
|
338476
|
-
"
|
|
338477
|
-
|
|
338478
|
-
|
|
338479
|
-
|
|
338480
|
-
|
|
338481
|
-
|
|
338482
|
-
|
|
338483
|
-
|
|
338484
|
-
|
|
338485
|
-
|
|
338486
|
-
|
|
338487
|
-
|
|
338488
|
-
|
|
338489
|
-
|
|
338490
|
-
|
|
338491
|
-
|
|
338492
|
-
|
|
338493
|
-
|
|
338494
|
-
|
|
338495
|
-
|
|
338496
|
-
|
|
338497
|
-
|
|
338498
|
-
|
|
338499
|
-
|
|
338500
|
-
|
|
339192
|
+
"enum": [
|
|
339193
|
+
"file"
|
|
339194
|
+
]
|
|
339195
|
+
},
|
|
339196
|
+
"encoding": {
|
|
339197
|
+
"type": "string"
|
|
339198
|
+
},
|
|
339199
|
+
"size": {
|
|
339200
|
+
"type": "integer"
|
|
339201
|
+
},
|
|
339202
|
+
"name": {
|
|
339203
|
+
"type": "string"
|
|
339204
|
+
},
|
|
339205
|
+
"path": {
|
|
339206
|
+
"type": "string"
|
|
339207
|
+
},
|
|
339208
|
+
"content": {
|
|
339209
|
+
"type": "string"
|
|
339210
|
+
},
|
|
339211
|
+
"sha": {
|
|
339212
|
+
"type": "string"
|
|
339213
|
+
},
|
|
339214
|
+
"url": {
|
|
339215
|
+
"type": "string",
|
|
339216
|
+
"format": "uri"
|
|
339217
|
+
},
|
|
339218
|
+
"git_url": {
|
|
339219
|
+
"type": "string",
|
|
339220
|
+
"format": "uri",
|
|
339221
|
+
"nullable": true
|
|
339222
|
+
},
|
|
339223
|
+
"html_url": {
|
|
339224
|
+
"type": "string",
|
|
339225
|
+
"format": "uri",
|
|
339226
|
+
"nullable": true
|
|
339227
|
+
},
|
|
339228
|
+
"download_url": {
|
|
339229
|
+
"type": "string",
|
|
339230
|
+
"format": "uri",
|
|
339231
|
+
"nullable": true
|
|
339232
|
+
},
|
|
339233
|
+
"_links": {
|
|
339234
|
+
"type": "object",
|
|
339235
|
+
"properties": {
|
|
339236
|
+
"git": {
|
|
339237
|
+
"type": "string",
|
|
339238
|
+
"format": "uri",
|
|
339239
|
+
"nullable": true
|
|
339240
|
+
},
|
|
339241
|
+
"html": {
|
|
339242
|
+
"type": "string",
|
|
339243
|
+
"format": "uri",
|
|
339244
|
+
"nullable": true
|
|
339245
|
+
},
|
|
339246
|
+
"self": {
|
|
339247
|
+
"type": "string",
|
|
339248
|
+
"format": "uri"
|
|
339249
|
+
}
|
|
339250
|
+
},
|
|
339251
|
+
"required": [
|
|
339252
|
+
"git",
|
|
339253
|
+
"html",
|
|
339254
|
+
"self"
|
|
339255
|
+
]
|
|
339256
|
+
},
|
|
339257
|
+
"target": {
|
|
339258
|
+
"type": "string",
|
|
339259
|
+
"example": "\"actual/actual.md\""
|
|
339260
|
+
},
|
|
339261
|
+
"submodule_git_url": {
|
|
339262
|
+
"type": "string",
|
|
339263
|
+
"example": "\"git://example.com/defunkt/dotjs.git\""
|
|
339264
|
+
}
|
|
339265
|
+
},
|
|
339266
|
+
"required": [
|
|
339267
|
+
"_links",
|
|
339268
|
+
"git_url",
|
|
339269
|
+
"html_url",
|
|
339270
|
+
"download_url",
|
|
339271
|
+
"name",
|
|
339272
|
+
"path",
|
|
339273
|
+
"sha",
|
|
339274
|
+
"size",
|
|
339275
|
+
"type",
|
|
339276
|
+
"url",
|
|
339277
|
+
"content",
|
|
339278
|
+
"encoding"
|
|
339279
|
+
]
|
|
339280
|
+
},
|
|
339281
|
+
"examples": {
|
|
339282
|
+
"default": {
|
|
339283
|
+
"value": {
|
|
339284
|
+
"type": "file",
|
|
339285
|
+
"encoding": "base64",
|
|
339286
|
+
"size": 5362,
|
|
339287
|
+
"name": "README.md",
|
|
339288
|
+
"path": "README.md",
|
|
339289
|
+
"content": "encoded content ...",
|
|
339290
|
+
"sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
339291
|
+
"url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
339292
|
+
"git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
339293
|
+
"html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
|
|
339294
|
+
"download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
|
|
339295
|
+
"_links": {
|
|
339296
|
+
"git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
339297
|
+
"self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
339298
|
+
"html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
|
|
339299
|
+
}
|
|
339300
|
+
}
|
|
339301
|
+
}
|
|
339302
|
+
}
|
|
339303
|
+
}
|
|
339304
|
+
}
|
|
339305
|
+
},
|
|
339306
|
+
"404": {
|
|
339307
|
+
"description": "Resource not found",
|
|
339308
|
+
"content": {
|
|
339309
|
+
"application/json": {
|
|
339310
|
+
"schema": {
|
|
339311
|
+
"title": "Basic Error",
|
|
339312
|
+
"description": "Basic Error",
|
|
339313
|
+
"type": "object",
|
|
339314
|
+
"properties": {
|
|
339315
|
+
"message": {
|
|
339316
|
+
"type": "string"
|
|
339317
|
+
},
|
|
339318
|
+
"documentation_url": {
|
|
339319
|
+
"type": "string"
|
|
339320
|
+
},
|
|
339321
|
+
"url": {
|
|
339322
|
+
"type": "string"
|
|
339323
|
+
},
|
|
339324
|
+
"status": {
|
|
339325
|
+
"type": "string"
|
|
339326
|
+
}
|
|
339327
|
+
}
|
|
339328
|
+
}
|
|
339329
|
+
}
|
|
339330
|
+
}
|
|
339331
|
+
},
|
|
339332
|
+
"422": {
|
|
339333
|
+
"description": "Validation failed",
|
|
339334
|
+
"content": {
|
|
339335
|
+
"application/json": {
|
|
339336
|
+
"schema": {
|
|
339337
|
+
"title": "Validation Error",
|
|
339338
|
+
"description": "Validation Error",
|
|
339339
|
+
"type": "object",
|
|
339340
|
+
"required": [
|
|
339341
|
+
"message",
|
|
339342
|
+
"documentation_url"
|
|
339343
|
+
],
|
|
339344
|
+
"properties": {
|
|
339345
|
+
"message": {
|
|
339346
|
+
"type": "string"
|
|
339347
|
+
},
|
|
339348
|
+
"documentation_url": {
|
|
339349
|
+
"type": "string"
|
|
339350
|
+
},
|
|
339351
|
+
"errors": {
|
|
339352
|
+
"type": "array",
|
|
339353
|
+
"items": {
|
|
339354
|
+
"type": "object",
|
|
339355
|
+
"required": [
|
|
339356
|
+
"code"
|
|
339357
|
+
],
|
|
339358
|
+
"properties": {
|
|
339359
|
+
"resource": {
|
|
339360
|
+
"type": "string"
|
|
339361
|
+
},
|
|
339362
|
+
"field": {
|
|
339363
|
+
"type": "string"
|
|
339364
|
+
},
|
|
339365
|
+
"message": {
|
|
339366
|
+
"type": "string"
|
|
339367
|
+
},
|
|
339368
|
+
"code": {
|
|
339369
|
+
"type": "string"
|
|
339370
|
+
},
|
|
339371
|
+
"index": {
|
|
339372
|
+
"type": "integer"
|
|
339373
|
+
},
|
|
339374
|
+
"value": {
|
|
339375
|
+
"oneOf": [
|
|
339376
|
+
{
|
|
339377
|
+
"type": "string",
|
|
339378
|
+
"nullable": true
|
|
339379
|
+
},
|
|
339380
|
+
{
|
|
339381
|
+
"type": "integer",
|
|
339382
|
+
"nullable": true
|
|
339383
|
+
},
|
|
339384
|
+
{
|
|
339385
|
+
"type": "array",
|
|
339386
|
+
"nullable": true,
|
|
339387
|
+
"items": {
|
|
339388
|
+
"type": "string"
|
|
339389
|
+
}
|
|
339390
|
+
}
|
|
339391
|
+
]
|
|
339392
|
+
}
|
|
339393
|
+
}
|
|
339394
|
+
}
|
|
339395
|
+
}
|
|
339396
|
+
}
|
|
339397
|
+
}
|
|
339398
|
+
}
|
|
339399
|
+
}
|
|
339400
|
+
}
|
|
339401
|
+
},
|
|
339402
|
+
"x-github": {
|
|
339403
|
+
"githubCloudOnly": false,
|
|
339404
|
+
"enabledForGitHubApps": true,
|
|
339405
|
+
"category": "repos",
|
|
339406
|
+
"subcategory": "contents"
|
|
339407
|
+
},
|
|
339408
|
+
"x-octokit": {}
|
|
339409
|
+
}
|
|
339410
|
+
},
|
|
339411
|
+
"/repos/{owner}/{repo}/readme/{dir}": {
|
|
339412
|
+
"get": {
|
|
339413
|
+
"summary": "Get a repository README for a directory",
|
|
339414
|
+
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
|
|
339415
|
+
"tags": [
|
|
339416
|
+
"repos"
|
|
339417
|
+
],
|
|
339418
|
+
"operationId": "repos/get-readme-in-directory",
|
|
339419
|
+
"externalDocs": {
|
|
339420
|
+
"description": "API method documentation",
|
|
339421
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository-directory-readme"
|
|
339422
|
+
},
|
|
339423
|
+
"parameters": [
|
|
339424
|
+
{
|
|
339425
|
+
"name": "owner",
|
|
339426
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
339427
|
+
"in": "path",
|
|
339428
|
+
"required": true,
|
|
339429
|
+
"schema": {
|
|
339430
|
+
"type": "string"
|
|
339431
|
+
}
|
|
339432
|
+
},
|
|
339433
|
+
{
|
|
339434
|
+
"name": "repo",
|
|
339435
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
339436
|
+
"in": "path",
|
|
339437
|
+
"required": true,
|
|
339438
|
+
"schema": {
|
|
339439
|
+
"type": "string"
|
|
339440
|
+
}
|
|
339441
|
+
},
|
|
339442
|
+
{
|
|
339443
|
+
"name": "dir",
|
|
339444
|
+
"description": "The alternate path to look for a README file",
|
|
339445
|
+
"in": "path",
|
|
339446
|
+
"required": true,
|
|
339447
|
+
"schema": {
|
|
339448
|
+
"type": "string"
|
|
339449
|
+
},
|
|
339450
|
+
"x-multi-segment": true
|
|
339451
|
+
},
|
|
339452
|
+
{
|
|
339453
|
+
"name": "ref",
|
|
339454
|
+
"description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
|
|
339455
|
+
"in": "query",
|
|
339456
|
+
"required": false,
|
|
339457
|
+
"schema": {
|
|
339458
|
+
"type": "string"
|
|
339459
|
+
}
|
|
339460
|
+
}
|
|
339461
|
+
],
|
|
339462
|
+
"responses": {
|
|
339463
|
+
"200": {
|
|
339464
|
+
"description": "Response",
|
|
339465
|
+
"content": {
|
|
339466
|
+
"application/json": {
|
|
339467
|
+
"schema": {
|
|
339468
|
+
"title": "Content File",
|
|
339469
|
+
"description": "Content File",
|
|
339470
|
+
"type": "object",
|
|
339471
|
+
"properties": {
|
|
339472
|
+
"type": {
|
|
339473
|
+
"type": "string",
|
|
339474
|
+
"enum": [
|
|
339475
|
+
"file"
|
|
338501
339476
|
]
|
|
338502
339477
|
},
|
|
338503
|
-
"target": {
|
|
338504
|
-
"type": "string",
|
|
338505
|
-
"example": "\"actual/actual.md\""
|
|
338506
|
-
},
|
|
338507
|
-
"submodule_git_url": {
|
|
338508
|
-
"type": "string",
|
|
338509
|
-
"example": "\"git://example.com/defunkt/dotjs.git\""
|
|
338510
|
-
}
|
|
338511
|
-
},
|
|
338512
|
-
"required": [
|
|
338513
|
-
"_links",
|
|
338514
|
-
"git_url",
|
|
338515
|
-
"html_url",
|
|
338516
|
-
"download_url",
|
|
338517
|
-
"name",
|
|
338518
|
-
"path",
|
|
338519
|
-
"sha",
|
|
338520
|
-
"size",
|
|
338521
|
-
"type",
|
|
338522
|
-
"url",
|
|
338523
|
-
"content",
|
|
338524
|
-
"encoding"
|
|
338525
|
-
]
|
|
338526
|
-
},
|
|
338527
|
-
"examples": {
|
|
338528
|
-
"default": {
|
|
338529
|
-
"value": {
|
|
338530
|
-
"type": "file",
|
|
338531
|
-
"encoding": "base64",
|
|
338532
|
-
"size": 5362,
|
|
338533
|
-
"name": "README.md",
|
|
338534
|
-
"path": "README.md",
|
|
338535
|
-
"content": "encoded content ...",
|
|
338536
|
-
"sha": "3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
338537
|
-
"url": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
338538
|
-
"git_url": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
338539
|
-
"html_url": "https://github.com/octokit/octokit.rb/blob/master/README.md",
|
|
338540
|
-
"download_url": "https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md",
|
|
338541
|
-
"_links": {
|
|
338542
|
-
"git": "https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1",
|
|
338543
|
-
"self": "https://api.github.com/repos/octokit/octokit.rb/contents/README.md",
|
|
338544
|
-
"html": "https://github.com/octokit/octokit.rb/blob/master/README.md"
|
|
338545
|
-
}
|
|
338546
|
-
}
|
|
338547
|
-
}
|
|
338548
|
-
}
|
|
338549
|
-
}
|
|
338550
|
-
}
|
|
338551
|
-
},
|
|
338552
|
-
"404": {
|
|
338553
|
-
"description": "Resource not found",
|
|
338554
|
-
"content": {
|
|
338555
|
-
"application/json": {
|
|
338556
|
-
"schema": {
|
|
338557
|
-
"title": "Basic Error",
|
|
338558
|
-
"description": "Basic Error",
|
|
338559
|
-
"type": "object",
|
|
338560
|
-
"properties": {
|
|
338561
|
-
"message": {
|
|
338562
|
-
"type": "string"
|
|
338563
|
-
},
|
|
338564
|
-
"documentation_url": {
|
|
338565
|
-
"type": "string"
|
|
338566
|
-
},
|
|
338567
|
-
"url": {
|
|
338568
|
-
"type": "string"
|
|
338569
|
-
},
|
|
338570
|
-
"status": {
|
|
338571
|
-
"type": "string"
|
|
338572
|
-
}
|
|
338573
|
-
}
|
|
338574
|
-
}
|
|
338575
|
-
}
|
|
338576
|
-
}
|
|
338577
|
-
},
|
|
338578
|
-
"422": {
|
|
338579
|
-
"description": "Validation failed",
|
|
338580
|
-
"content": {
|
|
338581
|
-
"application/json": {
|
|
338582
|
-
"schema": {
|
|
338583
|
-
"title": "Validation Error",
|
|
338584
|
-
"description": "Validation Error",
|
|
338585
|
-
"type": "object",
|
|
338586
|
-
"required": [
|
|
338587
|
-
"message",
|
|
338588
|
-
"documentation_url"
|
|
338589
|
-
],
|
|
338590
|
-
"properties": {
|
|
338591
|
-
"message": {
|
|
338592
|
-
"type": "string"
|
|
338593
|
-
},
|
|
338594
|
-
"documentation_url": {
|
|
338595
|
-
"type": "string"
|
|
338596
|
-
},
|
|
338597
|
-
"errors": {
|
|
338598
|
-
"type": "array",
|
|
338599
|
-
"items": {
|
|
338600
|
-
"type": "object",
|
|
338601
|
-
"required": [
|
|
338602
|
-
"code"
|
|
338603
|
-
],
|
|
338604
|
-
"properties": {
|
|
338605
|
-
"resource": {
|
|
338606
|
-
"type": "string"
|
|
338607
|
-
},
|
|
338608
|
-
"field": {
|
|
338609
|
-
"type": "string"
|
|
338610
|
-
},
|
|
338611
|
-
"message": {
|
|
338612
|
-
"type": "string"
|
|
338613
|
-
},
|
|
338614
|
-
"code": {
|
|
338615
|
-
"type": "string"
|
|
338616
|
-
},
|
|
338617
|
-
"index": {
|
|
338618
|
-
"type": "integer"
|
|
338619
|
-
},
|
|
338620
|
-
"value": {
|
|
338621
|
-
"oneOf": [
|
|
338622
|
-
{
|
|
338623
|
-
"type": "string",
|
|
338624
|
-
"nullable": true
|
|
338625
|
-
},
|
|
338626
|
-
{
|
|
338627
|
-
"type": "integer",
|
|
338628
|
-
"nullable": true
|
|
338629
|
-
},
|
|
338630
|
-
{
|
|
338631
|
-
"type": "array",
|
|
338632
|
-
"nullable": true,
|
|
338633
|
-
"items": {
|
|
338634
|
-
"type": "string"
|
|
338635
|
-
}
|
|
338636
|
-
}
|
|
338637
|
-
]
|
|
338638
|
-
}
|
|
338639
|
-
}
|
|
338640
|
-
}
|
|
338641
|
-
}
|
|
338642
|
-
}
|
|
338643
|
-
}
|
|
338644
|
-
}
|
|
338645
|
-
}
|
|
338646
|
-
}
|
|
338647
|
-
},
|
|
338648
|
-
"x-github": {
|
|
338649
|
-
"githubCloudOnly": false,
|
|
338650
|
-
"enabledForGitHubApps": true,
|
|
338651
|
-
"category": "repos",
|
|
338652
|
-
"subcategory": "contents"
|
|
338653
|
-
},
|
|
338654
|
-
"x-octokit": {}
|
|
338655
|
-
}
|
|
338656
|
-
},
|
|
338657
|
-
"/repos/{owner}/{repo}/readme/{dir}": {
|
|
338658
|
-
"get": {
|
|
338659
|
-
"summary": "Get a repository README for a directory",
|
|
338660
|
-
"description": "Gets the README from a repository directory.\n\nREADMEs support [custom media types](https://docs.github.com/enterprise-server@3.5/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.",
|
|
338661
|
-
"tags": [
|
|
338662
|
-
"repos"
|
|
338663
|
-
],
|
|
338664
|
-
"operationId": "repos/get-readme-in-directory",
|
|
338665
|
-
"externalDocs": {
|
|
338666
|
-
"description": "API method documentation",
|
|
338667
|
-
"url": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#get-a-repository-directory-readme"
|
|
338668
|
-
},
|
|
338669
|
-
"parameters": [
|
|
338670
|
-
{
|
|
338671
|
-
"name": "owner",
|
|
338672
|
-
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
338673
|
-
"in": "path",
|
|
338674
|
-
"required": true,
|
|
338675
|
-
"schema": {
|
|
338676
|
-
"type": "string"
|
|
338677
|
-
}
|
|
338678
|
-
},
|
|
338679
|
-
{
|
|
338680
|
-
"name": "repo",
|
|
338681
|
-
"description": "The name of the repository. The name is not case sensitive.",
|
|
338682
|
-
"in": "path",
|
|
338683
|
-
"required": true,
|
|
338684
|
-
"schema": {
|
|
338685
|
-
"type": "string"
|
|
338686
|
-
}
|
|
338687
|
-
},
|
|
338688
|
-
{
|
|
338689
|
-
"name": "dir",
|
|
338690
|
-
"description": "The alternate path to look for a README file",
|
|
338691
|
-
"in": "path",
|
|
338692
|
-
"required": true,
|
|
338693
|
-
"schema": {
|
|
338694
|
-
"type": "string"
|
|
338695
|
-
},
|
|
338696
|
-
"x-multi-segment": true
|
|
338697
|
-
},
|
|
338698
|
-
{
|
|
338699
|
-
"name": "ref",
|
|
338700
|
-
"description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
|
|
338701
|
-
"in": "query",
|
|
338702
|
-
"required": false,
|
|
338703
|
-
"schema": {
|
|
338704
|
-
"type": "string"
|
|
338705
|
-
}
|
|
338706
|
-
}
|
|
338707
|
-
],
|
|
338708
|
-
"responses": {
|
|
338709
|
-
"200": {
|
|
338710
|
-
"description": "Response",
|
|
338711
|
-
"content": {
|
|
338712
|
-
"application/json": {
|
|
338713
|
-
"schema": {
|
|
338714
|
-
"title": "Content File",
|
|
338715
|
-
"description": "Content File",
|
|
338716
|
-
"type": "object",
|
|
338717
|
-
"properties": {
|
|
338718
|
-
"type": {
|
|
338719
|
-
"type": "string"
|
|
338720
|
-
},
|
|
338721
339478
|
"encoding": {
|
|
338722
339479
|
"type": "string"
|
|
338723
339480
|
},
|
|
@@ -355368,7 +356125,7 @@
|
|
|
355368
356125
|
"name": "environment_name",
|
|
355369
356126
|
"in": "path",
|
|
355370
356127
|
"required": true,
|
|
355371
|
-
"description": "The name of the environment",
|
|
356128
|
+
"description": "The name of the environment.",
|
|
355372
356129
|
"schema": {
|
|
355373
356130
|
"type": "string"
|
|
355374
356131
|
}
|
|
@@ -355503,7 +356260,7 @@
|
|
|
355503
356260
|
"name": "environment_name",
|
|
355504
356261
|
"in": "path",
|
|
355505
356262
|
"required": true,
|
|
355506
|
-
"description": "The name of the environment",
|
|
356263
|
+
"description": "The name of the environment.",
|
|
355507
356264
|
"schema": {
|
|
355508
356265
|
"type": "string"
|
|
355509
356266
|
}
|
|
@@ -355598,7 +356355,7 @@
|
|
|
355598
356355
|
"name": "environment_name",
|
|
355599
356356
|
"in": "path",
|
|
355600
356357
|
"required": true,
|
|
355601
|
-
"description": "The name of the environment",
|
|
356358
|
+
"description": "The name of the environment.",
|
|
355602
356359
|
"schema": {
|
|
355603
356360
|
"type": "string"
|
|
355604
356361
|
}
|
|
@@ -355689,7 +356446,7 @@
|
|
|
355689
356446
|
"name": "environment_name",
|
|
355690
356447
|
"in": "path",
|
|
355691
356448
|
"required": true,
|
|
355692
|
-
"description": "The name of the environment",
|
|
356449
|
+
"description": "The name of the environment.",
|
|
355693
356450
|
"schema": {
|
|
355694
356451
|
"type": "string"
|
|
355695
356452
|
}
|
|
@@ -355794,7 +356551,7 @@
|
|
|
355794
356551
|
"name": "environment_name",
|
|
355795
356552
|
"in": "path",
|
|
355796
356553
|
"required": true,
|
|
355797
|
-
"description": "The name of the environment",
|
|
356554
|
+
"description": "The name of the environment.",
|
|
355798
356555
|
"schema": {
|
|
355799
356556
|
"type": "string"
|
|
355800
356557
|
}
|
|
@@ -383192,6 +383949,14 @@
|
|
|
383192
383949
|
"write"
|
|
383193
383950
|
]
|
|
383194
383951
|
},
|
|
383952
|
+
"organization_custom_roles": {
|
|
383953
|
+
"type": "string",
|
|
383954
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
383955
|
+
"enum": [
|
|
383956
|
+
"read",
|
|
383957
|
+
"write"
|
|
383958
|
+
]
|
|
383959
|
+
},
|
|
383195
383960
|
"deployments": {
|
|
383196
383961
|
"type": "string",
|
|
383197
383962
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -419628,6 +420393,14 @@
|
|
|
419628
420393
|
"write"
|
|
419629
420394
|
]
|
|
419630
420395
|
},
|
|
420396
|
+
"organization_custom_roles": {
|
|
420397
|
+
"type": "string",
|
|
420398
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
420399
|
+
"enum": [
|
|
420400
|
+
"read",
|
|
420401
|
+
"write"
|
|
420402
|
+
]
|
|
420403
|
+
},
|
|
419631
420404
|
"deployments": {
|
|
419632
420405
|
"type": "string",
|
|
419633
420406
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -433444,6 +434217,12 @@
|
|
|
433444
434217
|
"text/plain": {
|
|
433445
434218
|
"schema": {
|
|
433446
434219
|
"type": "string"
|
|
434220
|
+
},
|
|
434221
|
+
"examples": {
|
|
434222
|
+
"default": {
|
|
434223
|
+
"summary": "Example response",
|
|
434224
|
+
"value": "Responsive is better than fast"
|
|
434225
|
+
}
|
|
433447
434226
|
}
|
|
433448
434227
|
}
|
|
433449
434228
|
}
|