@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": {
|
|
@@ -2763,6 +2763,14 @@
|
|
|
2763
2763
|
"write"
|
|
2764
2764
|
]
|
|
2765
2765
|
},
|
|
2766
|
+
"organization_custom_roles": {
|
|
2767
|
+
"type": "string",
|
|
2768
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
2769
|
+
"enum": [
|
|
2770
|
+
"read",
|
|
2771
|
+
"write"
|
|
2772
|
+
]
|
|
2773
|
+
},
|
|
2766
2774
|
"deployments": {
|
|
2767
2775
|
"type": "string",
|
|
2768
2776
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -3564,6 +3572,14 @@
|
|
|
3564
3572
|
"write"
|
|
3565
3573
|
]
|
|
3566
3574
|
},
|
|
3575
|
+
"organization_custom_roles": {
|
|
3576
|
+
"type": "string",
|
|
3577
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
3578
|
+
"enum": [
|
|
3579
|
+
"read",
|
|
3580
|
+
"write"
|
|
3581
|
+
]
|
|
3582
|
+
},
|
|
3567
3583
|
"deployments": {
|
|
3568
3584
|
"type": "string",
|
|
3569
3585
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -4228,6 +4244,14 @@
|
|
|
4228
4244
|
"write"
|
|
4229
4245
|
]
|
|
4230
4246
|
},
|
|
4247
|
+
"organization_custom_roles": {
|
|
4248
|
+
"type": "string",
|
|
4249
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
4250
|
+
"enum": [
|
|
4251
|
+
"read",
|
|
4252
|
+
"write"
|
|
4253
|
+
]
|
|
4254
|
+
},
|
|
4231
4255
|
"deployments": {
|
|
4232
4256
|
"type": "string",
|
|
4233
4257
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -6808,6 +6832,14 @@
|
|
|
6808
6832
|
"write"
|
|
6809
6833
|
]
|
|
6810
6834
|
},
|
|
6835
|
+
"organization_custom_roles": {
|
|
6836
|
+
"type": "string",
|
|
6837
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
6838
|
+
"enum": [
|
|
6839
|
+
"read",
|
|
6840
|
+
"write"
|
|
6841
|
+
]
|
|
6842
|
+
},
|
|
6811
6843
|
"deployments": {
|
|
6812
6844
|
"type": "string",
|
|
6813
6845
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -7597,6 +7629,14 @@
|
|
|
7597
7629
|
"write"
|
|
7598
7630
|
]
|
|
7599
7631
|
},
|
|
7632
|
+
"organization_custom_roles": {
|
|
7633
|
+
"type": "string",
|
|
7634
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
7635
|
+
"enum": [
|
|
7636
|
+
"read",
|
|
7637
|
+
"write"
|
|
7638
|
+
]
|
|
7639
|
+
},
|
|
7600
7640
|
"deployments": {
|
|
7601
7641
|
"type": "string",
|
|
7602
7642
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -8250,6 +8290,14 @@
|
|
|
8250
8290
|
"write"
|
|
8251
8291
|
]
|
|
8252
8292
|
},
|
|
8293
|
+
"organization_custom_roles": {
|
|
8294
|
+
"type": "string",
|
|
8295
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
8296
|
+
"enum": [
|
|
8297
|
+
"read",
|
|
8298
|
+
"write"
|
|
8299
|
+
]
|
|
8300
|
+
},
|
|
8253
8301
|
"deployments": {
|
|
8254
8302
|
"type": "string",
|
|
8255
8303
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -8535,6 +8583,14 @@
|
|
|
8535
8583
|
"write"
|
|
8536
8584
|
]
|
|
8537
8585
|
},
|
|
8586
|
+
"organization_custom_roles": {
|
|
8587
|
+
"type": "string",
|
|
8588
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
8589
|
+
"enum": [
|
|
8590
|
+
"read",
|
|
8591
|
+
"write"
|
|
8592
|
+
]
|
|
8593
|
+
},
|
|
8538
8594
|
"deployments": {
|
|
8539
8595
|
"type": "string",
|
|
8540
8596
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -10760,6 +10816,14 @@
|
|
|
10760
10816
|
"write"
|
|
10761
10817
|
]
|
|
10762
10818
|
},
|
|
10819
|
+
"organization_custom_roles": {
|
|
10820
|
+
"type": "string",
|
|
10821
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
10822
|
+
"enum": [
|
|
10823
|
+
"read",
|
|
10824
|
+
"write"
|
|
10825
|
+
]
|
|
10826
|
+
},
|
|
10763
10827
|
"deployments": {
|
|
10764
10828
|
"type": "string",
|
|
10765
10829
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -11603,6 +11667,14 @@
|
|
|
11603
11667
|
"write"
|
|
11604
11668
|
]
|
|
11605
11669
|
},
|
|
11670
|
+
"organization_custom_roles": {
|
|
11671
|
+
"type": "string",
|
|
11672
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
11673
|
+
"enum": [
|
|
11674
|
+
"read",
|
|
11675
|
+
"write"
|
|
11676
|
+
]
|
|
11677
|
+
},
|
|
11606
11678
|
"deployments": {
|
|
11607
11679
|
"type": "string",
|
|
11608
11680
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -12539,6 +12611,14 @@
|
|
|
12539
12611
|
"write"
|
|
12540
12612
|
]
|
|
12541
12613
|
},
|
|
12614
|
+
"organization_custom_roles": {
|
|
12615
|
+
"type": "string",
|
|
12616
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
12617
|
+
"enum": [
|
|
12618
|
+
"read",
|
|
12619
|
+
"write"
|
|
12620
|
+
]
|
|
12621
|
+
},
|
|
12542
12622
|
"deployments": {
|
|
12543
12623
|
"type": "string",
|
|
12544
12624
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -54138,6 +54218,14 @@
|
|
|
54138
54218
|
"write"
|
|
54139
54219
|
]
|
|
54140
54220
|
},
|
|
54221
|
+
"organization_custom_roles": {
|
|
54222
|
+
"type": "string",
|
|
54223
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
54224
|
+
"enum": [
|
|
54225
|
+
"read",
|
|
54226
|
+
"write"
|
|
54227
|
+
]
|
|
54228
|
+
},
|
|
54141
54229
|
"deployments": {
|
|
54142
54230
|
"type": "string",
|
|
54143
54231
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -54941,6 +55029,14 @@
|
|
|
54941
55029
|
"write"
|
|
54942
55030
|
]
|
|
54943
55031
|
},
|
|
55032
|
+
"organization_custom_roles": {
|
|
55033
|
+
"type": "string",
|
|
55034
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
55035
|
+
"enum": [
|
|
55036
|
+
"read",
|
|
55037
|
+
"write"
|
|
55038
|
+
]
|
|
55039
|
+
},
|
|
54944
55040
|
"deployments": {
|
|
54945
55041
|
"type": "string",
|
|
54946
55042
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -81964,13 +82060,6 @@
|
|
|
81964
82060
|
"permission": {
|
|
81965
82061
|
"type": "string",
|
|
81966
82062
|
"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.",
|
|
81967
|
-
"enum": [
|
|
81968
|
-
"pull",
|
|
81969
|
-
"push",
|
|
81970
|
-
"admin",
|
|
81971
|
-
"maintain",
|
|
81972
|
-
"triage"
|
|
81973
|
-
],
|
|
81974
82063
|
"default": "push"
|
|
81975
82064
|
}
|
|
81976
82065
|
}
|
|
@@ -158873,13 +158962,6 @@
|
|
|
158873
158962
|
"permission": {
|
|
158874
158963
|
"type": "string",
|
|
158875
158964
|
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.**",
|
|
158876
|
-
"enum": [
|
|
158877
|
-
"pull",
|
|
158878
|
-
"push",
|
|
158879
|
-
"admin",
|
|
158880
|
-
"maintain",
|
|
158881
|
-
"triage"
|
|
158882
|
-
],
|
|
158883
158965
|
"default": "push"
|
|
158884
158966
|
}
|
|
158885
158967
|
}
|
|
@@ -178977,7 +179059,13 @@
|
|
|
178977
179059
|
"type": "object",
|
|
178978
179060
|
"properties": {
|
|
178979
179061
|
"type": {
|
|
178980
|
-
"type": "string"
|
|
179062
|
+
"type": "string",
|
|
179063
|
+
"enum": [
|
|
179064
|
+
"dir",
|
|
179065
|
+
"file",
|
|
179066
|
+
"submodule",
|
|
179067
|
+
"symlink"
|
|
179068
|
+
]
|
|
178981
179069
|
},
|
|
178982
179070
|
"size": {
|
|
178983
179071
|
"type": "integer"
|
|
@@ -179058,7 +179146,10 @@
|
|
|
179058
179146
|
"type": "object",
|
|
179059
179147
|
"properties": {
|
|
179060
179148
|
"type": {
|
|
179061
|
-
"type": "string"
|
|
179149
|
+
"type": "string",
|
|
179150
|
+
"enum": [
|
|
179151
|
+
"file"
|
|
179152
|
+
]
|
|
179062
179153
|
},
|
|
179063
179154
|
"encoding": {
|
|
179064
179155
|
"type": "string"
|
|
@@ -179151,7 +179242,10 @@
|
|
|
179151
179242
|
"type": "object",
|
|
179152
179243
|
"properties": {
|
|
179153
179244
|
"type": {
|
|
179154
|
-
"type": "string"
|
|
179245
|
+
"type": "string",
|
|
179246
|
+
"enum": [
|
|
179247
|
+
"symlink"
|
|
179248
|
+
]
|
|
179155
179249
|
},
|
|
179156
179250
|
"target": {
|
|
179157
179251
|
"type": "string"
|
|
@@ -179227,12 +179321,15 @@
|
|
|
179227
179321
|
]
|
|
179228
179322
|
},
|
|
179229
179323
|
{
|
|
179230
|
-
"title": "
|
|
179231
|
-
"description": "An object describing a
|
|
179324
|
+
"title": "Submodule Content",
|
|
179325
|
+
"description": "An object describing a submodule",
|
|
179232
179326
|
"type": "object",
|
|
179233
179327
|
"properties": {
|
|
179234
179328
|
"type": {
|
|
179235
|
-
"type": "string"
|
|
179329
|
+
"type": "string",
|
|
179330
|
+
"enum": [
|
|
179331
|
+
"submodule"
|
|
179332
|
+
]
|
|
179236
179333
|
},
|
|
179237
179334
|
"submodule_git_url": {
|
|
179238
179335
|
"type": "string",
|
|
@@ -185078,15 +185175,15 @@
|
|
|
185078
185175
|
},
|
|
185079
185176
|
"/repos/{owner}/{repo}/environments": {
|
|
185080
185177
|
"get": {
|
|
185081
|
-
"summary": "
|
|
185082
|
-
"description": "
|
|
185178
|
+
"summary": "List environments",
|
|
185179
|
+
"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.",
|
|
185083
185180
|
"tags": [
|
|
185084
185181
|
"repos"
|
|
185085
185182
|
],
|
|
185086
185183
|
"operationId": "repos/get-all-environments",
|
|
185087
185184
|
"externalDocs": {
|
|
185088
185185
|
"description": "API method documentation",
|
|
185089
|
-
"url": "https://docs.github.com/github-ae@latest/rest/
|
|
185186
|
+
"url": "https://docs.github.com/github-ae@latest/rest/deployments/environments#list-environments"
|
|
185090
185187
|
},
|
|
185091
185188
|
"parameters": [
|
|
185092
185189
|
{
|
|
@@ -185685,7 +185782,7 @@
|
|
|
185685
185782
|
"x-github": {
|
|
185686
185783
|
"githubCloudOnly": false,
|
|
185687
185784
|
"enabledForGitHubApps": true,
|
|
185688
|
-
"category": "
|
|
185785
|
+
"category": "deployments",
|
|
185689
185786
|
"subcategory": "environments"
|
|
185690
185787
|
},
|
|
185691
185788
|
"x-octokit": {}
|
|
@@ -185694,7 +185791,7 @@
|
|
|
185694
185791
|
"/repos/{owner}/{repo}/environments/{environment_name}": {
|
|
185695
185792
|
"get": {
|
|
185696
185793
|
"summary": "Get an environment",
|
|
185697
|
-
"description": "
|
|
185794
|
+
"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.",
|
|
185698
185795
|
"tags": [
|
|
185699
185796
|
"repos"
|
|
185700
185797
|
],
|
|
@@ -185726,7 +185823,7 @@
|
|
|
185726
185823
|
"name": "environment_name",
|
|
185727
185824
|
"in": "path",
|
|
185728
185825
|
"required": true,
|
|
185729
|
-
"description": "The name of the environment",
|
|
185826
|
+
"description": "The name of the environment.",
|
|
185730
185827
|
"schema": {
|
|
185731
185828
|
"type": "string"
|
|
185732
185829
|
}
|
|
@@ -186280,7 +186377,7 @@
|
|
|
186280
186377
|
},
|
|
186281
186378
|
"put": {
|
|
186282
186379
|
"summary": "Create or update an environment",
|
|
186283
|
-
"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:**
|
|
186380
|
+
"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.",
|
|
186284
186381
|
"tags": [
|
|
186285
186382
|
"repos"
|
|
186286
186383
|
],
|
|
@@ -186312,7 +186409,7 @@
|
|
|
186312
186409
|
"name": "environment_name",
|
|
186313
186410
|
"in": "path",
|
|
186314
186411
|
"required": true,
|
|
186315
|
-
"description": "The name of the environment",
|
|
186412
|
+
"description": "The name of the environment.",
|
|
186316
186413
|
"schema": {
|
|
186317
186414
|
"type": "string"
|
|
186318
186415
|
}
|
|
@@ -186376,6 +186473,27 @@
|
|
|
186376
186473
|
}
|
|
186377
186474
|
},
|
|
186378
186475
|
"additionalProperties": false
|
|
186476
|
+
},
|
|
186477
|
+
"examples": {
|
|
186478
|
+
"default": {
|
|
186479
|
+
"value": {
|
|
186480
|
+
"wait_timer": 30,
|
|
186481
|
+
"reviewers": [
|
|
186482
|
+
{
|
|
186483
|
+
"type": "User",
|
|
186484
|
+
"id": 1
|
|
186485
|
+
},
|
|
186486
|
+
{
|
|
186487
|
+
"type": "Team",
|
|
186488
|
+
"id": 1
|
|
186489
|
+
}
|
|
186490
|
+
],
|
|
186491
|
+
"deployment_branch_policy": {
|
|
186492
|
+
"protected_branches": false,
|
|
186493
|
+
"custom_branch_policies": true
|
|
186494
|
+
}
|
|
186495
|
+
}
|
|
186496
|
+
}
|
|
186379
186497
|
}
|
|
186380
186498
|
}
|
|
186381
186499
|
}
|
|
@@ -186986,7 +187104,7 @@
|
|
|
186986
187104
|
"name": "environment_name",
|
|
186987
187105
|
"in": "path",
|
|
186988
187106
|
"required": true,
|
|
186989
|
-
"description": "The name of the environment",
|
|
187107
|
+
"description": "The name of the environment.",
|
|
186990
187108
|
"schema": {
|
|
186991
187109
|
"type": "string"
|
|
186992
187110
|
}
|
|
@@ -187006,6 +187124,559 @@
|
|
|
187006
187124
|
"x-octokit": {}
|
|
187007
187125
|
}
|
|
187008
187126
|
},
|
|
187127
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies": {
|
|
187128
|
+
"get": {
|
|
187129
|
+
"summary": "List deployment branch policies",
|
|
187130
|
+
"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.",
|
|
187131
|
+
"tags": [
|
|
187132
|
+
"repos"
|
|
187133
|
+
],
|
|
187134
|
+
"operationId": "repos/list-deployment-branch-policies",
|
|
187135
|
+
"externalDocs": {
|
|
187136
|
+
"description": "API method documentation",
|
|
187137
|
+
"url": "https://docs.github.com/github-ae@latest/rest/deployments/branch-policies#list-deployment-branch-policies"
|
|
187138
|
+
},
|
|
187139
|
+
"parameters": [
|
|
187140
|
+
{
|
|
187141
|
+
"name": "owner",
|
|
187142
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
187143
|
+
"in": "path",
|
|
187144
|
+
"required": true,
|
|
187145
|
+
"schema": {
|
|
187146
|
+
"type": "string"
|
|
187147
|
+
}
|
|
187148
|
+
},
|
|
187149
|
+
{
|
|
187150
|
+
"name": "repo",
|
|
187151
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
187152
|
+
"in": "path",
|
|
187153
|
+
"required": true,
|
|
187154
|
+
"schema": {
|
|
187155
|
+
"type": "string"
|
|
187156
|
+
}
|
|
187157
|
+
},
|
|
187158
|
+
{
|
|
187159
|
+
"name": "environment_name",
|
|
187160
|
+
"in": "path",
|
|
187161
|
+
"required": true,
|
|
187162
|
+
"description": "The name of the environment.",
|
|
187163
|
+
"schema": {
|
|
187164
|
+
"type": "string"
|
|
187165
|
+
}
|
|
187166
|
+
},
|
|
187167
|
+
{
|
|
187168
|
+
"name": "per_page",
|
|
187169
|
+
"description": "The number of results per page (max 100).",
|
|
187170
|
+
"in": "query",
|
|
187171
|
+
"schema": {
|
|
187172
|
+
"type": "integer",
|
|
187173
|
+
"default": 30
|
|
187174
|
+
}
|
|
187175
|
+
},
|
|
187176
|
+
{
|
|
187177
|
+
"name": "page",
|
|
187178
|
+
"description": "Page number of the results to fetch.",
|
|
187179
|
+
"in": "query",
|
|
187180
|
+
"schema": {
|
|
187181
|
+
"type": "integer",
|
|
187182
|
+
"default": 1
|
|
187183
|
+
}
|
|
187184
|
+
}
|
|
187185
|
+
],
|
|
187186
|
+
"responses": {
|
|
187187
|
+
"200": {
|
|
187188
|
+
"description": "Response",
|
|
187189
|
+
"content": {
|
|
187190
|
+
"application/json": {
|
|
187191
|
+
"schema": {
|
|
187192
|
+
"type": "object",
|
|
187193
|
+
"properties": {
|
|
187194
|
+
"total_count": {
|
|
187195
|
+
"description": "The number of deployment branch policies for the environment.",
|
|
187196
|
+
"type": "integer",
|
|
187197
|
+
"example": 2
|
|
187198
|
+
},
|
|
187199
|
+
"branch_policies": {
|
|
187200
|
+
"type": "array",
|
|
187201
|
+
"items": {
|
|
187202
|
+
"title": "Deployment branch policy",
|
|
187203
|
+
"description": "Details of a deployment branch policy.",
|
|
187204
|
+
"type": "object",
|
|
187205
|
+
"properties": {
|
|
187206
|
+
"id": {
|
|
187207
|
+
"description": "The unique identifier of the branch policy.",
|
|
187208
|
+
"type": "integer",
|
|
187209
|
+
"example": 361471
|
|
187210
|
+
},
|
|
187211
|
+
"node_id": {
|
|
187212
|
+
"type": "string",
|
|
187213
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
187214
|
+
},
|
|
187215
|
+
"name": {
|
|
187216
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
187217
|
+
"type": "string",
|
|
187218
|
+
"example": "release/*"
|
|
187219
|
+
}
|
|
187220
|
+
}
|
|
187221
|
+
}
|
|
187222
|
+
}
|
|
187223
|
+
},
|
|
187224
|
+
"required": [
|
|
187225
|
+
"total_count",
|
|
187226
|
+
"branch_policies"
|
|
187227
|
+
]
|
|
187228
|
+
},
|
|
187229
|
+
"examples": {
|
|
187230
|
+
"default": {
|
|
187231
|
+
"value": {
|
|
187232
|
+
"total_count": 2,
|
|
187233
|
+
"branch_policies": [
|
|
187234
|
+
{
|
|
187235
|
+
"id": 361471,
|
|
187236
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=",
|
|
187237
|
+
"name": "release/*"
|
|
187238
|
+
},
|
|
187239
|
+
{
|
|
187240
|
+
"id": 361472,
|
|
187241
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzI=",
|
|
187242
|
+
"name": "main"
|
|
187243
|
+
}
|
|
187244
|
+
]
|
|
187245
|
+
}
|
|
187246
|
+
}
|
|
187247
|
+
}
|
|
187248
|
+
}
|
|
187249
|
+
}
|
|
187250
|
+
}
|
|
187251
|
+
},
|
|
187252
|
+
"x-github": {
|
|
187253
|
+
"githubCloudOnly": false,
|
|
187254
|
+
"enabledForGitHubApps": true,
|
|
187255
|
+
"category": "deployments",
|
|
187256
|
+
"subcategory": "branch-policies"
|
|
187257
|
+
},
|
|
187258
|
+
"x-octokit": {}
|
|
187259
|
+
},
|
|
187260
|
+
"post": {
|
|
187261
|
+
"summary": "Create a deployment branch policy",
|
|
187262
|
+
"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.",
|
|
187263
|
+
"tags": [
|
|
187264
|
+
"repos"
|
|
187265
|
+
],
|
|
187266
|
+
"operationId": "repos/create-deployment-branch-policy",
|
|
187267
|
+
"externalDocs": {
|
|
187268
|
+
"description": "API method documentation",
|
|
187269
|
+
"url": "https://docs.github.com/github-ae@latest/rest/deployments/branch-policies#create-deployment-branch-policy"
|
|
187270
|
+
},
|
|
187271
|
+
"parameters": [
|
|
187272
|
+
{
|
|
187273
|
+
"name": "owner",
|
|
187274
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
187275
|
+
"in": "path",
|
|
187276
|
+
"required": true,
|
|
187277
|
+
"schema": {
|
|
187278
|
+
"type": "string"
|
|
187279
|
+
}
|
|
187280
|
+
},
|
|
187281
|
+
{
|
|
187282
|
+
"name": "repo",
|
|
187283
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
187284
|
+
"in": "path",
|
|
187285
|
+
"required": true,
|
|
187286
|
+
"schema": {
|
|
187287
|
+
"type": "string"
|
|
187288
|
+
}
|
|
187289
|
+
},
|
|
187290
|
+
{
|
|
187291
|
+
"name": "environment_name",
|
|
187292
|
+
"in": "path",
|
|
187293
|
+
"required": true,
|
|
187294
|
+
"description": "The name of the environment.",
|
|
187295
|
+
"schema": {
|
|
187296
|
+
"type": "string"
|
|
187297
|
+
}
|
|
187298
|
+
}
|
|
187299
|
+
],
|
|
187300
|
+
"requestBody": {
|
|
187301
|
+
"required": true,
|
|
187302
|
+
"content": {
|
|
187303
|
+
"application/json": {
|
|
187304
|
+
"schema": {
|
|
187305
|
+
"title": "Deployment branch policy name pattern",
|
|
187306
|
+
"type": "object",
|
|
187307
|
+
"properties": {
|
|
187308
|
+
"name": {
|
|
187309
|
+
"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).",
|
|
187310
|
+
"type": "string",
|
|
187311
|
+
"example": "release/*"
|
|
187312
|
+
}
|
|
187313
|
+
},
|
|
187314
|
+
"required": [
|
|
187315
|
+
"name"
|
|
187316
|
+
]
|
|
187317
|
+
},
|
|
187318
|
+
"examples": {
|
|
187319
|
+
"example-wildcard": {
|
|
187320
|
+
"summary": "Example of a wildcard name pattern",
|
|
187321
|
+
"value": {
|
|
187322
|
+
"name": "release/*"
|
|
187323
|
+
}
|
|
187324
|
+
},
|
|
187325
|
+
"example-single-branch": {
|
|
187326
|
+
"summary": "Example of a single branch name pattern",
|
|
187327
|
+
"value": {
|
|
187328
|
+
"name": "main"
|
|
187329
|
+
}
|
|
187330
|
+
}
|
|
187331
|
+
}
|
|
187332
|
+
}
|
|
187333
|
+
}
|
|
187334
|
+
},
|
|
187335
|
+
"responses": {
|
|
187336
|
+
"200": {
|
|
187337
|
+
"description": "Response",
|
|
187338
|
+
"content": {
|
|
187339
|
+
"application/json": {
|
|
187340
|
+
"schema": {
|
|
187341
|
+
"title": "Deployment branch policy",
|
|
187342
|
+
"description": "Details of a deployment branch policy.",
|
|
187343
|
+
"type": "object",
|
|
187344
|
+
"properties": {
|
|
187345
|
+
"id": {
|
|
187346
|
+
"description": "The unique identifier of the branch policy.",
|
|
187347
|
+
"type": "integer",
|
|
187348
|
+
"example": 361471
|
|
187349
|
+
},
|
|
187350
|
+
"node_id": {
|
|
187351
|
+
"type": "string",
|
|
187352
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
187353
|
+
},
|
|
187354
|
+
"name": {
|
|
187355
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
187356
|
+
"type": "string",
|
|
187357
|
+
"example": "release/*"
|
|
187358
|
+
}
|
|
187359
|
+
}
|
|
187360
|
+
},
|
|
187361
|
+
"examples": {
|
|
187362
|
+
"example-wildcard": {
|
|
187363
|
+
"value": {
|
|
187364
|
+
"id": 364662,
|
|
187365
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
187366
|
+
"name": "release/*"
|
|
187367
|
+
}
|
|
187368
|
+
},
|
|
187369
|
+
"example-single-branch": {
|
|
187370
|
+
"value": {
|
|
187371
|
+
"id": 364663,
|
|
187372
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=",
|
|
187373
|
+
"name": "main"
|
|
187374
|
+
}
|
|
187375
|
+
}
|
|
187376
|
+
}
|
|
187377
|
+
}
|
|
187378
|
+
}
|
|
187379
|
+
},
|
|
187380
|
+
"303": {
|
|
187381
|
+
"description": "Response if the same branch name pattern already exists"
|
|
187382
|
+
},
|
|
187383
|
+
"404": {
|
|
187384
|
+
"description": "Not Found or `deployment_branch_policy.custom_branch_policies` property for the environment is set to false"
|
|
187385
|
+
}
|
|
187386
|
+
},
|
|
187387
|
+
"x-github": {
|
|
187388
|
+
"githubCloudOnly": false,
|
|
187389
|
+
"enabledForGitHubApps": true,
|
|
187390
|
+
"category": "deployments",
|
|
187391
|
+
"subcategory": "branch-policies"
|
|
187392
|
+
},
|
|
187393
|
+
"x-octokit": {}
|
|
187394
|
+
}
|
|
187395
|
+
},
|
|
187396
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": {
|
|
187397
|
+
"get": {
|
|
187398
|
+
"summary": "Get a deployment branch policy",
|
|
187399
|
+
"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.",
|
|
187400
|
+
"tags": [
|
|
187401
|
+
"repos"
|
|
187402
|
+
],
|
|
187403
|
+
"operationId": "repos/get-deployment-branch-policy",
|
|
187404
|
+
"externalDocs": {
|
|
187405
|
+
"description": "API method documentation",
|
|
187406
|
+
"url": "https://docs.github.com/github-ae@latest/rest/deployments/branch-policies#get-deployment-branch-policy"
|
|
187407
|
+
},
|
|
187408
|
+
"parameters": [
|
|
187409
|
+
{
|
|
187410
|
+
"name": "owner",
|
|
187411
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
187412
|
+
"in": "path",
|
|
187413
|
+
"required": true,
|
|
187414
|
+
"schema": {
|
|
187415
|
+
"type": "string"
|
|
187416
|
+
}
|
|
187417
|
+
},
|
|
187418
|
+
{
|
|
187419
|
+
"name": "repo",
|
|
187420
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
187421
|
+
"in": "path",
|
|
187422
|
+
"required": true,
|
|
187423
|
+
"schema": {
|
|
187424
|
+
"type": "string"
|
|
187425
|
+
}
|
|
187426
|
+
},
|
|
187427
|
+
{
|
|
187428
|
+
"name": "environment_name",
|
|
187429
|
+
"in": "path",
|
|
187430
|
+
"required": true,
|
|
187431
|
+
"description": "The name of the environment.",
|
|
187432
|
+
"schema": {
|
|
187433
|
+
"type": "string"
|
|
187434
|
+
}
|
|
187435
|
+
},
|
|
187436
|
+
{
|
|
187437
|
+
"name": "branch_policy_id",
|
|
187438
|
+
"in": "path",
|
|
187439
|
+
"required": true,
|
|
187440
|
+
"description": "The unique identifier of the branch policy.",
|
|
187441
|
+
"schema": {
|
|
187442
|
+
"type": "integer"
|
|
187443
|
+
}
|
|
187444
|
+
}
|
|
187445
|
+
],
|
|
187446
|
+
"responses": {
|
|
187447
|
+
"200": {
|
|
187448
|
+
"description": "Response",
|
|
187449
|
+
"content": {
|
|
187450
|
+
"application/json": {
|
|
187451
|
+
"schema": {
|
|
187452
|
+
"title": "Deployment branch policy",
|
|
187453
|
+
"description": "Details of a deployment branch policy.",
|
|
187454
|
+
"type": "object",
|
|
187455
|
+
"properties": {
|
|
187456
|
+
"id": {
|
|
187457
|
+
"description": "The unique identifier of the branch policy.",
|
|
187458
|
+
"type": "integer",
|
|
187459
|
+
"example": 361471
|
|
187460
|
+
},
|
|
187461
|
+
"node_id": {
|
|
187462
|
+
"type": "string",
|
|
187463
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
187464
|
+
},
|
|
187465
|
+
"name": {
|
|
187466
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
187467
|
+
"type": "string",
|
|
187468
|
+
"example": "release/*"
|
|
187469
|
+
}
|
|
187470
|
+
}
|
|
187471
|
+
},
|
|
187472
|
+
"examples": {
|
|
187473
|
+
"default": {
|
|
187474
|
+
"value": {
|
|
187475
|
+
"id": 364662,
|
|
187476
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
187477
|
+
"name": "release/*"
|
|
187478
|
+
}
|
|
187479
|
+
}
|
|
187480
|
+
}
|
|
187481
|
+
}
|
|
187482
|
+
}
|
|
187483
|
+
}
|
|
187484
|
+
},
|
|
187485
|
+
"x-github": {
|
|
187486
|
+
"githubCloudOnly": false,
|
|
187487
|
+
"enabledForGitHubApps": true,
|
|
187488
|
+
"category": "deployments",
|
|
187489
|
+
"subcategory": "branch-policies"
|
|
187490
|
+
},
|
|
187491
|
+
"x-octokit": {}
|
|
187492
|
+
},
|
|
187493
|
+
"put": {
|
|
187494
|
+
"summary": "Update a deployment branch policy",
|
|
187495
|
+
"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.",
|
|
187496
|
+
"tags": [
|
|
187497
|
+
"repos"
|
|
187498
|
+
],
|
|
187499
|
+
"operationId": "repos/update-deployment-branch-policy",
|
|
187500
|
+
"externalDocs": {
|
|
187501
|
+
"description": "API method documentation",
|
|
187502
|
+
"url": "https://docs.github.com/github-ae@latest/rest/deployments/branch-policies#update-deployment-branch-policy"
|
|
187503
|
+
},
|
|
187504
|
+
"parameters": [
|
|
187505
|
+
{
|
|
187506
|
+
"name": "owner",
|
|
187507
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
187508
|
+
"in": "path",
|
|
187509
|
+
"required": true,
|
|
187510
|
+
"schema": {
|
|
187511
|
+
"type": "string"
|
|
187512
|
+
}
|
|
187513
|
+
},
|
|
187514
|
+
{
|
|
187515
|
+
"name": "repo",
|
|
187516
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
187517
|
+
"in": "path",
|
|
187518
|
+
"required": true,
|
|
187519
|
+
"schema": {
|
|
187520
|
+
"type": "string"
|
|
187521
|
+
}
|
|
187522
|
+
},
|
|
187523
|
+
{
|
|
187524
|
+
"name": "environment_name",
|
|
187525
|
+
"in": "path",
|
|
187526
|
+
"required": true,
|
|
187527
|
+
"description": "The name of the environment.",
|
|
187528
|
+
"schema": {
|
|
187529
|
+
"type": "string"
|
|
187530
|
+
}
|
|
187531
|
+
},
|
|
187532
|
+
{
|
|
187533
|
+
"name": "branch_policy_id",
|
|
187534
|
+
"in": "path",
|
|
187535
|
+
"required": true,
|
|
187536
|
+
"description": "The unique identifier of the branch policy.",
|
|
187537
|
+
"schema": {
|
|
187538
|
+
"type": "integer"
|
|
187539
|
+
}
|
|
187540
|
+
}
|
|
187541
|
+
],
|
|
187542
|
+
"requestBody": {
|
|
187543
|
+
"required": true,
|
|
187544
|
+
"content": {
|
|
187545
|
+
"application/json": {
|
|
187546
|
+
"schema": {
|
|
187547
|
+
"title": "Deployment branch policy name pattern",
|
|
187548
|
+
"type": "object",
|
|
187549
|
+
"properties": {
|
|
187550
|
+
"name": {
|
|
187551
|
+
"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).",
|
|
187552
|
+
"type": "string",
|
|
187553
|
+
"example": "release/*"
|
|
187554
|
+
}
|
|
187555
|
+
},
|
|
187556
|
+
"required": [
|
|
187557
|
+
"name"
|
|
187558
|
+
]
|
|
187559
|
+
},
|
|
187560
|
+
"examples": {
|
|
187561
|
+
"default": {
|
|
187562
|
+
"value": {
|
|
187563
|
+
"name": "release/*"
|
|
187564
|
+
}
|
|
187565
|
+
}
|
|
187566
|
+
}
|
|
187567
|
+
}
|
|
187568
|
+
}
|
|
187569
|
+
},
|
|
187570
|
+
"responses": {
|
|
187571
|
+
"200": {
|
|
187572
|
+
"description": "Response",
|
|
187573
|
+
"content": {
|
|
187574
|
+
"application/json": {
|
|
187575
|
+
"schema": {
|
|
187576
|
+
"title": "Deployment branch policy",
|
|
187577
|
+
"description": "Details of a deployment branch policy.",
|
|
187578
|
+
"type": "object",
|
|
187579
|
+
"properties": {
|
|
187580
|
+
"id": {
|
|
187581
|
+
"description": "The unique identifier of the branch policy.",
|
|
187582
|
+
"type": "integer",
|
|
187583
|
+
"example": 361471
|
|
187584
|
+
},
|
|
187585
|
+
"node_id": {
|
|
187586
|
+
"type": "string",
|
|
187587
|
+
"example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE="
|
|
187588
|
+
},
|
|
187589
|
+
"name": {
|
|
187590
|
+
"description": "The name pattern that branches must match in order to deploy to the environment.",
|
|
187591
|
+
"type": "string",
|
|
187592
|
+
"example": "release/*"
|
|
187593
|
+
}
|
|
187594
|
+
}
|
|
187595
|
+
},
|
|
187596
|
+
"examples": {
|
|
187597
|
+
"default": {
|
|
187598
|
+
"value": {
|
|
187599
|
+
"id": 364662,
|
|
187600
|
+
"node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=",
|
|
187601
|
+
"name": "release/*"
|
|
187602
|
+
}
|
|
187603
|
+
}
|
|
187604
|
+
}
|
|
187605
|
+
}
|
|
187606
|
+
}
|
|
187607
|
+
}
|
|
187608
|
+
},
|
|
187609
|
+
"x-github": {
|
|
187610
|
+
"githubCloudOnly": false,
|
|
187611
|
+
"enabledForGitHubApps": true,
|
|
187612
|
+
"category": "deployments",
|
|
187613
|
+
"subcategory": "branch-policies"
|
|
187614
|
+
},
|
|
187615
|
+
"x-octokit": {}
|
|
187616
|
+
},
|
|
187617
|
+
"delete": {
|
|
187618
|
+
"summary": "Delete a deployment branch policy",
|
|
187619
|
+
"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.",
|
|
187620
|
+
"tags": [
|
|
187621
|
+
"repos"
|
|
187622
|
+
],
|
|
187623
|
+
"operationId": "repos/delete-deployment-branch-policy",
|
|
187624
|
+
"externalDocs": {
|
|
187625
|
+
"description": "API method documentation",
|
|
187626
|
+
"url": "https://docs.github.com/github-ae@latest/rest/deployments/branch-policies#delete-deployment-branch-policy"
|
|
187627
|
+
},
|
|
187628
|
+
"parameters": [
|
|
187629
|
+
{
|
|
187630
|
+
"name": "owner",
|
|
187631
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
187632
|
+
"in": "path",
|
|
187633
|
+
"required": true,
|
|
187634
|
+
"schema": {
|
|
187635
|
+
"type": "string"
|
|
187636
|
+
}
|
|
187637
|
+
},
|
|
187638
|
+
{
|
|
187639
|
+
"name": "repo",
|
|
187640
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
187641
|
+
"in": "path",
|
|
187642
|
+
"required": true,
|
|
187643
|
+
"schema": {
|
|
187644
|
+
"type": "string"
|
|
187645
|
+
}
|
|
187646
|
+
},
|
|
187647
|
+
{
|
|
187648
|
+
"name": "environment_name",
|
|
187649
|
+
"in": "path",
|
|
187650
|
+
"required": true,
|
|
187651
|
+
"description": "The name of the environment.",
|
|
187652
|
+
"schema": {
|
|
187653
|
+
"type": "string"
|
|
187654
|
+
}
|
|
187655
|
+
},
|
|
187656
|
+
{
|
|
187657
|
+
"name": "branch_policy_id",
|
|
187658
|
+
"in": "path",
|
|
187659
|
+
"required": true,
|
|
187660
|
+
"description": "The unique identifier of the branch policy.",
|
|
187661
|
+
"schema": {
|
|
187662
|
+
"type": "integer"
|
|
187663
|
+
}
|
|
187664
|
+
}
|
|
187665
|
+
],
|
|
187666
|
+
"responses": {
|
|
187667
|
+
"204": {
|
|
187668
|
+
"description": "Response"
|
|
187669
|
+
}
|
|
187670
|
+
},
|
|
187671
|
+
"x-github": {
|
|
187672
|
+
"githubCloudOnly": false,
|
|
187673
|
+
"enabledForGitHubApps": true,
|
|
187674
|
+
"category": "deployments",
|
|
187675
|
+
"subcategory": "branch-policies"
|
|
187676
|
+
},
|
|
187677
|
+
"x-octokit": {}
|
|
187678
|
+
}
|
|
187679
|
+
},
|
|
187009
187680
|
"/repos/{owner}/{repo}/events": {
|
|
187010
187681
|
"get": {
|
|
187011
187682
|
"summary": "List repository events",
|
|
@@ -203495,6 +204166,14 @@
|
|
|
203495
204166
|
"write"
|
|
203496
204167
|
]
|
|
203497
204168
|
},
|
|
204169
|
+
"organization_custom_roles": {
|
|
204170
|
+
"type": "string",
|
|
204171
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
204172
|
+
"enum": [
|
|
204173
|
+
"read",
|
|
204174
|
+
"write"
|
|
204175
|
+
]
|
|
204176
|
+
},
|
|
203498
204177
|
"deployments": {
|
|
203499
204178
|
"type": "string",
|
|
203500
204179
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -302423,7 +303102,10 @@
|
|
|
302423
303102
|
"type": "object",
|
|
302424
303103
|
"properties": {
|
|
302425
303104
|
"type": {
|
|
302426
|
-
"type": "string"
|
|
303105
|
+
"type": "string",
|
|
303106
|
+
"enum": [
|
|
303107
|
+
"file"
|
|
303108
|
+
]
|
|
302427
303109
|
},
|
|
302428
303110
|
"encoding": {
|
|
302429
303111
|
"type": "string"
|
|
@@ -302702,7 +303384,10 @@
|
|
|
302702
303384
|
"type": "object",
|
|
302703
303385
|
"properties": {
|
|
302704
303386
|
"type": {
|
|
302705
|
-
"type": "string"
|
|
303387
|
+
"type": "string",
|
|
303388
|
+
"enum": [
|
|
303389
|
+
"file"
|
|
303390
|
+
]
|
|
302706
303391
|
},
|
|
302707
303392
|
"encoding": {
|
|
302708
303393
|
"type": "string"
|
|
@@ -341535,6 +342220,14 @@
|
|
|
341535
342220
|
"write"
|
|
341536
342221
|
]
|
|
341537
342222
|
},
|
|
342223
|
+
"organization_custom_roles": {
|
|
342224
|
+
"type": "string",
|
|
342225
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
342226
|
+
"enum": [
|
|
342227
|
+
"read",
|
|
342228
|
+
"write"
|
|
342229
|
+
]
|
|
342230
|
+
},
|
|
341538
342231
|
"deployments": {
|
|
341539
342232
|
"type": "string",
|
|
341540
342233
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -374663,6 +375356,14 @@
|
|
|
374663
375356
|
"write"
|
|
374664
375357
|
]
|
|
374665
375358
|
},
|
|
375359
|
+
"organization_custom_roles": {
|
|
375360
|
+
"type": "string",
|
|
375361
|
+
"description": "The level of permission to grant the access token for custom roles management.",
|
|
375362
|
+
"enum": [
|
|
375363
|
+
"read",
|
|
375364
|
+
"write"
|
|
375365
|
+
]
|
|
375366
|
+
},
|
|
374666
375367
|
"deployments": {
|
|
374667
375368
|
"type": "string",
|
|
374668
375369
|
"description": "The level of permission to grant the access token for deployments and deployment statuses.",
|
|
@@ -382169,6 +382870,12 @@
|
|
|
382169
382870
|
"text/plain": {
|
|
382170
382871
|
"schema": {
|
|
382171
382872
|
"type": "string"
|
|
382873
|
+
},
|
|
382874
|
+
"examples": {
|
|
382875
|
+
"default": {
|
|
382876
|
+
"summary": "Example response",
|
|
382877
|
+
"value": "Responsive is better than fast"
|
|
382878
|
+
}
|
|
382172
382879
|
}
|
|
382173
382880
|
}
|
|
382174
382881
|
}
|
|
@@ -384482,6 +385189,50 @@
|
|
|
384482
385189
|
}
|
|
384483
385190
|
}
|
|
384484
385191
|
},
|
|
385192
|
+
"/enterprises/{enterprise}/consumed-licenses": {
|
|
385193
|
+
"get": {
|
|
385194
|
+
"summary": "List enterprise consumed licenses",
|
|
385195
|
+
"description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
|
|
385196
|
+
"tags": [
|
|
385197
|
+
"enterprise-admin"
|
|
385198
|
+
],
|
|
385199
|
+
"operationId": "enterprise-admin/get-consumed-licenses",
|
|
385200
|
+
"externalDocs": {
|
|
385201
|
+
"description": "API method documentation",
|
|
385202
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#list-enterprise-consumed-licenses"
|
|
385203
|
+
},
|
|
385204
|
+
"x-octokit": {
|
|
385205
|
+
"api.github.com": "removed"
|
|
385206
|
+
},
|
|
385207
|
+
"responses": {
|
|
385208
|
+
"501": {
|
|
385209
|
+
"description": "Not Implemented"
|
|
385210
|
+
}
|
|
385211
|
+
}
|
|
385212
|
+
}
|
|
385213
|
+
},
|
|
385214
|
+
"/enterprises/{enterprise}/license-sync-status": {
|
|
385215
|
+
"get": {
|
|
385216
|
+
"summary": "Get a license sync status",
|
|
385217
|
+
"description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.",
|
|
385218
|
+
"tags": [
|
|
385219
|
+
"enterprise-admin"
|
|
385220
|
+
],
|
|
385221
|
+
"operationId": "enterprise-admin/get-license-sync-status",
|
|
385222
|
+
"externalDocs": {
|
|
385223
|
+
"description": "API method documentation",
|
|
385224
|
+
"url": "https://docs.github.com/rest/reference/enterprise-admin#get-a-license-sync-status"
|
|
385225
|
+
},
|
|
385226
|
+
"x-octokit": {
|
|
385227
|
+
"api.github.com": "removed"
|
|
385228
|
+
},
|
|
385229
|
+
"responses": {
|
|
385230
|
+
"501": {
|
|
385231
|
+
"description": "Not Implemented"
|
|
385232
|
+
}
|
|
385233
|
+
}
|
|
385234
|
+
}
|
|
385235
|
+
},
|
|
384485
385236
|
"/enterprises/{enterprise}/secret-scanning/alerts": {
|
|
384486
385237
|
"get": {
|
|
384487
385238
|
"summary": "List secret scanning alerts for an enterprise",
|