@octokit/openapi 18.1.0 → 18.2.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 +4294 -322
- package/generated/api.github.com.json +538 -9
- package/generated/ghec.deref.json +11926 -3270
- package/generated/ghec.json +1041 -86
- package/generated/ghes-3.12.deref.json +2809 -282
- package/generated/ghes-3.12.json +175 -5
- package/generated/ghes-3.13.deref.json +2820 -283
- package/generated/ghes-3.13.json +186 -6
- package/generated/ghes-3.14.deref.json +2842 -65
- package/generated/ghes-3.14.json +242 -8
- package/generated/ghes-3.15.deref.json +3227 -363
- package/generated/ghes-3.15.json +399 -78
- package/generated/ghes-3.16.deref.json +3249 -145
- package/generated/ghes-3.16.json +399 -78
- package/package.json +1 -1
package/generated/ghes-3.13.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "18.
|
|
4
|
+
"version": "18.2.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": {
|
|
@@ -18633,6 +18633,15 @@
|
|
|
18633
18633
|
{
|
|
18634
18634
|
"$ref": "#/components/parameters/labels"
|
|
18635
18635
|
},
|
|
18636
|
+
{
|
|
18637
|
+
"name": "type",
|
|
18638
|
+
"description": "Can be the name of an issue type.",
|
|
18639
|
+
"in": "query",
|
|
18640
|
+
"required": false,
|
|
18641
|
+
"schema": {
|
|
18642
|
+
"type": "string"
|
|
18643
|
+
}
|
|
18644
|
+
},
|
|
18636
18645
|
{
|
|
18637
18646
|
"name": "sort",
|
|
18638
18647
|
"description": "What to sort results by.",
|
|
@@ -20218,6 +20227,9 @@
|
|
|
20218
20227
|
},
|
|
20219
20228
|
{
|
|
20220
20229
|
"$ref": "#/components/parameters/personal-access-token-after"
|
|
20230
|
+
},
|
|
20231
|
+
{
|
|
20232
|
+
"$ref": "#/components/parameters/personal-access-token-token-id"
|
|
20221
20233
|
}
|
|
20222
20234
|
],
|
|
20223
20235
|
"responses": {
|
|
@@ -20565,6 +20577,9 @@
|
|
|
20565
20577
|
},
|
|
20566
20578
|
{
|
|
20567
20579
|
"$ref": "#/components/parameters/personal-access-token-after"
|
|
20580
|
+
},
|
|
20581
|
+
{
|
|
20582
|
+
"$ref": "#/components/parameters/personal-access-token-token-id"
|
|
20568
20583
|
}
|
|
20569
20584
|
],
|
|
20570
20585
|
"responses": {
|
|
@@ -21297,7 +21312,7 @@
|
|
|
21297
21312
|
},
|
|
21298
21313
|
"patch": {
|
|
21299
21314
|
"summary": "Create or update custom properties for an organization",
|
|
21300
|
-
"description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
|
|
21315
|
+
"description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n - An administrator for the organization.\n - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
|
|
21301
21316
|
"tags": [
|
|
21302
21317
|
"orgs"
|
|
21303
21318
|
],
|
|
@@ -41369,7 +41384,7 @@
|
|
|
41369
41384
|
},
|
|
41370
41385
|
"post": {
|
|
41371
41386
|
"summary": "Create a custom deployment protection rule on an environment",
|
|
41372
|
-
"description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
41387
|
+
"description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.13/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.13/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
|
|
41373
41388
|
"tags": [
|
|
41374
41389
|
"repos"
|
|
41375
41390
|
],
|
|
@@ -44617,6 +44632,15 @@
|
|
|
44617
44632
|
"type": "string"
|
|
44618
44633
|
}
|
|
44619
44634
|
},
|
|
44635
|
+
{
|
|
44636
|
+
"name": "type",
|
|
44637
|
+
"description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.",
|
|
44638
|
+
"in": "query",
|
|
44639
|
+
"required": false,
|
|
44640
|
+
"schema": {
|
|
44641
|
+
"type": "string"
|
|
44642
|
+
}
|
|
44643
|
+
},
|
|
44620
44644
|
{
|
|
44621
44645
|
"name": "creator",
|
|
44622
44646
|
"description": "The user that created the issue.",
|
|
@@ -44802,6 +44826,12 @@
|
|
|
44802
44826
|
"items": {
|
|
44803
44827
|
"type": "string"
|
|
44804
44828
|
}
|
|
44829
|
+
},
|
|
44830
|
+
"type": {
|
|
44831
|
+
"type": "string",
|
|
44832
|
+
"description": "The name of the issue type to associate with this issue.",
|
|
44833
|
+
"nullable": true,
|
|
44834
|
+
"example": "Epic"
|
|
44805
44835
|
}
|
|
44806
44836
|
},
|
|
44807
44837
|
"required": [
|
|
@@ -45657,6 +45687,12 @@
|
|
|
45657
45687
|
"items": {
|
|
45658
45688
|
"type": "string"
|
|
45659
45689
|
}
|
|
45690
|
+
},
|
|
45691
|
+
"type": {
|
|
45692
|
+
"type": "string",
|
|
45693
|
+
"description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.",
|
|
45694
|
+
"nullable": true,
|
|
45695
|
+
"example": "Epic"
|
|
45660
45696
|
}
|
|
45661
45697
|
}
|
|
45662
45698
|
},
|
|
@@ -93551,7 +93587,7 @@
|
|
|
93551
93587
|
},
|
|
93552
93588
|
"dependabot_secrets": {
|
|
93553
93589
|
"type": "string",
|
|
93554
|
-
"description": "The
|
|
93590
|
+
"description": "The level of permission to grant the access token to manage Dependabot secrets.",
|
|
93555
93591
|
"enum": [
|
|
93556
93592
|
"read",
|
|
93557
93593
|
"write"
|
|
@@ -94872,6 +94908,7 @@
|
|
|
94872
94908
|
"id": {
|
|
94873
94909
|
"description": "Unique identifier of the webhook delivery.",
|
|
94874
94910
|
"type": "integer",
|
|
94911
|
+
"format": "int64",
|
|
94875
94912
|
"example": 42
|
|
94876
94913
|
},
|
|
94877
94914
|
"guid": {
|
|
@@ -94919,12 +94956,14 @@
|
|
|
94919
94956
|
"installation_id": {
|
|
94920
94957
|
"description": "The id of the GitHub App installation associated with this event.",
|
|
94921
94958
|
"type": "integer",
|
|
94959
|
+
"format": "int64",
|
|
94922
94960
|
"example": 123,
|
|
94923
94961
|
"nullable": true
|
|
94924
94962
|
},
|
|
94925
94963
|
"repository_id": {
|
|
94926
94964
|
"description": "The id of the repository associated with this event.",
|
|
94927
94965
|
"type": "integer",
|
|
94966
|
+
"format": "int64",
|
|
94928
94967
|
"example": 123,
|
|
94929
94968
|
"nullable": true
|
|
94930
94969
|
},
|
|
@@ -96699,12 +96738,12 @@
|
|
|
96699
96738
|
"type": "object",
|
|
96700
96739
|
"properties": {
|
|
96701
96740
|
"id": {
|
|
96702
|
-
"description": "The
|
|
96741
|
+
"description": "The ID of the runner.",
|
|
96703
96742
|
"type": "integer",
|
|
96704
96743
|
"example": 5
|
|
96705
96744
|
},
|
|
96706
96745
|
"runner_group_id": {
|
|
96707
|
-
"description": "The
|
|
96746
|
+
"description": "The ID of the runner group.",
|
|
96708
96747
|
"type": "integer",
|
|
96709
96748
|
"example": 1
|
|
96710
96749
|
},
|
|
@@ -98368,6 +98407,66 @@
|
|
|
98368
98407
|
],
|
|
98369
98408
|
"nullable": true
|
|
98370
98409
|
},
|
|
98410
|
+
"issue-type": {
|
|
98411
|
+
"title": "Issue Type",
|
|
98412
|
+
"description": "The type of issue.",
|
|
98413
|
+
"type": "object",
|
|
98414
|
+
"nullable": true,
|
|
98415
|
+
"properties": {
|
|
98416
|
+
"id": {
|
|
98417
|
+
"type": "integer",
|
|
98418
|
+
"description": "The unique identifier of the issue type."
|
|
98419
|
+
},
|
|
98420
|
+
"node_id": {
|
|
98421
|
+
"type": "string",
|
|
98422
|
+
"description": "The node identifier of the issue type."
|
|
98423
|
+
},
|
|
98424
|
+
"name": {
|
|
98425
|
+
"type": "string",
|
|
98426
|
+
"description": "The name of the issue type."
|
|
98427
|
+
},
|
|
98428
|
+
"description": {
|
|
98429
|
+
"type": "string",
|
|
98430
|
+
"description": "The description of the issue type.",
|
|
98431
|
+
"nullable": true
|
|
98432
|
+
},
|
|
98433
|
+
"color": {
|
|
98434
|
+
"type": "string",
|
|
98435
|
+
"description": "The color of the issue type.",
|
|
98436
|
+
"enum": [
|
|
98437
|
+
"gray",
|
|
98438
|
+
"blue",
|
|
98439
|
+
"green",
|
|
98440
|
+
"yellow",
|
|
98441
|
+
"orange",
|
|
98442
|
+
"red",
|
|
98443
|
+
"pink",
|
|
98444
|
+
"purple"
|
|
98445
|
+
],
|
|
98446
|
+
"nullable": true
|
|
98447
|
+
},
|
|
98448
|
+
"created_at": {
|
|
98449
|
+
"type": "string",
|
|
98450
|
+
"description": "The time the issue type created.",
|
|
98451
|
+
"format": "date-time"
|
|
98452
|
+
},
|
|
98453
|
+
"updated_at": {
|
|
98454
|
+
"type": "string",
|
|
98455
|
+
"description": "The time the issue type last updated.",
|
|
98456
|
+
"format": "date-time"
|
|
98457
|
+
},
|
|
98458
|
+
"is_enabled": {
|
|
98459
|
+
"type": "boolean",
|
|
98460
|
+
"description": "The enabled state of the issue type."
|
|
98461
|
+
}
|
|
98462
|
+
},
|
|
98463
|
+
"required": [
|
|
98464
|
+
"id",
|
|
98465
|
+
"node_id",
|
|
98466
|
+
"name",
|
|
98467
|
+
"description"
|
|
98468
|
+
]
|
|
98469
|
+
},
|
|
98371
98470
|
"nullable-integration": {
|
|
98372
98471
|
"title": "GitHub app",
|
|
98373
98472
|
"description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
|
|
@@ -98790,6 +98889,9 @@
|
|
|
98790
98889
|
"type": "string",
|
|
98791
98890
|
"format": "uri"
|
|
98792
98891
|
},
|
|
98892
|
+
"type": {
|
|
98893
|
+
"$ref": "#/components/schemas/issue-type"
|
|
98894
|
+
},
|
|
98793
98895
|
"repository": {
|
|
98794
98896
|
"$ref": "#/components/schemas/repository"
|
|
98795
98897
|
},
|
|
@@ -103974,6 +104076,16 @@
|
|
|
103974
104076
|
"maxItems": 200,
|
|
103975
104077
|
"nullable": true,
|
|
103976
104078
|
"description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
|
|
104079
|
+
},
|
|
104080
|
+
"values_editable_by": {
|
|
104081
|
+
"type": "string",
|
|
104082
|
+
"nullable": true,
|
|
104083
|
+
"enum": [
|
|
104084
|
+
"org_actors",
|
|
104085
|
+
"org_and_repo_actors"
|
|
104086
|
+
],
|
|
104087
|
+
"example": "org_actors",
|
|
104088
|
+
"description": "Who can edit the values of the property"
|
|
103977
104089
|
}
|
|
103978
104090
|
},
|
|
103979
104091
|
"required": [
|
|
@@ -115589,6 +115701,9 @@
|
|
|
115589
115701
|
"type": "string",
|
|
115590
115702
|
"format": "uri"
|
|
115591
115703
|
},
|
|
115704
|
+
"type": {
|
|
115705
|
+
"$ref": "#/components/schemas/issue-type"
|
|
115706
|
+
},
|
|
115592
115707
|
"repository": {
|
|
115593
115708
|
"$ref": "#/components/schemas/repository"
|
|
115594
115709
|
},
|
|
@@ -121191,6 +121306,9 @@
|
|
|
121191
121306
|
"type": "string",
|
|
121192
121307
|
"format": "uri"
|
|
121193
121308
|
},
|
|
121309
|
+
"type": {
|
|
121310
|
+
"$ref": "#/components/schemas/issue-type"
|
|
121311
|
+
},
|
|
121194
121312
|
"performed_via_github_app": {
|
|
121195
121313
|
"$ref": "#/components/schemas/nullable-integration"
|
|
121196
121314
|
},
|
|
@@ -127237,6 +127355,9 @@
|
|
|
127237
127355
|
"description": "Title of the issue",
|
|
127238
127356
|
"type": "string"
|
|
127239
127357
|
},
|
|
127358
|
+
"type": {
|
|
127359
|
+
"$ref": "#/components/schemas/issue-type"
|
|
127360
|
+
},
|
|
127240
127361
|
"updated_at": {
|
|
127241
127362
|
"type": "string",
|
|
127242
127363
|
"format": "date-time"
|
|
@@ -128628,6 +128749,9 @@
|
|
|
128628
128749
|
"description": "Title of the issue",
|
|
128629
128750
|
"type": "string"
|
|
128630
128751
|
},
|
|
128752
|
+
"type": {
|
|
128753
|
+
"$ref": "#/components/schemas/issue-type"
|
|
128754
|
+
},
|
|
128631
128755
|
"updated_at": {
|
|
128632
128756
|
"type": "string",
|
|
128633
128757
|
"format": "date-time"
|
|
@@ -152184,6 +152308,9 @@
|
|
|
152184
152308
|
"description": "Title of the issue",
|
|
152185
152309
|
"type": "string"
|
|
152186
152310
|
},
|
|
152311
|
+
"type": {
|
|
152312
|
+
"$ref": "#/components/schemas/issue-type"
|
|
152313
|
+
},
|
|
152187
152314
|
"updated_at": {
|
|
152188
152315
|
"type": "string",
|
|
152189
152316
|
"format": "date-time"
|
|
@@ -153766,6 +153893,9 @@
|
|
|
153766
153893
|
"description": "Title of the issue",
|
|
153767
153894
|
"type": "string"
|
|
153768
153895
|
},
|
|
153896
|
+
"type": {
|
|
153897
|
+
"$ref": "#/components/schemas/issue-type"
|
|
153898
|
+
},
|
|
153769
153899
|
"updated_at": {
|
|
153770
153900
|
"type": "string",
|
|
153771
153901
|
"format": "date-time"
|
|
@@ -155357,6 +155487,9 @@
|
|
|
155357
155487
|
"description": "Title of the issue",
|
|
155358
155488
|
"type": "string"
|
|
155359
155489
|
},
|
|
155490
|
+
"type": {
|
|
155491
|
+
"$ref": "#/components/schemas/issue-type"
|
|
155492
|
+
},
|
|
155360
155493
|
"updated_at": {
|
|
155361
155494
|
"type": "string",
|
|
155362
155495
|
"format": "date-time"
|
|
@@ -156982,6 +157115,9 @@
|
|
|
156982
157115
|
"description": "Title of the issue",
|
|
156983
157116
|
"type": "string"
|
|
156984
157117
|
},
|
|
157118
|
+
"type": {
|
|
157119
|
+
"$ref": "#/components/schemas/issue-type"
|
|
157120
|
+
},
|
|
156985
157121
|
"updated_at": {
|
|
156986
157122
|
"type": "string",
|
|
156987
157123
|
"format": "date-time"
|
|
@@ -158423,6 +158559,9 @@
|
|
|
158423
158559
|
"description": "Title of the issue",
|
|
158424
158560
|
"type": "string"
|
|
158425
158561
|
},
|
|
158562
|
+
"type": {
|
|
158563
|
+
"$ref": "#/components/schemas/issue-type"
|
|
158564
|
+
},
|
|
158426
158565
|
"updated_at": {
|
|
158427
158566
|
"type": "string",
|
|
158428
158567
|
"format": "date-time"
|
|
@@ -159685,6 +159824,9 @@
|
|
|
159685
159824
|
"description": "Title of the issue",
|
|
159686
159825
|
"type": "string"
|
|
159687
159826
|
},
|
|
159827
|
+
"type": {
|
|
159828
|
+
"$ref": "#/components/schemas/issue-type"
|
|
159829
|
+
},
|
|
159688
159830
|
"updated_at": {
|
|
159689
159831
|
"type": "string",
|
|
159690
159832
|
"format": "date-time"
|
|
@@ -160936,6 +161078,9 @@
|
|
|
160936
161078
|
"type": "string",
|
|
160937
161079
|
"format": "uri"
|
|
160938
161080
|
},
|
|
161081
|
+
"type": {
|
|
161082
|
+
"$ref": "#/components/schemas/issue-type"
|
|
161083
|
+
},
|
|
160939
161084
|
"title": {
|
|
160940
161085
|
"description": "Title of the issue",
|
|
160941
161086
|
"type": "string"
|
|
@@ -162184,6 +162329,9 @@
|
|
|
162184
162329
|
"type": "string",
|
|
162185
162330
|
"format": "uri"
|
|
162186
162331
|
},
|
|
162332
|
+
"type": {
|
|
162333
|
+
"$ref": "#/components/schemas/issue-type"
|
|
162334
|
+
},
|
|
162187
162335
|
"title": {
|
|
162188
162336
|
"description": "Title of the issue",
|
|
162189
162337
|
"type": "string"
|
|
@@ -163458,6 +163606,9 @@
|
|
|
163458
163606
|
"type": "string",
|
|
163459
163607
|
"format": "uri"
|
|
163460
163608
|
},
|
|
163609
|
+
"type": {
|
|
163610
|
+
"$ref": "#/components/schemas/issue-type"
|
|
163611
|
+
},
|
|
163461
163612
|
"title": {
|
|
163462
163613
|
"description": "Title of the issue",
|
|
163463
163614
|
"type": "string"
|
|
@@ -164700,6 +164851,9 @@
|
|
|
164700
164851
|
"description": "Title of the issue",
|
|
164701
164852
|
"type": "string"
|
|
164702
164853
|
},
|
|
164854
|
+
"type": {
|
|
164855
|
+
"$ref": "#/components/schemas/issue-type"
|
|
164856
|
+
},
|
|
164703
164857
|
"updated_at": {
|
|
164704
164858
|
"type": "string",
|
|
164705
164859
|
"format": "date-time"
|
|
@@ -167748,6 +167902,9 @@
|
|
|
167748
167902
|
"description": "Title of the issue",
|
|
167749
167903
|
"type": "string"
|
|
167750
167904
|
},
|
|
167905
|
+
"type": {
|
|
167906
|
+
"$ref": "#/components/schemas/issue-type"
|
|
167907
|
+
},
|
|
167751
167908
|
"updated_at": {
|
|
167752
167909
|
"type": "string",
|
|
167753
167910
|
"format": "date-time"
|
|
@@ -169154,6 +169311,9 @@
|
|
|
169154
169311
|
"type": "string"
|
|
169155
169312
|
}
|
|
169156
169313
|
}
|
|
169314
|
+
},
|
|
169315
|
+
"type": {
|
|
169316
|
+
"$ref": "#/components/schemas/issue-type"
|
|
169157
169317
|
}
|
|
169158
169318
|
}
|
|
169159
169319
|
},
|
|
@@ -170264,6 +170424,9 @@
|
|
|
170264
170424
|
"description": "Title of the issue",
|
|
170265
170425
|
"type": "string"
|
|
170266
170426
|
},
|
|
170427
|
+
"type": {
|
|
170428
|
+
"$ref": "#/components/schemas/issue-type"
|
|
170429
|
+
},
|
|
170267
170430
|
"updated_at": {
|
|
170268
170431
|
"type": "string",
|
|
170269
170432
|
"format": "date-time"
|
|
@@ -172234,6 +172397,9 @@
|
|
|
172234
172397
|
"description": "Title of the issue",
|
|
172235
172398
|
"type": "string"
|
|
172236
172399
|
},
|
|
172400
|
+
"type": {
|
|
172401
|
+
"$ref": "#/components/schemas/issue-type"
|
|
172402
|
+
},
|
|
172237
172403
|
"updated_at": {
|
|
172238
172404
|
"type": "string",
|
|
172239
172405
|
"format": "date-time"
|
|
@@ -282961,6 +283127,20 @@
|
|
|
282961
283127
|
"format": "date-time"
|
|
282962
283128
|
}
|
|
282963
283129
|
},
|
|
283130
|
+
"personal-access-token-token-id": {
|
|
283131
|
+
"name": "token_id",
|
|
283132
|
+
"description": "The ID of the token",
|
|
283133
|
+
"in": "query",
|
|
283134
|
+
"required": false,
|
|
283135
|
+
"schema": {
|
|
283136
|
+
"type": "array",
|
|
283137
|
+
"maxItems": 50,
|
|
283138
|
+
"items": {
|
|
283139
|
+
"type": "string"
|
|
283140
|
+
},
|
|
283141
|
+
"example": "token_id[]=1,token_id[]=2"
|
|
283142
|
+
}
|
|
283143
|
+
},
|
|
282964
283144
|
"fine-grained-personal-access-token-id": {
|
|
282965
283145
|
"name": "pat_id",
|
|
282966
283146
|
"description": "The unique identifier of the fine-grained personal access token.",
|