@octokit/openapi 5.6.5 → 5.8.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 +4412 -986
- package/generated/api.github.com.json +647 -294
- package/generated/ghes-2.22-diff-to-ghes-3.0.deref.json +1 -1
- package/generated/ghes-2.22-diff-to-ghes-3.0.json +1 -1
- package/generated/ghes-2.22.deref.json +1 -1
- package/generated/ghes-2.22.json +1 -1
- package/generated/ghes-3.0-anicca-diff-to-ghes-3.1.deref.json +145 -0
- package/generated/ghes-3.0-diff-to-ghes-3.1.deref.json +14577 -3831
- package/generated/ghes-3.0-diff-to-ghes-3.1.json +1540 -248
- package/generated/ghes-3.0.deref.json +329 -161
- package/generated/ghes-3.0.json +280 -102
- package/generated/ghes-3.1-anicca-diff-to-ghes-3.2.deref.json +1292 -111
- package/generated/ghes-3.1-diff-to-ghes-3.2.deref.json +104093 -56376
- package/generated/ghes-3.1-diff-to-ghes-3.2.json +8280 -3015
- package/generated/ghes-3.1.deref.json +369 -193
- package/generated/ghes-3.1.json +320 -134
- package/generated/ghes-3.2-anicca-diff-to-api.github.com.deref.json +305 -1
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +4813 -906
- package/generated/ghes-3.2-diff-to-api.github.com.json +2141 -175
- package/generated/ghes-3.2.deref.json +390 -204
- package/generated/ghes-3.2.json +363 -145
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +59 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +4951 -1
- package/generated/github.ae-diff-to-api.github.com.json +2776 -110
- package/generated/github.ae.deref.json +3875 -639
- package/generated/github.ae.json +425 -235
- package/package.json +4 -1
package/generated/ghes-3.0.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "5.
|
|
4
|
+
"version": "5.8.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -5511,7 +5511,7 @@
|
|
|
5511
5511
|
"category": "gists",
|
|
5512
5512
|
"subcategory": null
|
|
5513
5513
|
},
|
|
5514
|
-
"x-octokit": {}
|
|
5514
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
5515
5515
|
}
|
|
5516
5516
|
},
|
|
5517
5517
|
"/gists/public": {
|
|
@@ -5724,7 +5724,7 @@
|
|
|
5724
5724
|
"category": "gists",
|
|
5725
5725
|
"subcategory": null
|
|
5726
5726
|
},
|
|
5727
|
-
"x-octokit": {}
|
|
5727
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
5728
5728
|
},
|
|
5729
5729
|
"delete": {
|
|
5730
5730
|
"summary": "Delete a gist",
|
|
@@ -7227,15 +7227,14 @@
|
|
|
7227
7227
|
"x-github": {
|
|
7228
7228
|
"githubCloudOnly": false,
|
|
7229
7229
|
"enabledForGitHubApps": true,
|
|
7230
|
+
"category": "orgs",
|
|
7230
7231
|
"previews": [
|
|
7231
7232
|
{
|
|
7232
7233
|
"required": false,
|
|
7233
7234
|
"name": "surtur",
|
|
7234
7235
|
"note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
7235
7236
|
}
|
|
7236
|
-
]
|
|
7237
|
-
"category": "orgs",
|
|
7238
|
-
"subcategory": null
|
|
7237
|
+
]
|
|
7239
7238
|
},
|
|
7240
7239
|
"x-octokit": {}
|
|
7241
7240
|
},
|
|
@@ -7360,7 +7359,6 @@
|
|
|
7360
7359
|
}
|
|
7361
7360
|
},
|
|
7362
7361
|
"409": { "$ref": "#/components/responses/conflict" },
|
|
7363
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
7364
7362
|
"422": {
|
|
7365
7363
|
"description": "Validation failed",
|
|
7366
7364
|
"content": {
|
|
@@ -7378,15 +7376,14 @@
|
|
|
7378
7376
|
"x-github": {
|
|
7379
7377
|
"githubCloudOnly": false,
|
|
7380
7378
|
"enabledForGitHubApps": true,
|
|
7379
|
+
"category": "orgs",
|
|
7381
7380
|
"previews": [
|
|
7382
7381
|
{
|
|
7383
7382
|
"required": false,
|
|
7384
7383
|
"name": "surtur",
|
|
7385
7384
|
"note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
7386
7385
|
}
|
|
7387
|
-
]
|
|
7388
|
-
"category": "orgs",
|
|
7389
|
-
"subcategory": null
|
|
7386
|
+
]
|
|
7390
7387
|
},
|
|
7391
7388
|
"x-octokit": {}
|
|
7392
7389
|
}
|
|
@@ -10441,6 +10438,7 @@
|
|
|
10441
10438
|
"x-github": {
|
|
10442
10439
|
"githubCloudOnly": false,
|
|
10443
10440
|
"enabledForGitHubApps": true,
|
|
10441
|
+
"category": "repos",
|
|
10444
10442
|
"previews": [
|
|
10445
10443
|
{
|
|
10446
10444
|
"required": false,
|
|
@@ -10452,9 +10450,7 @@
|
|
|
10452
10450
|
"name": "baptiste",
|
|
10453
10451
|
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
10454
10452
|
}
|
|
10455
|
-
]
|
|
10456
|
-
"category": "repos",
|
|
10457
|
-
"subcategory": null
|
|
10453
|
+
]
|
|
10458
10454
|
},
|
|
10459
10455
|
"x-octokit": {}
|
|
10460
10456
|
},
|
|
@@ -10593,6 +10589,7 @@
|
|
|
10593
10589
|
"x-github": {
|
|
10594
10590
|
"githubCloudOnly": false,
|
|
10595
10591
|
"enabledForGitHubApps": true,
|
|
10592
|
+
"category": "repos",
|
|
10596
10593
|
"previews": [
|
|
10597
10594
|
{
|
|
10598
10595
|
"required": false,
|
|
@@ -10604,9 +10601,7 @@
|
|
|
10604
10601
|
"name": "baptiste",
|
|
10605
10602
|
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
10606
10603
|
}
|
|
10607
|
-
]
|
|
10608
|
-
"category": "repos",
|
|
10609
|
-
"subcategory": null
|
|
10604
|
+
]
|
|
10610
10605
|
},
|
|
10611
10606
|
"x-octokit": {}
|
|
10612
10607
|
}
|
|
@@ -13634,6 +13629,7 @@
|
|
|
13634
13629
|
"x-github": {
|
|
13635
13630
|
"githubCloudOnly": false,
|
|
13636
13631
|
"enabledForGitHubApps": true,
|
|
13632
|
+
"category": "repos",
|
|
13637
13633
|
"previews": [
|
|
13638
13634
|
{
|
|
13639
13635
|
"required": false,
|
|
@@ -13645,8 +13641,7 @@
|
|
|
13645
13641
|
"name": "scarlet-witch",
|
|
13646
13642
|
"note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
|
|
13647
13643
|
}
|
|
13648
|
-
]
|
|
13649
|
-
"category": "repos"
|
|
13644
|
+
]
|
|
13650
13645
|
},
|
|
13651
13646
|
"x-octokit": {}
|
|
13652
13647
|
},
|
|
@@ -13688,7 +13683,7 @@
|
|
|
13688
13683
|
},
|
|
13689
13684
|
"visibility": {
|
|
13690
13685
|
"type": "string",
|
|
13691
|
-
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal
|
|
13686
|
+
"description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`.\"",
|
|
13692
13687
|
"enum": ["public", "private", "visibility", "internal"]
|
|
13693
13688
|
},
|
|
13694
13689
|
"has_issues": {
|
|
@@ -13779,6 +13774,7 @@
|
|
|
13779
13774
|
"x-github": {
|
|
13780
13775
|
"githubCloudOnly": false,
|
|
13781
13776
|
"enabledForGitHubApps": true,
|
|
13777
|
+
"category": "repos",
|
|
13782
13778
|
"previews": [
|
|
13783
13779
|
{
|
|
13784
13780
|
"required": false,
|
|
@@ -13790,9 +13786,7 @@
|
|
|
13790
13786
|
"name": "baptiste",
|
|
13791
13787
|
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
13792
13788
|
}
|
|
13793
|
-
]
|
|
13794
|
-
"category": "repos",
|
|
13795
|
-
"subcategory": null
|
|
13789
|
+
]
|
|
13796
13790
|
},
|
|
13797
13791
|
"x-octokit": {}
|
|
13798
13792
|
},
|
|
@@ -14490,7 +14484,8 @@
|
|
|
14490
14484
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
14491
14485
|
{ "$ref": "#/components/parameters/per-page" },
|
|
14492
14486
|
{ "$ref": "#/components/parameters/page" },
|
|
14493
|
-
{ "$ref": "#/components/parameters/created" }
|
|
14487
|
+
{ "$ref": "#/components/parameters/created" },
|
|
14488
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
14494
14489
|
],
|
|
14495
14490
|
"responses": {
|
|
14496
14491
|
"200": {
|
|
@@ -14541,7 +14536,8 @@
|
|
|
14541
14536
|
"parameters": [
|
|
14542
14537
|
{ "$ref": "#/components/parameters/owner" },
|
|
14543
14538
|
{ "$ref": "#/components/parameters/repo" },
|
|
14544
|
-
{ "$ref": "#/components/parameters/run-id" }
|
|
14539
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
14540
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
14545
14541
|
],
|
|
14546
14542
|
"responses": {
|
|
14547
14543
|
"200": {
|
|
@@ -14807,7 +14803,7 @@
|
|
|
14807
14803
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": {
|
|
14808
14804
|
"post": {
|
|
14809
14805
|
"summary": "Re-run a workflow",
|
|
14810
|
-
"description": "Re-runs your workflow run using its `id`. You must authenticate using
|
|
14806
|
+
"description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.",
|
|
14811
14807
|
"tags": ["actions"],
|
|
14812
14808
|
"operationId": "actions/re-run-workflow",
|
|
14813
14809
|
"externalDocs": {
|
|
@@ -15279,7 +15275,8 @@
|
|
|
15279
15275
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
15280
15276
|
{ "$ref": "#/components/parameters/per-page" },
|
|
15281
15277
|
{ "$ref": "#/components/parameters/page" },
|
|
15282
|
-
{ "$ref": "#/components/parameters/created" }
|
|
15278
|
+
{ "$ref": "#/components/parameters/created" },
|
|
15279
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
15283
15280
|
],
|
|
15284
15281
|
"responses": {
|
|
15285
15282
|
"200": {
|
|
@@ -16070,15 +16067,15 @@
|
|
|
16070
16067
|
"x-github": {
|
|
16071
16068
|
"githubCloudOnly": false,
|
|
16072
16069
|
"enabledForGitHubApps": true,
|
|
16070
|
+
"category": "repos",
|
|
16071
|
+
"subcategory": "branches",
|
|
16073
16072
|
"previews": [
|
|
16074
16073
|
{
|
|
16075
16074
|
"required": true,
|
|
16076
16075
|
"name": "zzzax",
|
|
16077
16076
|
"note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
16078
16077
|
}
|
|
16079
|
-
]
|
|
16080
|
-
"category": "repos",
|
|
16081
|
-
"subcategory": "branches"
|
|
16078
|
+
]
|
|
16082
16079
|
},
|
|
16083
16080
|
"x-octokit": {}
|
|
16084
16081
|
},
|
|
@@ -16117,15 +16114,15 @@
|
|
|
16117
16114
|
"x-github": {
|
|
16118
16115
|
"githubCloudOnly": false,
|
|
16119
16116
|
"enabledForGitHubApps": true,
|
|
16117
|
+
"category": "repos",
|
|
16118
|
+
"subcategory": "branches",
|
|
16120
16119
|
"previews": [
|
|
16121
16120
|
{
|
|
16122
16121
|
"required": true,
|
|
16123
16122
|
"name": "zzzax",
|
|
16124
16123
|
"note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
16125
16124
|
}
|
|
16126
|
-
]
|
|
16127
|
-
"category": "repos",
|
|
16128
|
-
"subcategory": "branches"
|
|
16125
|
+
]
|
|
16129
16126
|
},
|
|
16130
16127
|
"x-octokit": {}
|
|
16131
16128
|
},
|
|
@@ -16150,15 +16147,15 @@
|
|
|
16150
16147
|
"x-github": {
|
|
16151
16148
|
"githubCloudOnly": false,
|
|
16152
16149
|
"enabledForGitHubApps": true,
|
|
16150
|
+
"category": "repos",
|
|
16151
|
+
"subcategory": "branches",
|
|
16153
16152
|
"previews": [
|
|
16154
16153
|
{
|
|
16155
16154
|
"required": true,
|
|
16156
16155
|
"name": "zzzax",
|
|
16157
16156
|
"note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
16158
16157
|
}
|
|
16159
|
-
]
|
|
16160
|
-
"category": "repos",
|
|
16161
|
-
"subcategory": "branches"
|
|
16158
|
+
]
|
|
16162
16159
|
},
|
|
16163
16160
|
"x-octokit": {}
|
|
16164
16161
|
}
|
|
@@ -25425,21 +25422,20 @@
|
|
|
25425
25422
|
}
|
|
25426
25423
|
},
|
|
25427
25424
|
"409": { "$ref": "#/components/responses/conflict" },
|
|
25428
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
25429
25425
|
"422": { "$ref": "#/components/responses/validation_failed" }
|
|
25430
25426
|
},
|
|
25431
25427
|
"x-github": {
|
|
25432
25428
|
"githubCloudOnly": false,
|
|
25433
25429
|
"enabledForGitHubApps": true,
|
|
25430
|
+
"category": "repos",
|
|
25431
|
+
"subcategory": "pages",
|
|
25434
25432
|
"previews": [
|
|
25435
25433
|
{
|
|
25436
25434
|
"required": true,
|
|
25437
25435
|
"name": "switcheroo",
|
|
25438
25436
|
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
|
25439
25437
|
}
|
|
25440
|
-
]
|
|
25441
|
-
"category": "repos",
|
|
25442
|
-
"subcategory": "pages"
|
|
25438
|
+
]
|
|
25443
25439
|
},
|
|
25444
25440
|
"x-octokit": {}
|
|
25445
25441
|
},
|
|
@@ -25546,21 +25542,20 @@
|
|
|
25546
25542
|
"responses": {
|
|
25547
25543
|
"204": { "description": "Response" },
|
|
25548
25544
|
"404": { "$ref": "#/components/responses/not_found" },
|
|
25549
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
25550
25545
|
"422": { "$ref": "#/components/responses/validation_failed" }
|
|
25551
25546
|
},
|
|
25552
25547
|
"x-github": {
|
|
25553
25548
|
"githubCloudOnly": false,
|
|
25554
25549
|
"enabledForGitHubApps": true,
|
|
25550
|
+
"category": "repos",
|
|
25551
|
+
"subcategory": "pages",
|
|
25555
25552
|
"previews": [
|
|
25556
25553
|
{
|
|
25557
25554
|
"required": true,
|
|
25558
25555
|
"name": "switcheroo",
|
|
25559
25556
|
"note": "Enabling and disabling Pages in the Pages API is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2019-03-14-enabling-disabling-pages/) preview for more details. To access the new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
|
25560
25557
|
}
|
|
25561
|
-
]
|
|
25562
|
-
"category": "repos",
|
|
25563
|
-
"subcategory": "pages"
|
|
25558
|
+
]
|
|
25564
25559
|
},
|
|
25565
25560
|
"x-octokit": {}
|
|
25566
25561
|
}
|
|
@@ -26258,7 +26253,7 @@
|
|
|
26258
26253
|
"category": "pulls",
|
|
26259
26254
|
"subcategory": null
|
|
26260
26255
|
},
|
|
26261
|
-
"x-octokit": {}
|
|
26256
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
26262
26257
|
}
|
|
26263
26258
|
},
|
|
26264
26259
|
"/repos/{owner}/{repo}/pulls/comments": {
|
|
@@ -26767,7 +26762,7 @@
|
|
|
26767
26762
|
"category": "pulls",
|
|
26768
26763
|
"subcategory": null
|
|
26769
26764
|
},
|
|
26770
|
-
"x-octokit": {}
|
|
26765
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
26771
26766
|
}
|
|
26772
26767
|
},
|
|
26773
26768
|
"/repos/{owner}/{repo}/pulls/{pull_number}/comments": {
|
|
@@ -27381,7 +27376,7 @@
|
|
|
27381
27376
|
"category": "pulls",
|
|
27382
27377
|
"subcategory": "review-requests"
|
|
27383
27378
|
},
|
|
27384
|
-
"x-octokit": {}
|
|
27379
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
27385
27380
|
},
|
|
27386
27381
|
"delete": {
|
|
27387
27382
|
"summary": "Remove requested reviewers from a pull request",
|
|
@@ -29669,15 +29664,14 @@
|
|
|
29669
29664
|
"x-github": {
|
|
29670
29665
|
"githubCloudOnly": false,
|
|
29671
29666
|
"enabledForGitHubApps": false,
|
|
29667
|
+
"category": "repos",
|
|
29672
29668
|
"previews": [
|
|
29673
29669
|
{
|
|
29674
29670
|
"required": true,
|
|
29675
29671
|
"name": "baptiste",
|
|
29676
29672
|
"note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
29677
29673
|
}
|
|
29678
|
-
]
|
|
29679
|
-
"category": "repos",
|
|
29680
|
-
"subcategory": null
|
|
29674
|
+
]
|
|
29681
29675
|
},
|
|
29682
29676
|
"x-octokit": {}
|
|
29683
29677
|
}
|
|
@@ -29873,21 +29867,19 @@
|
|
|
29873
29867
|
}
|
|
29874
29868
|
}
|
|
29875
29869
|
},
|
|
29876
|
-
"304": { "$ref": "#/components/responses/not_modified" }
|
|
29877
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" }
|
|
29870
|
+
"304": { "$ref": "#/components/responses/not_modified" }
|
|
29878
29871
|
},
|
|
29879
29872
|
"x-github": {
|
|
29880
29873
|
"githubCloudOnly": false,
|
|
29881
29874
|
"enabledForGitHubApps": true,
|
|
29875
|
+
"category": "search",
|
|
29882
29876
|
"previews": [
|
|
29883
29877
|
{
|
|
29884
29878
|
"required": true,
|
|
29885
29879
|
"name": "cloak",
|
|
29886
29880
|
"note": "The Commit Search API is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2017-01-05-commit-search-api/) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```"
|
|
29887
29881
|
}
|
|
29888
|
-
]
|
|
29889
|
-
"category": "search",
|
|
29890
|
-
"subcategory": null
|
|
29882
|
+
]
|
|
29891
29883
|
},
|
|
29892
29884
|
"x-octokit": {}
|
|
29893
29885
|
}
|
|
@@ -32543,7 +32535,7 @@
|
|
|
32543
32535
|
"category": "users",
|
|
32544
32536
|
"subcategory": null
|
|
32545
32537
|
},
|
|
32546
|
-
"x-octokit": {}
|
|
32538
|
+
"x-octokit": { "diff": { "ghes-3.1.json": { "type": "changed" } } }
|
|
32547
32539
|
}
|
|
32548
32540
|
},
|
|
32549
32541
|
"/user/emails": {
|
|
@@ -32551,7 +32543,7 @@
|
|
|
32551
32543
|
"summary": "List email addresses for the authenticated user",
|
|
32552
32544
|
"description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.",
|
|
32553
32545
|
"tags": ["users"],
|
|
32554
|
-
"operationId": "users/list-emails-for-authenticated",
|
|
32546
|
+
"operationId": "users/list-emails-for-authenticated-user",
|
|
32555
32547
|
"externalDocs": {
|
|
32556
32548
|
"description": "API method documentation",
|
|
32557
32549
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
|
@@ -32588,13 +32580,21 @@
|
|
|
32588
32580
|
"category": "users",
|
|
32589
32581
|
"subcategory": "emails"
|
|
32590
32582
|
},
|
|
32591
|
-
"x-octokit": {
|
|
32583
|
+
"x-octokit": {
|
|
32584
|
+
"changes": [
|
|
32585
|
+
{
|
|
32586
|
+
"type": "OPERATION",
|
|
32587
|
+
"date": "2021-10-05",
|
|
32588
|
+
"before": { "operationId": "users/list-emails-for-authenticated" }
|
|
32589
|
+
}
|
|
32590
|
+
]
|
|
32591
|
+
}
|
|
32592
32592
|
},
|
|
32593
32593
|
"post": {
|
|
32594
32594
|
"summary": "Add an email address for the authenticated user",
|
|
32595
32595
|
"description": "This endpoint is accessible with the `user` scope.",
|
|
32596
32596
|
"tags": ["users"],
|
|
32597
|
-
"operationId": "users/add-email-for-authenticated",
|
|
32597
|
+
"operationId": "users/add-email-for-authenticated-user",
|
|
32598
32598
|
"externalDocs": {
|
|
32599
32599
|
"description": "API method documentation",
|
|
32600
32600
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
|
@@ -32657,13 +32657,21 @@
|
|
|
32657
32657
|
"category": "users",
|
|
32658
32658
|
"subcategory": "emails"
|
|
32659
32659
|
},
|
|
32660
|
-
"x-octokit": {
|
|
32660
|
+
"x-octokit": {
|
|
32661
|
+
"changes": [
|
|
32662
|
+
{
|
|
32663
|
+
"type": "OPERATION",
|
|
32664
|
+
"date": "2021-10-05",
|
|
32665
|
+
"before": { "operationId": "users/add-email-for-authenticated" }
|
|
32666
|
+
}
|
|
32667
|
+
]
|
|
32668
|
+
}
|
|
32661
32669
|
},
|
|
32662
32670
|
"delete": {
|
|
32663
32671
|
"summary": "Delete an email address for the authenticated user",
|
|
32664
32672
|
"description": "This endpoint is accessible with the `user` scope.",
|
|
32665
32673
|
"tags": ["users"],
|
|
32666
|
-
"operationId": "users/delete-email-for-authenticated",
|
|
32674
|
+
"operationId": "users/delete-email-for-authenticated-user",
|
|
32667
32675
|
"externalDocs": {
|
|
32668
32676
|
"description": "API method documentation",
|
|
32669
32677
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
|
@@ -32713,7 +32721,17 @@
|
|
|
32713
32721
|
"category": "users",
|
|
32714
32722
|
"subcategory": "emails"
|
|
32715
32723
|
},
|
|
32716
|
-
"x-octokit": {
|
|
32724
|
+
"x-octokit": {
|
|
32725
|
+
"changes": [
|
|
32726
|
+
{
|
|
32727
|
+
"type": "OPERATION",
|
|
32728
|
+
"date": "2021-10-05",
|
|
32729
|
+
"before": {
|
|
32730
|
+
"operationId": "users/delete-email-for-authenticated"
|
|
32731
|
+
}
|
|
32732
|
+
}
|
|
32733
|
+
]
|
|
32734
|
+
}
|
|
32717
32735
|
}
|
|
32718
32736
|
},
|
|
32719
32737
|
"/user/followers": {
|
|
@@ -32767,7 +32785,7 @@
|
|
|
32767
32785
|
"summary": "List the people the authenticated user follows",
|
|
32768
32786
|
"description": "Lists the people who the authenticated user follows.",
|
|
32769
32787
|
"tags": ["users"],
|
|
32770
|
-
"operationId": "users/list-followed-by-authenticated",
|
|
32788
|
+
"operationId": "users/list-followed-by-authenticated-user",
|
|
32771
32789
|
"externalDocs": {
|
|
32772
32790
|
"description": "API method documentation",
|
|
32773
32791
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
|
@@ -32805,7 +32823,17 @@
|
|
|
32805
32823
|
"category": "users",
|
|
32806
32824
|
"subcategory": "followers"
|
|
32807
32825
|
},
|
|
32808
|
-
"x-octokit": {
|
|
32826
|
+
"x-octokit": {
|
|
32827
|
+
"changes": [
|
|
32828
|
+
{
|
|
32829
|
+
"type": "OPERATION",
|
|
32830
|
+
"date": "2021-10-05",
|
|
32831
|
+
"before": {
|
|
32832
|
+
"operationId": "users/list-followed-by-authenticated"
|
|
32833
|
+
}
|
|
32834
|
+
}
|
|
32835
|
+
]
|
|
32836
|
+
}
|
|
32809
32837
|
}
|
|
32810
32838
|
},
|
|
32811
32839
|
"/user/following/{username}": {
|
|
@@ -32902,7 +32930,7 @@
|
|
|
32902
32930
|
"summary": "List GPG keys for the authenticated user",
|
|
32903
32931
|
"description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
32904
32932
|
"tags": ["users"],
|
|
32905
|
-
"operationId": "users/list-gpg-keys-for-authenticated",
|
|
32933
|
+
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
|
32906
32934
|
"externalDocs": {
|
|
32907
32935
|
"description": "API method documentation",
|
|
32908
32936
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
|
@@ -32939,12 +32967,22 @@
|
|
|
32939
32967
|
"category": "users",
|
|
32940
32968
|
"subcategory": "gpg-keys"
|
|
32941
32969
|
},
|
|
32942
|
-
"x-octokit": {
|
|
32970
|
+
"x-octokit": {
|
|
32971
|
+
"changes": [
|
|
32972
|
+
{
|
|
32973
|
+
"type": "OPERATION",
|
|
32974
|
+
"date": "2021-10-05",
|
|
32975
|
+
"before": {
|
|
32976
|
+
"operationId": "users/list-gpg-keys-for-authenticated"
|
|
32977
|
+
}
|
|
32978
|
+
}
|
|
32979
|
+
]
|
|
32980
|
+
}
|
|
32943
32981
|
},
|
|
32944
32982
|
"post": {
|
|
32945
32983
|
"summary": "Create a GPG key for the authenticated user",
|
|
32946
32984
|
"description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
32947
|
-
"operationId": "users/create-gpg-key-for-authenticated",
|
|
32985
|
+
"operationId": "users/create-gpg-key-for-authenticated-user",
|
|
32948
32986
|
"tags": ["users"],
|
|
32949
32987
|
"externalDocs": {
|
|
32950
32988
|
"description": "API method documentation",
|
|
@@ -32993,7 +33031,17 @@
|
|
|
32993
33031
|
"category": "users",
|
|
32994
33032
|
"subcategory": "gpg-keys"
|
|
32995
33033
|
},
|
|
32996
|
-
"x-octokit": {
|
|
33034
|
+
"x-octokit": {
|
|
33035
|
+
"changes": [
|
|
33036
|
+
{
|
|
33037
|
+
"type": "OPERATION",
|
|
33038
|
+
"date": "2021-10-05",
|
|
33039
|
+
"before": {
|
|
33040
|
+
"operationId": "users/create-gpg-key-for-authenticated"
|
|
33041
|
+
}
|
|
33042
|
+
}
|
|
33043
|
+
]
|
|
33044
|
+
}
|
|
32997
33045
|
}
|
|
32998
33046
|
},
|
|
32999
33047
|
"/user/gpg_keys/{gpg_key_id}": {
|
|
@@ -33001,7 +33049,7 @@
|
|
|
33001
33049
|
"summary": "Get a GPG key for the authenticated user",
|
|
33002
33050
|
"description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
33003
33051
|
"tags": ["users"],
|
|
33004
|
-
"operationId": "users/get-gpg-key-for-authenticated",
|
|
33052
|
+
"operationId": "users/get-gpg-key-for-authenticated-user",
|
|
33005
33053
|
"externalDocs": {
|
|
33006
33054
|
"description": "API method documentation",
|
|
33007
33055
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
|
@@ -33031,13 +33079,21 @@
|
|
|
33031
33079
|
"category": "users",
|
|
33032
33080
|
"subcategory": "gpg-keys"
|
|
33033
33081
|
},
|
|
33034
|
-
"x-octokit": {
|
|
33082
|
+
"x-octokit": {
|
|
33083
|
+
"changes": [
|
|
33084
|
+
{
|
|
33085
|
+
"type": "OPERATION",
|
|
33086
|
+
"date": "2021-10-05",
|
|
33087
|
+
"before": { "operationId": "users/get-gpg-key-for-authenticated" }
|
|
33088
|
+
}
|
|
33089
|
+
]
|
|
33090
|
+
}
|
|
33035
33091
|
},
|
|
33036
33092
|
"delete": {
|
|
33037
33093
|
"summary": "Delete a GPG key for the authenticated user",
|
|
33038
33094
|
"description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
33039
33095
|
"tags": ["users"],
|
|
33040
|
-
"operationId": "users/delete-gpg-key-for-authenticated",
|
|
33096
|
+
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
|
33041
33097
|
"externalDocs": {
|
|
33042
33098
|
"description": "API method documentation",
|
|
33043
33099
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
|
@@ -33058,7 +33114,17 @@
|
|
|
33058
33114
|
"category": "users",
|
|
33059
33115
|
"subcategory": "gpg-keys"
|
|
33060
33116
|
},
|
|
33061
|
-
"x-octokit": {
|
|
33117
|
+
"x-octokit": {
|
|
33118
|
+
"changes": [
|
|
33119
|
+
{
|
|
33120
|
+
"type": "OPERATION",
|
|
33121
|
+
"date": "2021-10-05",
|
|
33122
|
+
"before": {
|
|
33123
|
+
"operationId": "users/delete-gpg-key-for-authenticated"
|
|
33124
|
+
}
|
|
33125
|
+
}
|
|
33126
|
+
]
|
|
33127
|
+
}
|
|
33062
33128
|
}
|
|
33063
33129
|
},
|
|
33064
33130
|
"/user/installations": {
|
|
@@ -33181,7 +33247,7 @@
|
|
|
33181
33247
|
"summary": "Add a repository to an app installation",
|
|
33182
33248
|
"description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.0/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
|
|
33183
33249
|
"tags": ["apps"],
|
|
33184
|
-
"operationId": "apps/add-repo-to-installation",
|
|
33250
|
+
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
|
33185
33251
|
"externalDocs": {
|
|
33186
33252
|
"description": "API method documentation",
|
|
33187
33253
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#add-a-repository-to-an-app-installation"
|
|
@@ -33203,13 +33269,21 @@
|
|
|
33203
33269
|
"category": "apps",
|
|
33204
33270
|
"subcategory": "installations"
|
|
33205
33271
|
},
|
|
33206
|
-
"x-octokit": {
|
|
33272
|
+
"x-octokit": {
|
|
33273
|
+
"changes": [
|
|
33274
|
+
{
|
|
33275
|
+
"type": "OPERATION",
|
|
33276
|
+
"date": "2021-10-05",
|
|
33277
|
+
"before": { "operationId": "apps/add-repo-to-installation" }
|
|
33278
|
+
}
|
|
33279
|
+
]
|
|
33280
|
+
}
|
|
33207
33281
|
},
|
|
33208
33282
|
"delete": {
|
|
33209
33283
|
"summary": "Remove a repository from an app installation",
|
|
33210
33284
|
"description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://docs.github.com/enterprise-server@3.0/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/enterprise-server@3.0/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
|
|
33211
33285
|
"tags": ["apps"],
|
|
33212
|
-
"operationId": "apps/remove-repo-from-installation",
|
|
33286
|
+
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
|
33213
33287
|
"externalDocs": {
|
|
33214
33288
|
"description": "API method documentation",
|
|
33215
33289
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
|
@@ -33231,7 +33305,15 @@
|
|
|
33231
33305
|
"category": "apps",
|
|
33232
33306
|
"subcategory": "installations"
|
|
33233
33307
|
},
|
|
33234
|
-
"x-octokit": {
|
|
33308
|
+
"x-octokit": {
|
|
33309
|
+
"changes": [
|
|
33310
|
+
{
|
|
33311
|
+
"type": "OPERATION",
|
|
33312
|
+
"date": "2021-10-05",
|
|
33313
|
+
"before": { "operationId": "apps/remove-repo-from-installation" }
|
|
33314
|
+
}
|
|
33315
|
+
]
|
|
33316
|
+
}
|
|
33235
33317
|
}
|
|
33236
33318
|
},
|
|
33237
33319
|
"/user/issues": {
|
|
@@ -33337,7 +33419,7 @@
|
|
|
33337
33419
|
"summary": "List public SSH keys for the authenticated user",
|
|
33338
33420
|
"description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
33339
33421
|
"tags": ["users"],
|
|
33340
|
-
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
|
33422
|
+
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
|
33341
33423
|
"externalDocs": {
|
|
33342
33424
|
"description": "API method documentation",
|
|
33343
33425
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
|
@@ -33374,12 +33456,22 @@
|
|
|
33374
33456
|
"category": "users",
|
|
33375
33457
|
"subcategory": "keys"
|
|
33376
33458
|
},
|
|
33377
|
-
"x-octokit": {
|
|
33459
|
+
"x-octokit": {
|
|
33460
|
+
"changes": [
|
|
33461
|
+
{
|
|
33462
|
+
"type": "OPERATION",
|
|
33463
|
+
"date": "2021-10-05",
|
|
33464
|
+
"before": {
|
|
33465
|
+
"operationId": "users/list-public-ssh-keys-for-authenticated"
|
|
33466
|
+
}
|
|
33467
|
+
}
|
|
33468
|
+
]
|
|
33469
|
+
}
|
|
33378
33470
|
},
|
|
33379
33471
|
"post": {
|
|
33380
33472
|
"summary": "Create a public SSH key for the authenticated user",
|
|
33381
33473
|
"description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
33382
|
-
"operationId": "users/create-public-ssh-key-for-authenticated",
|
|
33474
|
+
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
|
33383
33475
|
"tags": ["users"],
|
|
33384
33476
|
"externalDocs": {
|
|
33385
33477
|
"description": "API method documentation",
|
|
@@ -33434,7 +33526,17 @@
|
|
|
33434
33526
|
"category": "users",
|
|
33435
33527
|
"subcategory": "keys"
|
|
33436
33528
|
},
|
|
33437
|
-
"x-octokit": {
|
|
33529
|
+
"x-octokit": {
|
|
33530
|
+
"changes": [
|
|
33531
|
+
{
|
|
33532
|
+
"type": "OPERATION",
|
|
33533
|
+
"date": "2021-10-05",
|
|
33534
|
+
"before": {
|
|
33535
|
+
"operationId": "users/create-public-ssh-key-for-authenticated"
|
|
33536
|
+
}
|
|
33537
|
+
}
|
|
33538
|
+
]
|
|
33539
|
+
}
|
|
33438
33540
|
}
|
|
33439
33541
|
},
|
|
33440
33542
|
"/user/keys/{key_id}": {
|
|
@@ -33442,7 +33544,7 @@
|
|
|
33442
33544
|
"summary": "Get a public SSH key for the authenticated user",
|
|
33443
33545
|
"description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
33444
33546
|
"tags": ["users"],
|
|
33445
|
-
"operationId": "users/get-public-ssh-key-for-authenticated",
|
|
33547
|
+
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
|
33446
33548
|
"externalDocs": {
|
|
33447
33549
|
"description": "API method documentation",
|
|
33448
33550
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
|
@@ -33472,13 +33574,23 @@
|
|
|
33472
33574
|
"category": "users",
|
|
33473
33575
|
"subcategory": "keys"
|
|
33474
33576
|
},
|
|
33475
|
-
"x-octokit": {
|
|
33577
|
+
"x-octokit": {
|
|
33578
|
+
"changes": [
|
|
33579
|
+
{
|
|
33580
|
+
"type": "OPERATION",
|
|
33581
|
+
"date": "2021-10-05",
|
|
33582
|
+
"before": {
|
|
33583
|
+
"operationId": "users/get-public-ssh-key-for-authenticated"
|
|
33584
|
+
}
|
|
33585
|
+
}
|
|
33586
|
+
]
|
|
33587
|
+
}
|
|
33476
33588
|
},
|
|
33477
33589
|
"delete": {
|
|
33478
33590
|
"summary": "Delete a public SSH key for the authenticated user",
|
|
33479
33591
|
"description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
33480
33592
|
"tags": ["users"],
|
|
33481
|
-
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
|
33593
|
+
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
|
33482
33594
|
"externalDocs": {
|
|
33483
33595
|
"description": "API method documentation",
|
|
33484
33596
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
|
@@ -33498,7 +33610,17 @@
|
|
|
33498
33610
|
"category": "users",
|
|
33499
33611
|
"subcategory": "keys"
|
|
33500
33612
|
},
|
|
33501
|
-
"x-octokit": {
|
|
33613
|
+
"x-octokit": {
|
|
33614
|
+
"changes": [
|
|
33615
|
+
{
|
|
33616
|
+
"type": "OPERATION",
|
|
33617
|
+
"date": "2021-10-05",
|
|
33618
|
+
"before": {
|
|
33619
|
+
"operationId": "users/delete-public-ssh-key-for-authenticated"
|
|
33620
|
+
}
|
|
33621
|
+
}
|
|
33622
|
+
]
|
|
33623
|
+
}
|
|
33502
33624
|
}
|
|
33503
33625
|
},
|
|
33504
33626
|
"/user/memberships/orgs": {
|
|
@@ -33768,7 +33890,7 @@
|
|
|
33768
33890
|
"summary": "List public email addresses for the authenticated user",
|
|
33769
33891
|
"description": "Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.0/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.",
|
|
33770
33892
|
"tags": ["users"],
|
|
33771
|
-
"operationId": "users/list-public-emails-for-authenticated",
|
|
33893
|
+
"operationId": "users/list-public-emails-for-authenticated-user",
|
|
33772
33894
|
"externalDocs": {
|
|
33773
33895
|
"description": "API method documentation",
|
|
33774
33896
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
|
@@ -33805,7 +33927,17 @@
|
|
|
33805
33927
|
"category": "users",
|
|
33806
33928
|
"subcategory": "emails"
|
|
33807
33929
|
},
|
|
33808
|
-
"x-octokit": {
|
|
33930
|
+
"x-octokit": {
|
|
33931
|
+
"changes": [
|
|
33932
|
+
{
|
|
33933
|
+
"type": "OPERATION",
|
|
33934
|
+
"date": "2021-10-05",
|
|
33935
|
+
"before": {
|
|
33936
|
+
"operationId": "users/list-public-emails-for-authenticated"
|
|
33937
|
+
}
|
|
33938
|
+
}
|
|
33939
|
+
]
|
|
33940
|
+
}
|
|
33809
33941
|
}
|
|
33810
33942
|
},
|
|
33811
33943
|
"/user/repos": {
|
|
@@ -34047,6 +34179,7 @@
|
|
|
34047
34179
|
"x-github": {
|
|
34048
34180
|
"githubCloudOnly": false,
|
|
34049
34181
|
"enabledForGitHubApps": false,
|
|
34182
|
+
"category": "repos",
|
|
34050
34183
|
"previews": [
|
|
34051
34184
|
{
|
|
34052
34185
|
"required": false,
|
|
@@ -34058,9 +34191,7 @@
|
|
|
34058
34191
|
"name": "baptiste",
|
|
34059
34192
|
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
34060
34193
|
}
|
|
34061
|
-
]
|
|
34062
|
-
"category": "repos",
|
|
34063
|
-
"subcategory": null
|
|
34194
|
+
]
|
|
34064
34195
|
},
|
|
34065
34196
|
"x-octokit": {}
|
|
34066
34197
|
}
|
|
@@ -34119,7 +34250,7 @@
|
|
|
34119
34250
|
"summary": "Accept a repository invitation",
|
|
34120
34251
|
"description": "",
|
|
34121
34252
|
"tags": ["repos"],
|
|
34122
|
-
"operationId": "repos/accept-invitation",
|
|
34253
|
+
"operationId": "repos/accept-invitation-for-authenticated-user",
|
|
34123
34254
|
"externalDocs": {
|
|
34124
34255
|
"description": "API method documentation",
|
|
34125
34256
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#accept-a-repository-invitation"
|
|
@@ -34139,13 +34270,21 @@
|
|
|
34139
34270
|
"category": "repos",
|
|
34140
34271
|
"subcategory": "invitations"
|
|
34141
34272
|
},
|
|
34142
|
-
"x-octokit": {
|
|
34273
|
+
"x-octokit": {
|
|
34274
|
+
"changes": [
|
|
34275
|
+
{
|
|
34276
|
+
"type": "OPERATION",
|
|
34277
|
+
"date": "2021-10-05",
|
|
34278
|
+
"before": { "operationId": "repos/accept-invitation" }
|
|
34279
|
+
}
|
|
34280
|
+
]
|
|
34281
|
+
}
|
|
34143
34282
|
},
|
|
34144
34283
|
"delete": {
|
|
34145
34284
|
"summary": "Decline a repository invitation",
|
|
34146
34285
|
"description": "",
|
|
34147
34286
|
"tags": ["repos"],
|
|
34148
|
-
"operationId": "repos/decline-invitation",
|
|
34287
|
+
"operationId": "repos/decline-invitation-for-authenticated-user",
|
|
34149
34288
|
"externalDocs": {
|
|
34150
34289
|
"description": "API method documentation",
|
|
34151
34290
|
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#decline-a-repository-invitation"
|
|
@@ -34165,7 +34304,15 @@
|
|
|
34165
34304
|
"category": "repos",
|
|
34166
34305
|
"subcategory": "invitations"
|
|
34167
34306
|
},
|
|
34168
|
-
"x-octokit": {
|
|
34307
|
+
"x-octokit": {
|
|
34308
|
+
"changes": [
|
|
34309
|
+
{
|
|
34310
|
+
"type": "OPERATION",
|
|
34311
|
+
"date": "2021-10-05",
|
|
34312
|
+
"before": { "operationId": "repos/decline-invitation" }
|
|
34313
|
+
}
|
|
34314
|
+
]
|
|
34315
|
+
}
|
|
34169
34316
|
}
|
|
34170
34317
|
},
|
|
34171
34318
|
"/user/starred": {
|
|
@@ -35214,15 +35361,14 @@
|
|
|
35214
35361
|
"x-github": {
|
|
35215
35362
|
"githubCloudOnly": false,
|
|
35216
35363
|
"enabledForGitHubApps": true,
|
|
35364
|
+
"category": "repos",
|
|
35217
35365
|
"previews": [
|
|
35218
35366
|
{
|
|
35219
35367
|
"required": false,
|
|
35220
35368
|
"name": "nebula",
|
|
35221
35369
|
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.0/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
35222
35370
|
}
|
|
35223
|
-
]
|
|
35224
|
-
"category": "repos",
|
|
35225
|
-
"subcategory": null
|
|
35371
|
+
]
|
|
35226
35372
|
},
|
|
35227
35373
|
"x-octokit": {}
|
|
35228
35374
|
}
|
|
@@ -36051,6 +36197,13 @@
|
|
|
36051
36197
|
"required": false,
|
|
36052
36198
|
"schema": { "type": "string", "format": "date-time" }
|
|
36053
36199
|
},
|
|
36200
|
+
"exclude-pull-requests": {
|
|
36201
|
+
"name": "exclude_pull_requests",
|
|
36202
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
36203
|
+
"in": "query",
|
|
36204
|
+
"required": false,
|
|
36205
|
+
"schema": { "type": "boolean", "default": false }
|
|
36206
|
+
},
|
|
36054
36207
|
"run-id": {
|
|
36055
36208
|
"name": "run_id",
|
|
36056
36209
|
"description": "The id of the workflow run.",
|
|
@@ -42646,6 +42799,11 @@
|
|
|
42646
42799
|
"type": "string",
|
|
42647
42800
|
"example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
|
|
42648
42801
|
},
|
|
42802
|
+
"run_attempt": {
|
|
42803
|
+
"type": "integer",
|
|
42804
|
+
"description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
|
|
42805
|
+
"example": 1
|
|
42806
|
+
},
|
|
42649
42807
|
"node_id": { "type": "string", "example": "MDg6Q2hlY2tSdW40" },
|
|
42650
42808
|
"head_sha": {
|
|
42651
42809
|
"description": "The SHA of the commit that is being run.",
|
|
@@ -42895,7 +43053,7 @@
|
|
|
42895
43053
|
},
|
|
42896
43054
|
"run_attempt": {
|
|
42897
43055
|
"type": "integer",
|
|
42898
|
-
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was
|
|
43056
|
+
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.",
|
|
42899
43057
|
"example": 1
|
|
42900
43058
|
},
|
|
42901
43059
|
"event": { "type": "string", "example": "push" },
|
|
@@ -42930,6 +43088,11 @@
|
|
|
42930
43088
|
},
|
|
42931
43089
|
"created_at": { "type": "string", "format": "date-time" },
|
|
42932
43090
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
43091
|
+
"run_started_at": {
|
|
43092
|
+
"type": "string",
|
|
43093
|
+
"format": "date-time",
|
|
43094
|
+
"description": "The start time of the latest run. Resets on re-run."
|
|
43095
|
+
},
|
|
42933
43096
|
"jobs_url": {
|
|
42934
43097
|
"description": "The URL to the jobs for the workflow run.",
|
|
42935
43098
|
"type": "string",
|
|
@@ -44336,7 +44499,6 @@
|
|
|
44336
44499
|
"created_at": { "$ref": "#/components/schemas/alert-created-at" },
|
|
44337
44500
|
"url": { "$ref": "#/components/schemas/alert-url" },
|
|
44338
44501
|
"html_url": { "$ref": "#/components/schemas/alert-html-url" },
|
|
44339
|
-
"instances": { "deprecated": true },
|
|
44340
44502
|
"instances_url": {
|
|
44341
44503
|
"$ref": "#/components/schemas/alert-instances-url"
|
|
44342
44504
|
},
|
|
@@ -44356,7 +44518,8 @@
|
|
|
44356
44518
|
},
|
|
44357
44519
|
"most_recent_instance": {
|
|
44358
44520
|
"$ref": "#/components/schemas/code-scanning-alert-instance"
|
|
44359
|
-
}
|
|
44521
|
+
},
|
|
44522
|
+
"instances": { "deprecated": true }
|
|
44360
44523
|
},
|
|
44361
44524
|
"required": [
|
|
44362
44525
|
"number",
|
|
@@ -48184,6 +48347,10 @@
|
|
|
48184
48347
|
"master_branch": { "type": "string" },
|
|
48185
48348
|
"archived": { "type": "boolean" },
|
|
48186
48349
|
"disabled": { "type": "boolean" },
|
|
48350
|
+
"visibility": {
|
|
48351
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
48352
|
+
"type": "string"
|
|
48353
|
+
},
|
|
48187
48354
|
"mirror_url": {
|
|
48188
48355
|
"type": "string",
|
|
48189
48356
|
"format": "uri",
|
|
@@ -48232,7 +48399,8 @@
|
|
|
48232
48399
|
"watchers_count": { "type": "integer" },
|
|
48233
48400
|
"created_at": { "type": "string", "format": "date-time" },
|
|
48234
48401
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
48235
|
-
"allow_forking": { "type": "boolean" }
|
|
48402
|
+
"allow_forking": { "type": "boolean" },
|
|
48403
|
+
"is_template": { "type": "boolean" }
|
|
48236
48404
|
},
|
|
48237
48405
|
"required": [
|
|
48238
48406
|
"archive_url",
|
|
@@ -48388,6 +48556,7 @@
|
|
|
48388
48556
|
"hooks_url": { "type": "string", "format": "uri" },
|
|
48389
48557
|
"html_url": { "type": "string", "format": "uri" },
|
|
48390
48558
|
"id": { "type": "integer" },
|
|
48559
|
+
"is_template": { "type": "boolean" },
|
|
48391
48560
|
"node_id": { "type": "string" },
|
|
48392
48561
|
"issue_comment_url": { "type": "string" },
|
|
48393
48562
|
"issue_events_url": { "type": "string" },
|
|
@@ -48481,6 +48650,10 @@
|
|
|
48481
48650
|
"master_branch": { "type": "string" },
|
|
48482
48651
|
"archived": { "type": "boolean" },
|
|
48483
48652
|
"disabled": { "type": "boolean" },
|
|
48653
|
+
"visibility": {
|
|
48654
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
48655
|
+
"type": "string"
|
|
48656
|
+
},
|
|
48484
48657
|
"mirror_url": {
|
|
48485
48658
|
"type": "string",
|
|
48486
48659
|
"format": "uri",
|
|
@@ -49594,6 +49767,10 @@
|
|
|
49594
49767
|
"type": "boolean",
|
|
49595
49768
|
"description": "Returns whether or not this repository disabled."
|
|
49596
49769
|
},
|
|
49770
|
+
"visibility": {
|
|
49771
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
49772
|
+
"type": "string"
|
|
49773
|
+
},
|
|
49597
49774
|
"license": { "$ref": "#/components/schemas/nullable-license-simple" },
|
|
49598
49775
|
"permissions": {
|
|
49599
49776
|
"type": "object",
|
|
@@ -49614,7 +49791,8 @@
|
|
|
49614
49791
|
"allow_squash_merge": { "type": "boolean" },
|
|
49615
49792
|
"allow_rebase_merge": { "type": "boolean" },
|
|
49616
49793
|
"delete_branch_on_merge": { "type": "boolean" },
|
|
49617
|
-
"allow_forking": { "type": "boolean" }
|
|
49794
|
+
"allow_forking": { "type": "boolean" },
|
|
49795
|
+
"is_template": { "type": "boolean" }
|
|
49618
49796
|
},
|
|
49619
49797
|
"required": [
|
|
49620
49798
|
"archive_url",
|
|
@@ -58241,8 +58419,7 @@
|
|
|
58241
58419
|
},
|
|
58242
58420
|
"classifications": ["test"]
|
|
58243
58421
|
},
|
|
58244
|
-
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
58245
|
-
"instances": null
|
|
58422
|
+
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
58246
58423
|
}
|
|
58247
58424
|
},
|
|
58248
58425
|
"code-scanning-alert-dismissed": {
|
|
@@ -65029,6 +65206,7 @@
|
|
|
65029
65206
|
"has_downloads": true,
|
|
65030
65207
|
"archived": true,
|
|
65031
65208
|
"disabled": true,
|
|
65209
|
+
"visibility": "private",
|
|
65032
65210
|
"license": {
|
|
65033
65211
|
"key": "mit",
|
|
65034
65212
|
"name": "MIT License",
|