@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/github.ae.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" },
|
|
@@ -3313,7 +3313,7 @@
|
|
|
3313
3313
|
"/enterprises/{enterprise}/actions/runner-groups": {
|
|
3314
3314
|
"get": {
|
|
3315
3315
|
"summary": "List self-hosted runner groups for an enterprise",
|
|
3316
|
-
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3316
|
+
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3317
3317
|
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
|
3318
3318
|
"tags": ["enterprise-admin"],
|
|
3319
3319
|
"externalDocs": {
|
|
@@ -3363,7 +3363,7 @@
|
|
|
3363
3363
|
},
|
|
3364
3364
|
"post": {
|
|
3365
3365
|
"summary": "Create a self-hosted runner group for an enterprise",
|
|
3366
|
-
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3366
|
+
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3367
3367
|
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
|
3368
3368
|
"tags": ["enterprise-admin"],
|
|
3369
3369
|
"externalDocs": {
|
|
@@ -3445,7 +3445,7 @@
|
|
|
3445
3445
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
|
3446
3446
|
"get": {
|
|
3447
3447
|
"summary": "Get a self-hosted runner group for an enterprise",
|
|
3448
|
-
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3448
|
+
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3449
3449
|
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
|
3450
3450
|
"tags": ["enterprise-admin"],
|
|
3451
3451
|
"externalDocs": {
|
|
@@ -3484,7 +3484,7 @@
|
|
|
3484
3484
|
},
|
|
3485
3485
|
"patch": {
|
|
3486
3486
|
"summary": "Update a self-hosted runner group for an enterprise",
|
|
3487
|
-
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3487
|
+
"description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3488
3488
|
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
|
3489
3489
|
"tags": ["enterprise-admin"],
|
|
3490
3490
|
"externalDocs": {
|
|
@@ -3548,7 +3548,7 @@
|
|
|
3548
3548
|
},
|
|
3549
3549
|
"delete": {
|
|
3550
3550
|
"summary": "Delete a self-hosted runner group from an enterprise",
|
|
3551
|
-
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3551
|
+
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3552
3552
|
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
|
3553
3553
|
"tags": ["enterprise-admin"],
|
|
3554
3554
|
"externalDocs": {
|
|
@@ -3573,7 +3573,7 @@
|
|
|
3573
3573
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
|
3574
3574
|
"get": {
|
|
3575
3575
|
"summary": "List self-hosted runners in a group for an enterprise",
|
|
3576
|
-
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `
|
|
3576
|
+
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3577
3577
|
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
|
3578
3578
|
"tags": ["enterprise-admin"],
|
|
3579
3579
|
"externalDocs": {
|
|
@@ -3623,7 +3623,7 @@
|
|
|
3623
3623
|
},
|
|
3624
3624
|
"put": {
|
|
3625
3625
|
"summary": "Set self-hosted runners in a group for an enterprise",
|
|
3626
|
-
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `
|
|
3626
|
+
"description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3627
3627
|
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
|
3628
3628
|
"tags": ["enterprise-admin"],
|
|
3629
3629
|
"externalDocs": {
|
|
@@ -3670,7 +3670,7 @@
|
|
|
3670
3670
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
|
3671
3671
|
"put": {
|
|
3672
3672
|
"summary": "Add a self-hosted runner to a group for an enterprise",
|
|
3673
|
-
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3673
|
+
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise`\nscope to use this endpoint.",
|
|
3674
3674
|
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
|
3675
3675
|
"tags": ["enterprise-admin"],
|
|
3676
3676
|
"externalDocs": {
|
|
@@ -3694,7 +3694,7 @@
|
|
|
3694
3694
|
},
|
|
3695
3695
|
"delete": {
|
|
3696
3696
|
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
|
3697
|
-
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `
|
|
3697
|
+
"description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3698
3698
|
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
|
3699
3699
|
"tags": ["enterprise-admin"],
|
|
3700
3700
|
"externalDocs": {
|
|
@@ -3720,7 +3720,7 @@
|
|
|
3720
3720
|
"/enterprises/{enterprise}/actions/runners": {
|
|
3721
3721
|
"get": {
|
|
3722
3722
|
"summary": "List self-hosted runners for an enterprise",
|
|
3723
|
-
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3723
|
+
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3724
3724
|
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
|
3725
3725
|
"tags": ["enterprise-admin"],
|
|
3726
3726
|
"externalDocs": {
|
|
@@ -3770,7 +3770,7 @@
|
|
|
3770
3770
|
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
|
3771
3771
|
"get": {
|
|
3772
3772
|
"summary": "Get a self-hosted runner for an enterprise",
|
|
3773
|
-
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
3773
|
+
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3774
3774
|
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
|
3775
3775
|
"tags": ["enterprise-admin"],
|
|
3776
3776
|
"externalDocs": {
|
|
@@ -3805,7 +3805,7 @@
|
|
|
3805
3805
|
},
|
|
3806
3806
|
"delete": {
|
|
3807
3807
|
"summary": "Delete a self-hosted runner from an enterprise",
|
|
3808
|
-
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `
|
|
3808
|
+
"description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
3809
3809
|
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
|
3810
3810
|
"tags": ["enterprise-admin"],
|
|
3811
3811
|
"externalDocs": {
|
|
@@ -5658,13 +5658,6 @@
|
|
|
5658
5658
|
"x-github": {
|
|
5659
5659
|
"githubCloudOnly": false,
|
|
5660
5660
|
"enabledForGitHubApps": true,
|
|
5661
|
-
"previews": [
|
|
5662
|
-
{
|
|
5663
|
-
"required": false,
|
|
5664
|
-
"name": "surtur",
|
|
5665
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
5666
|
-
}
|
|
5667
|
-
],
|
|
5668
5661
|
"category": "orgs",
|
|
5669
5662
|
"subcategory": null
|
|
5670
5663
|
},
|
|
@@ -5801,7 +5794,6 @@
|
|
|
5801
5794
|
}
|
|
5802
5795
|
},
|
|
5803
5796
|
"409": { "$ref": "#/components/responses/conflict" },
|
|
5804
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
5805
5797
|
"422": {
|
|
5806
5798
|
"description": "Validation failed",
|
|
5807
5799
|
"content": {
|
|
@@ -5819,13 +5811,6 @@
|
|
|
5819
5811
|
"x-github": {
|
|
5820
5812
|
"githubCloudOnly": false,
|
|
5821
5813
|
"enabledForGitHubApps": true,
|
|
5822
|
-
"previews": [
|
|
5823
|
-
{
|
|
5824
|
-
"required": false,
|
|
5825
|
-
"name": "surtur",
|
|
5826
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
5827
|
-
}
|
|
5828
|
-
],
|
|
5829
5814
|
"category": "orgs",
|
|
5830
5815
|
"subcategory": null
|
|
5831
5816
|
},
|
|
@@ -7964,18 +7949,6 @@
|
|
|
7964
7949
|
"x-github": {
|
|
7965
7950
|
"githubCloudOnly": false,
|
|
7966
7951
|
"enabledForGitHubApps": true,
|
|
7967
|
-
"previews": [
|
|
7968
|
-
{
|
|
7969
|
-
"required": false,
|
|
7970
|
-
"name": "nebula",
|
|
7971
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
7972
|
-
},
|
|
7973
|
-
{
|
|
7974
|
-
"required": false,
|
|
7975
|
-
"name": "baptiste",
|
|
7976
|
-
"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/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
7977
|
-
}
|
|
7978
|
-
],
|
|
7979
7952
|
"category": "repos",
|
|
7980
7953
|
"subcategory": null
|
|
7981
7954
|
},
|
|
@@ -8017,7 +7990,7 @@
|
|
|
8017
7990
|
},
|
|
8018
7991
|
"visibility": {
|
|
8019
7992
|
"type": "string",
|
|
8020
|
-
"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`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.
|
|
7993
|
+
"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`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation.",
|
|
8021
7994
|
"enum": ["public", "private", "visibility", "internal"]
|
|
8022
7995
|
},
|
|
8023
7996
|
"has_issues": {
|
|
@@ -8121,18 +8094,6 @@
|
|
|
8121
8094
|
"x-github": {
|
|
8122
8095
|
"githubCloudOnly": false,
|
|
8123
8096
|
"enabledForGitHubApps": true,
|
|
8124
|
-
"previews": [
|
|
8125
|
-
{
|
|
8126
|
-
"required": false,
|
|
8127
|
-
"name": "nebula",
|
|
8128
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
8129
|
-
},
|
|
8130
|
-
{
|
|
8131
|
-
"required": false,
|
|
8132
|
-
"name": "baptiste",
|
|
8133
|
-
"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/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
8134
|
-
}
|
|
8135
|
-
],
|
|
8136
8097
|
"category": "repos",
|
|
8137
8098
|
"subcategory": null
|
|
8138
8099
|
},
|
|
@@ -10913,13 +10874,6 @@
|
|
|
10913
10874
|
"x-github": {
|
|
10914
10875
|
"githubCloudOnly": false,
|
|
10915
10876
|
"enabledForGitHubApps": true,
|
|
10916
|
-
"previews": [
|
|
10917
|
-
{
|
|
10918
|
-
"required": false,
|
|
10919
|
-
"name": "nebula",
|
|
10920
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
10921
|
-
}
|
|
10922
|
-
],
|
|
10923
10877
|
"category": "repos",
|
|
10924
10878
|
"subcategory": null
|
|
10925
10879
|
},
|
|
@@ -11059,22 +11013,12 @@
|
|
|
11059
11013
|
"x-github": {
|
|
11060
11014
|
"githubCloudOnly": false,
|
|
11061
11015
|
"enabledForGitHubApps": true,
|
|
11062
|
-
"previews": [
|
|
11063
|
-
{
|
|
11064
|
-
"required": false,
|
|
11065
|
-
"name": "nebula",
|
|
11066
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
11067
|
-
},
|
|
11068
|
-
{
|
|
11069
|
-
"required": false,
|
|
11070
|
-
"name": "baptiste",
|
|
11071
|
-
"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/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
11072
|
-
}
|
|
11073
|
-
],
|
|
11074
11016
|
"category": "repos",
|
|
11075
11017
|
"subcategory": null
|
|
11076
11018
|
},
|
|
11077
|
-
"x-octokit": {
|
|
11019
|
+
"x-octokit": {
|
|
11020
|
+
"diff": { "api.github.com.json": { "type": "changed" } }
|
|
11021
|
+
}
|
|
11078
11022
|
},
|
|
11079
11023
|
"delete": {
|
|
11080
11024
|
"summary": "Delete a repository",
|
|
@@ -11610,7 +11554,8 @@
|
|
|
11610
11554
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
11611
11555
|
{ "$ref": "#/components/parameters/per-page" },
|
|
11612
11556
|
{ "$ref": "#/components/parameters/page" },
|
|
11613
|
-
{ "$ref": "#/components/parameters/created" }
|
|
11557
|
+
{ "$ref": "#/components/parameters/created" },
|
|
11558
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
11614
11559
|
],
|
|
11615
11560
|
"responses": {
|
|
11616
11561
|
"200": {
|
|
@@ -11661,7 +11606,8 @@
|
|
|
11661
11606
|
"parameters": [
|
|
11662
11607
|
{ "$ref": "#/components/parameters/owner" },
|
|
11663
11608
|
{ "$ref": "#/components/parameters/repo" },
|
|
11664
|
-
{ "$ref": "#/components/parameters/run-id" }
|
|
11609
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
11610
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
11665
11611
|
],
|
|
11666
11612
|
"responses": {
|
|
11667
11613
|
"200": {
|
|
@@ -11763,6 +11709,83 @@
|
|
|
11763
11709
|
"x-octokit": {}
|
|
11764
11710
|
}
|
|
11765
11711
|
},
|
|
11712
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
|
|
11713
|
+
"get": {
|
|
11714
|
+
"summary": "Get a workflow run attempt",
|
|
11715
|
+
"description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.",
|
|
11716
|
+
"tags": ["actions"],
|
|
11717
|
+
"operationId": "actions/get-workflow-run-attempt",
|
|
11718
|
+
"externalDocs": {
|
|
11719
|
+
"description": "API method documentation",
|
|
11720
|
+
"url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow-run-attempt"
|
|
11721
|
+
},
|
|
11722
|
+
"parameters": [
|
|
11723
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
11724
|
+
{ "$ref": "#/components/parameters/repo" },
|
|
11725
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
11726
|
+
{ "$ref": "#/components/parameters/attempt-number" },
|
|
11727
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
11728
|
+
],
|
|
11729
|
+
"responses": {
|
|
11730
|
+
"200": {
|
|
11731
|
+
"description": "Response",
|
|
11732
|
+
"content": {
|
|
11733
|
+
"application/json": {
|
|
11734
|
+
"schema": { "$ref": "#/components/schemas/workflow-run" },
|
|
11735
|
+
"examples": {
|
|
11736
|
+
"default": { "$ref": "#/components/examples/workflow-run" }
|
|
11737
|
+
}
|
|
11738
|
+
}
|
|
11739
|
+
}
|
|
11740
|
+
}
|
|
11741
|
+
},
|
|
11742
|
+
"x-github": {
|
|
11743
|
+
"githubCloudOnly": false,
|
|
11744
|
+
"enabledForGitHubApps": true,
|
|
11745
|
+
"previews": [],
|
|
11746
|
+
"category": "actions",
|
|
11747
|
+
"subcategory": "workflow-runs"
|
|
11748
|
+
},
|
|
11749
|
+
"x-octokit": {}
|
|
11750
|
+
}
|
|
11751
|
+
},
|
|
11752
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
|
|
11753
|
+
"get": {
|
|
11754
|
+
"summary": "Download workflow run attempt logs",
|
|
11755
|
+
"description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
|
|
11756
|
+
"tags": ["actions"],
|
|
11757
|
+
"operationId": "actions/download-workflow-run-attempt-logs",
|
|
11758
|
+
"externalDocs": {
|
|
11759
|
+
"description": "API method documentation",
|
|
11760
|
+
"url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-workflow-run-attempt-logs"
|
|
11761
|
+
},
|
|
11762
|
+
"parameters": [
|
|
11763
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
11764
|
+
{ "$ref": "#/components/parameters/repo" },
|
|
11765
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
11766
|
+
{ "$ref": "#/components/parameters/attempt-number" }
|
|
11767
|
+
],
|
|
11768
|
+
"responses": {
|
|
11769
|
+
"302": {
|
|
11770
|
+
"description": "Response",
|
|
11771
|
+
"headers": {
|
|
11772
|
+
"Location": {
|
|
11773
|
+
"example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D",
|
|
11774
|
+
"schema": { "type": "string" }
|
|
11775
|
+
}
|
|
11776
|
+
}
|
|
11777
|
+
}
|
|
11778
|
+
},
|
|
11779
|
+
"x-github": {
|
|
11780
|
+
"githubCloudOnly": false,
|
|
11781
|
+
"enabledForGitHubApps": true,
|
|
11782
|
+
"previews": [],
|
|
11783
|
+
"category": "actions",
|
|
11784
|
+
"subcategory": "workflow-runs"
|
|
11785
|
+
},
|
|
11786
|
+
"x-octokit": {}
|
|
11787
|
+
}
|
|
11788
|
+
},
|
|
11766
11789
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
11767
11790
|
"post": {
|
|
11768
11791
|
"summary": "Cancel a workflow run",
|
|
@@ -11927,7 +11950,7 @@
|
|
|
11927
11950
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": {
|
|
11928
11951
|
"post": {
|
|
11929
11952
|
"summary": "Re-run a workflow",
|
|
11930
|
-
"description": "
|
|
11953
|
+
"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.",
|
|
11931
11954
|
"tags": ["actions"],
|
|
11932
11955
|
"operationId": "actions/re-run-workflow",
|
|
11933
11956
|
"externalDocs": {
|
|
@@ -11965,45 +11988,6 @@
|
|
|
11965
11988
|
"x-octokit": {}
|
|
11966
11989
|
}
|
|
11967
11990
|
},
|
|
11968
|
-
"/repos/{owner}/{repo}/actions/runs/{run_id}/retry": {
|
|
11969
|
-
"post": {
|
|
11970
|
-
"summary": "Retry a workflow",
|
|
11971
|
-
"description": "Retry 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.",
|
|
11972
|
-
"tags": ["actions"],
|
|
11973
|
-
"operationId": "actions/retry-workflow",
|
|
11974
|
-
"externalDocs": {
|
|
11975
|
-
"description": "API method documentation",
|
|
11976
|
-
"url": "https://docs.github.com/github-ae@latest/rest/reference/actions#retry-a-workflow"
|
|
11977
|
-
},
|
|
11978
|
-
"parameters": [
|
|
11979
|
-
{ "$ref": "#/components/parameters/owner" },
|
|
11980
|
-
{ "$ref": "#/components/parameters/repo" },
|
|
11981
|
-
{ "$ref": "#/components/parameters/run-id" }
|
|
11982
|
-
],
|
|
11983
|
-
"responses": {
|
|
11984
|
-
"201": {
|
|
11985
|
-
"description": "Response",
|
|
11986
|
-
"content": {
|
|
11987
|
-
"application/json": {
|
|
11988
|
-
"schema": {
|
|
11989
|
-
"type": "object",
|
|
11990
|
-
"properties": {},
|
|
11991
|
-
"additionalProperties": false
|
|
11992
|
-
}
|
|
11993
|
-
}
|
|
11994
|
-
}
|
|
11995
|
-
}
|
|
11996
|
-
},
|
|
11997
|
-
"x-github": {
|
|
11998
|
-
"githubCloudOnly": false,
|
|
11999
|
-
"enabledForGitHubApps": false,
|
|
12000
|
-
"previews": [],
|
|
12001
|
-
"category": "actions",
|
|
12002
|
-
"subcategory": "workflow-runs"
|
|
12003
|
-
},
|
|
12004
|
-
"x-octokit": {}
|
|
12005
|
-
}
|
|
12006
|
-
},
|
|
12007
11991
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
|
|
12008
11992
|
"get": {
|
|
12009
11993
|
"summary": "Get workflow run usage",
|
|
@@ -12478,7 +12462,8 @@
|
|
|
12478
12462
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
12479
12463
|
{ "$ref": "#/components/parameters/per-page" },
|
|
12480
12464
|
{ "$ref": "#/components/parameters/page" },
|
|
12481
|
-
{ "$ref": "#/components/parameters/created" }
|
|
12465
|
+
{ "$ref": "#/components/parameters/created" },
|
|
12466
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
12482
12467
|
],
|
|
12483
12468
|
"responses": {
|
|
12484
12469
|
"200": {
|
|
@@ -13460,13 +13445,6 @@
|
|
|
13460
13445
|
"x-github": {
|
|
13461
13446
|
"githubCloudOnly": false,
|
|
13462
13447
|
"enabledForGitHubApps": true,
|
|
13463
|
-
"previews": [
|
|
13464
|
-
{
|
|
13465
|
-
"required": true,
|
|
13466
|
-
"name": "zzzax",
|
|
13467
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
13468
|
-
}
|
|
13469
|
-
],
|
|
13470
13448
|
"category": "repos",
|
|
13471
13449
|
"subcategory": "branches"
|
|
13472
13450
|
},
|
|
@@ -13507,13 +13485,6 @@
|
|
|
13507
13485
|
"x-github": {
|
|
13508
13486
|
"githubCloudOnly": false,
|
|
13509
13487
|
"enabledForGitHubApps": true,
|
|
13510
|
-
"previews": [
|
|
13511
|
-
{
|
|
13512
|
-
"required": true,
|
|
13513
|
-
"name": "zzzax",
|
|
13514
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
13515
|
-
}
|
|
13516
|
-
],
|
|
13517
13488
|
"category": "repos",
|
|
13518
13489
|
"subcategory": "branches"
|
|
13519
13490
|
},
|
|
@@ -13540,13 +13511,6 @@
|
|
|
13540
13511
|
"x-github": {
|
|
13541
13512
|
"githubCloudOnly": false,
|
|
13542
13513
|
"enabledForGitHubApps": true,
|
|
13543
|
-
"previews": [
|
|
13544
|
-
{
|
|
13545
|
-
"required": true,
|
|
13546
|
-
"name": "zzzax",
|
|
13547
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
13548
|
-
}
|
|
13549
|
-
],
|
|
13550
13514
|
"category": "repos",
|
|
13551
13515
|
"subcategory": "branches"
|
|
13552
13516
|
},
|
|
@@ -15334,6 +15298,62 @@
|
|
|
15334
15298
|
"x-octokit": {}
|
|
15335
15299
|
}
|
|
15336
15300
|
},
|
|
15301
|
+
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
|
|
15302
|
+
"post": {
|
|
15303
|
+
"summary": "Rerequest a check run",
|
|
15304
|
+
"description": "Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
|
|
15305
|
+
"tags": ["checks"],
|
|
15306
|
+
"operationId": "checks/rerequest-run",
|
|
15307
|
+
"externalDocs": {
|
|
15308
|
+
"description": "API method documentation",
|
|
15309
|
+
"url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-run"
|
|
15310
|
+
},
|
|
15311
|
+
"parameters": [
|
|
15312
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
15313
|
+
{ "$ref": "#/components/parameters/repo" },
|
|
15314
|
+
{ "$ref": "#/components/parameters/check-run-id" }
|
|
15315
|
+
],
|
|
15316
|
+
"responses": {
|
|
15317
|
+
"201": {
|
|
15318
|
+
"description": "Response",
|
|
15319
|
+
"content": {
|
|
15320
|
+
"application/json": {
|
|
15321
|
+
"schema": {
|
|
15322
|
+
"type": "object",
|
|
15323
|
+
"properties": {},
|
|
15324
|
+
"additionalProperties": false
|
|
15325
|
+
}
|
|
15326
|
+
}
|
|
15327
|
+
}
|
|
15328
|
+
},
|
|
15329
|
+
"403": {
|
|
15330
|
+
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
|
|
15331
|
+
"content": {
|
|
15332
|
+
"application/json": {
|
|
15333
|
+
"schema": { "$ref": "#/components/schemas/basic-error" }
|
|
15334
|
+
}
|
|
15335
|
+
}
|
|
15336
|
+
},
|
|
15337
|
+
"404": { "$ref": "#/components/responses/not_found" },
|
|
15338
|
+
"422": {
|
|
15339
|
+
"description": "Validation error if the check run is not rerequestable",
|
|
15340
|
+
"content": {
|
|
15341
|
+
"application/json": {
|
|
15342
|
+
"schema": { "$ref": "#/components/schemas/basic-error" }
|
|
15343
|
+
}
|
|
15344
|
+
}
|
|
15345
|
+
}
|
|
15346
|
+
},
|
|
15347
|
+
"x-github": {
|
|
15348
|
+
"githubCloudOnly": false,
|
|
15349
|
+
"enabledForGitHubApps": true,
|
|
15350
|
+
"previews": [],
|
|
15351
|
+
"category": "checks",
|
|
15352
|
+
"subcategory": "runs"
|
|
15353
|
+
},
|
|
15354
|
+
"x-octokit": {}
|
|
15355
|
+
}
|
|
15356
|
+
},
|
|
15337
15357
|
"/repos/{owner}/{repo}/check-suites": {
|
|
15338
15358
|
"post": {
|
|
15339
15359
|
"summary": "Create a check suite",
|
|
@@ -15938,7 +15958,7 @@
|
|
|
15938
15958
|
"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
|
|
15939
15959
|
"get": {
|
|
15940
15960
|
"summary": "Get a code scanning analysis for a repository",
|
|
15941
|
-
"description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html)
|
|
15961
|
+
"description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).",
|
|
15942
15962
|
"operationId": "code-scanning/get-analysis",
|
|
15943
15963
|
"tags": ["code-scanning"],
|
|
15944
15964
|
"externalDocs": {
|
|
@@ -22934,19 +22954,11 @@
|
|
|
22934
22954
|
}
|
|
22935
22955
|
},
|
|
22936
22956
|
"409": { "$ref": "#/components/responses/conflict" },
|
|
22937
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
22938
22957
|
"422": { "$ref": "#/components/responses/validation_failed" }
|
|
22939
22958
|
},
|
|
22940
22959
|
"x-github": {
|
|
22941
22960
|
"githubCloudOnly": false,
|
|
22942
22961
|
"enabledForGitHubApps": true,
|
|
22943
|
-
"previews": [
|
|
22944
|
-
{
|
|
22945
|
-
"required": true,
|
|
22946
|
-
"name": "switcheroo",
|
|
22947
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
|
22948
|
-
}
|
|
22949
|
-
],
|
|
22950
22962
|
"category": "repos",
|
|
22951
22963
|
"subcategory": "pages"
|
|
22952
22964
|
},
|
|
@@ -23055,19 +23067,11 @@
|
|
|
23055
23067
|
"responses": {
|
|
23056
23068
|
"204": { "description": "Response" },
|
|
23057
23069
|
"404": { "$ref": "#/components/responses/not_found" },
|
|
23058
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
23059
23070
|
"422": { "$ref": "#/components/responses/validation_failed" }
|
|
23060
23071
|
},
|
|
23061
23072
|
"x-github": {
|
|
23062
23073
|
"githubCloudOnly": false,
|
|
23063
23074
|
"enabledForGitHubApps": true,
|
|
23064
|
-
"previews": [
|
|
23065
|
-
{
|
|
23066
|
-
"required": true,
|
|
23067
|
-
"name": "switcheroo",
|
|
23068
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
|
23069
|
-
}
|
|
23070
|
-
],
|
|
23071
23075
|
"category": "repos",
|
|
23072
23076
|
"subcategory": "pages"
|
|
23073
23077
|
},
|
|
@@ -25481,7 +25485,9 @@
|
|
|
25481
25485
|
"category": "repos",
|
|
25482
25486
|
"subcategory": "releases"
|
|
25483
25487
|
},
|
|
25484
|
-
"x-octokit": {
|
|
25488
|
+
"x-octokit": {
|
|
25489
|
+
"diff": { "api.github.com.json": { "type": "changed" } }
|
|
25490
|
+
}
|
|
25485
25491
|
}
|
|
25486
25492
|
},
|
|
25487
25493
|
"/repos/{owner}/{repo}/releases/assets/{asset_id}": {
|
|
@@ -25804,7 +25810,9 @@
|
|
|
25804
25810
|
"category": "repos",
|
|
25805
25811
|
"subcategory": "releases"
|
|
25806
25812
|
},
|
|
25807
|
-
"x-octokit": {
|
|
25813
|
+
"x-octokit": {
|
|
25814
|
+
"diff": { "api.github.com.json": { "type": "changed" } }
|
|
25815
|
+
}
|
|
25808
25816
|
},
|
|
25809
25817
|
"delete": {
|
|
25810
25818
|
"summary": "Delete a release",
|
|
@@ -26990,13 +26998,6 @@
|
|
|
26990
26998
|
"x-github": {
|
|
26991
26999
|
"githubCloudOnly": false,
|
|
26992
27000
|
"enabledForGitHubApps": false,
|
|
26993
|
-
"previews": [
|
|
26994
|
-
{
|
|
26995
|
-
"required": true,
|
|
26996
|
-
"name": "baptiste",
|
|
26997
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
26998
|
-
}
|
|
26999
|
-
],
|
|
27000
27001
|
"category": "repos",
|
|
27001
27002
|
"subcategory": null
|
|
27002
27003
|
},
|
|
@@ -27520,19 +27521,11 @@
|
|
|
27520
27521
|
}
|
|
27521
27522
|
}
|
|
27522
27523
|
},
|
|
27523
|
-
"304": { "$ref": "#/components/responses/not_modified" }
|
|
27524
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" }
|
|
27524
|
+
"304": { "$ref": "#/components/responses/not_modified" }
|
|
27525
27525
|
},
|
|
27526
27526
|
"x-github": {
|
|
27527
27527
|
"githubCloudOnly": false,
|
|
27528
27528
|
"enabledForGitHubApps": true,
|
|
27529
|
-
"previews": [
|
|
27530
|
-
{
|
|
27531
|
-
"required": true,
|
|
27532
|
-
"name": "cloak",
|
|
27533
|
-
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```"
|
|
27534
|
-
}
|
|
27535
|
-
],
|
|
27536
27529
|
"category": "search",
|
|
27537
27530
|
"subcategory": null
|
|
27538
27531
|
},
|
|
@@ -29698,7 +29691,7 @@
|
|
|
29698
29691
|
"summary": "List the people the authenticated user follows",
|
|
29699
29692
|
"description": "Lists the people who the authenticated user follows.",
|
|
29700
29693
|
"tags": ["users"],
|
|
29701
|
-
"operationId": "users/list-followed-by-authenticated",
|
|
29694
|
+
"operationId": "users/list-followed-by-authenticated-user",
|
|
29702
29695
|
"externalDocs": {
|
|
29703
29696
|
"description": "API method documentation",
|
|
29704
29697
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
|
@@ -29736,7 +29729,17 @@
|
|
|
29736
29729
|
"category": "users",
|
|
29737
29730
|
"subcategory": "followers"
|
|
29738
29731
|
},
|
|
29739
|
-
"x-octokit": {
|
|
29732
|
+
"x-octokit": {
|
|
29733
|
+
"changes": [
|
|
29734
|
+
{
|
|
29735
|
+
"type": "OPERATION",
|
|
29736
|
+
"date": "2021-10-05",
|
|
29737
|
+
"before": {
|
|
29738
|
+
"operationId": "users/list-followed-by-authenticated"
|
|
29739
|
+
}
|
|
29740
|
+
}
|
|
29741
|
+
]
|
|
29742
|
+
}
|
|
29740
29743
|
}
|
|
29741
29744
|
},
|
|
29742
29745
|
"/user/following/{username}": {
|
|
@@ -29833,7 +29836,7 @@
|
|
|
29833
29836
|
"summary": "List GPG keys for the authenticated user",
|
|
29834
29837
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
29835
29838
|
"tags": ["users"],
|
|
29836
|
-
"operationId": "users/list-gpg-keys-for-authenticated",
|
|
29839
|
+
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
|
29837
29840
|
"externalDocs": {
|
|
29838
29841
|
"description": "API method documentation",
|
|
29839
29842
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
|
@@ -29870,12 +29873,22 @@
|
|
|
29870
29873
|
"category": "users",
|
|
29871
29874
|
"subcategory": "gpg-keys"
|
|
29872
29875
|
},
|
|
29873
|
-
"x-octokit": {
|
|
29876
|
+
"x-octokit": {
|
|
29877
|
+
"changes": [
|
|
29878
|
+
{
|
|
29879
|
+
"type": "OPERATION",
|
|
29880
|
+
"date": "2021-10-05",
|
|
29881
|
+
"before": {
|
|
29882
|
+
"operationId": "users/list-gpg-keys-for-authenticated"
|
|
29883
|
+
}
|
|
29884
|
+
}
|
|
29885
|
+
]
|
|
29886
|
+
}
|
|
29874
29887
|
},
|
|
29875
29888
|
"post": {
|
|
29876
29889
|
"summary": "Create a GPG key for the authenticated user",
|
|
29877
29890
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
29878
|
-
"operationId": "users/create-gpg-key-for-authenticated",
|
|
29891
|
+
"operationId": "users/create-gpg-key-for-authenticated-user",
|
|
29879
29892
|
"tags": ["users"],
|
|
29880
29893
|
"externalDocs": {
|
|
29881
29894
|
"description": "API method documentation",
|
|
@@ -29924,7 +29937,17 @@
|
|
|
29924
29937
|
"category": "users",
|
|
29925
29938
|
"subcategory": "gpg-keys"
|
|
29926
29939
|
},
|
|
29927
|
-
"x-octokit": {
|
|
29940
|
+
"x-octokit": {
|
|
29941
|
+
"changes": [
|
|
29942
|
+
{
|
|
29943
|
+
"type": "OPERATION",
|
|
29944
|
+
"date": "2021-10-05",
|
|
29945
|
+
"before": {
|
|
29946
|
+
"operationId": "users/create-gpg-key-for-authenticated"
|
|
29947
|
+
}
|
|
29948
|
+
}
|
|
29949
|
+
]
|
|
29950
|
+
}
|
|
29928
29951
|
}
|
|
29929
29952
|
},
|
|
29930
29953
|
"/user/gpg_keys/{gpg_key_id}": {
|
|
@@ -29932,7 +29955,7 @@
|
|
|
29932
29955
|
"summary": "Get a GPG key for the authenticated user",
|
|
29933
29956
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
29934
29957
|
"tags": ["users"],
|
|
29935
|
-
"operationId": "users/get-gpg-key-for-authenticated",
|
|
29958
|
+
"operationId": "users/get-gpg-key-for-authenticated-user",
|
|
29936
29959
|
"externalDocs": {
|
|
29937
29960
|
"description": "API method documentation",
|
|
29938
29961
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
|
@@ -29962,13 +29985,21 @@
|
|
|
29962
29985
|
"category": "users",
|
|
29963
29986
|
"subcategory": "gpg-keys"
|
|
29964
29987
|
},
|
|
29965
|
-
"x-octokit": {
|
|
29988
|
+
"x-octokit": {
|
|
29989
|
+
"changes": [
|
|
29990
|
+
{
|
|
29991
|
+
"type": "OPERATION",
|
|
29992
|
+
"date": "2021-10-05",
|
|
29993
|
+
"before": { "operationId": "users/get-gpg-key-for-authenticated" }
|
|
29994
|
+
}
|
|
29995
|
+
]
|
|
29996
|
+
}
|
|
29966
29997
|
},
|
|
29967
29998
|
"delete": {
|
|
29968
29999
|
"summary": "Delete a GPG key for the authenticated user",
|
|
29969
30000
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
29970
30001
|
"tags": ["users"],
|
|
29971
|
-
"operationId": "users/delete-gpg-key-for-authenticated",
|
|
30002
|
+
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
|
29972
30003
|
"externalDocs": {
|
|
29973
30004
|
"description": "API method documentation",
|
|
29974
30005
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
|
@@ -29989,7 +30020,17 @@
|
|
|
29989
30020
|
"category": "users",
|
|
29990
30021
|
"subcategory": "gpg-keys"
|
|
29991
30022
|
},
|
|
29992
|
-
"x-octokit": {
|
|
30023
|
+
"x-octokit": {
|
|
30024
|
+
"changes": [
|
|
30025
|
+
{
|
|
30026
|
+
"type": "OPERATION",
|
|
30027
|
+
"date": "2021-10-05",
|
|
30028
|
+
"before": {
|
|
30029
|
+
"operationId": "users/delete-gpg-key-for-authenticated"
|
|
30030
|
+
}
|
|
30031
|
+
}
|
|
30032
|
+
]
|
|
30033
|
+
}
|
|
29993
30034
|
}
|
|
29994
30035
|
},
|
|
29995
30036
|
"/user/installations": {
|
|
@@ -30112,7 +30153,7 @@
|
|
|
30112
30153
|
"summary": "Add a repository to an app installation",
|
|
30113
30154
|
"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/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
|
|
30114
30155
|
"tags": ["apps"],
|
|
30115
|
-
"operationId": "apps/add-repo-to-installation",
|
|
30156
|
+
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
|
30116
30157
|
"externalDocs": {
|
|
30117
30158
|
"description": "API method documentation",
|
|
30118
30159
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#add-a-repository-to-an-app-installation"
|
|
@@ -30134,13 +30175,21 @@
|
|
|
30134
30175
|
"category": "apps",
|
|
30135
30176
|
"subcategory": "installations"
|
|
30136
30177
|
},
|
|
30137
|
-
"x-octokit": {
|
|
30178
|
+
"x-octokit": {
|
|
30179
|
+
"changes": [
|
|
30180
|
+
{
|
|
30181
|
+
"type": "OPERATION",
|
|
30182
|
+
"date": "2021-10-05",
|
|
30183
|
+
"before": { "operationId": "apps/add-repo-to-installation" }
|
|
30184
|
+
}
|
|
30185
|
+
]
|
|
30186
|
+
}
|
|
30138
30187
|
},
|
|
30139
30188
|
"delete": {
|
|
30140
30189
|
"summary": "Remove a repository from an app installation",
|
|
30141
30190
|
"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/github-ae@latest/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
|
|
30142
30191
|
"tags": ["apps"],
|
|
30143
|
-
"operationId": "apps/remove-repo-from-installation",
|
|
30192
|
+
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
|
30144
30193
|
"externalDocs": {
|
|
30145
30194
|
"description": "API method documentation",
|
|
30146
30195
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
|
@@ -30162,7 +30211,15 @@
|
|
|
30162
30211
|
"category": "apps",
|
|
30163
30212
|
"subcategory": "installations"
|
|
30164
30213
|
},
|
|
30165
|
-
"x-octokit": {
|
|
30214
|
+
"x-octokit": {
|
|
30215
|
+
"changes": [
|
|
30216
|
+
{
|
|
30217
|
+
"type": "OPERATION",
|
|
30218
|
+
"date": "2021-10-05",
|
|
30219
|
+
"before": { "operationId": "apps/remove-repo-from-installation" }
|
|
30220
|
+
}
|
|
30221
|
+
]
|
|
30222
|
+
}
|
|
30166
30223
|
}
|
|
30167
30224
|
},
|
|
30168
30225
|
"/user/issues": {
|
|
@@ -30257,7 +30314,7 @@
|
|
|
30257
30314
|
"summary": "List public SSH keys for the authenticated user",
|
|
30258
30315
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
30259
30316
|
"tags": ["users"],
|
|
30260
|
-
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
|
30317
|
+
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
|
30261
30318
|
"externalDocs": {
|
|
30262
30319
|
"description": "API method documentation",
|
|
30263
30320
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
|
@@ -30294,12 +30351,22 @@
|
|
|
30294
30351
|
"category": "users",
|
|
30295
30352
|
"subcategory": "keys"
|
|
30296
30353
|
},
|
|
30297
|
-
"x-octokit": {
|
|
30354
|
+
"x-octokit": {
|
|
30355
|
+
"changes": [
|
|
30356
|
+
{
|
|
30357
|
+
"type": "OPERATION",
|
|
30358
|
+
"date": "2021-10-05",
|
|
30359
|
+
"before": {
|
|
30360
|
+
"operationId": "users/list-public-ssh-keys-for-authenticated"
|
|
30361
|
+
}
|
|
30362
|
+
}
|
|
30363
|
+
]
|
|
30364
|
+
}
|
|
30298
30365
|
},
|
|
30299
30366
|
"post": {
|
|
30300
30367
|
"summary": "Create a public SSH key for the authenticated user",
|
|
30301
30368
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
30302
|
-
"operationId": "users/create-public-ssh-key-for-authenticated",
|
|
30369
|
+
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
|
30303
30370
|
"tags": ["users"],
|
|
30304
30371
|
"externalDocs": {
|
|
30305
30372
|
"description": "API method documentation",
|
|
@@ -30354,7 +30421,17 @@
|
|
|
30354
30421
|
"category": "users",
|
|
30355
30422
|
"subcategory": "keys"
|
|
30356
30423
|
},
|
|
30357
|
-
"x-octokit": {
|
|
30424
|
+
"x-octokit": {
|
|
30425
|
+
"changes": [
|
|
30426
|
+
{
|
|
30427
|
+
"type": "OPERATION",
|
|
30428
|
+
"date": "2021-10-05",
|
|
30429
|
+
"before": {
|
|
30430
|
+
"operationId": "users/create-public-ssh-key-for-authenticated"
|
|
30431
|
+
}
|
|
30432
|
+
}
|
|
30433
|
+
]
|
|
30434
|
+
}
|
|
30358
30435
|
}
|
|
30359
30436
|
},
|
|
30360
30437
|
"/user/keys/{key_id}": {
|
|
@@ -30362,7 +30439,7 @@
|
|
|
30362
30439
|
"summary": "Get a public SSH key for the authenticated user",
|
|
30363
30440
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
30364
30441
|
"tags": ["users"],
|
|
30365
|
-
"operationId": "users/get-public-ssh-key-for-authenticated",
|
|
30442
|
+
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
|
30366
30443
|
"externalDocs": {
|
|
30367
30444
|
"description": "API method documentation",
|
|
30368
30445
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
|
@@ -30392,13 +30469,23 @@
|
|
|
30392
30469
|
"category": "users",
|
|
30393
30470
|
"subcategory": "keys"
|
|
30394
30471
|
},
|
|
30395
|
-
"x-octokit": {
|
|
30472
|
+
"x-octokit": {
|
|
30473
|
+
"changes": [
|
|
30474
|
+
{
|
|
30475
|
+
"type": "OPERATION",
|
|
30476
|
+
"date": "2021-10-05",
|
|
30477
|
+
"before": {
|
|
30478
|
+
"operationId": "users/get-public-ssh-key-for-authenticated"
|
|
30479
|
+
}
|
|
30480
|
+
}
|
|
30481
|
+
]
|
|
30482
|
+
}
|
|
30396
30483
|
},
|
|
30397
30484
|
"delete": {
|
|
30398
30485
|
"summary": "Delete a public SSH key for the authenticated user",
|
|
30399
30486
|
"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/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
30400
30487
|
"tags": ["users"],
|
|
30401
|
-
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
|
30488
|
+
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
|
30402
30489
|
"externalDocs": {
|
|
30403
30490
|
"description": "API method documentation",
|
|
30404
30491
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
|
@@ -30418,7 +30505,17 @@
|
|
|
30418
30505
|
"category": "users",
|
|
30419
30506
|
"subcategory": "keys"
|
|
30420
30507
|
},
|
|
30421
|
-
"x-octokit": {
|
|
30508
|
+
"x-octokit": {
|
|
30509
|
+
"changes": [
|
|
30510
|
+
{
|
|
30511
|
+
"type": "OPERATION",
|
|
30512
|
+
"date": "2021-10-05",
|
|
30513
|
+
"before": {
|
|
30514
|
+
"operationId": "users/delete-public-ssh-key-for-authenticated"
|
|
30515
|
+
}
|
|
30516
|
+
}
|
|
30517
|
+
]
|
|
30518
|
+
}
|
|
30422
30519
|
}
|
|
30423
30520
|
},
|
|
30424
30521
|
"/user/memberships/orgs": {
|
|
@@ -30922,18 +31019,6 @@
|
|
|
30922
31019
|
"x-github": {
|
|
30923
31020
|
"githubCloudOnly": false,
|
|
30924
31021
|
"enabledForGitHubApps": false,
|
|
30925
|
-
"previews": [
|
|
30926
|
-
{
|
|
30927
|
-
"required": false,
|
|
30928
|
-
"name": "nebula",
|
|
30929
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
30930
|
-
},
|
|
30931
|
-
{
|
|
30932
|
-
"required": false,
|
|
30933
|
-
"name": "baptiste",
|
|
30934
|
-
"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/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
30935
|
-
}
|
|
30936
|
-
],
|
|
30937
31022
|
"category": "repos",
|
|
30938
31023
|
"subcategory": null
|
|
30939
31024
|
},
|
|
@@ -30994,7 +31079,7 @@
|
|
|
30994
31079
|
"summary": "Accept a repository invitation",
|
|
30995
31080
|
"description": "",
|
|
30996
31081
|
"tags": ["repos"],
|
|
30997
|
-
"operationId": "repos/accept-invitation",
|
|
31082
|
+
"operationId": "repos/accept-invitation-for-authenticated-user",
|
|
30998
31083
|
"externalDocs": {
|
|
30999
31084
|
"description": "API method documentation",
|
|
31000
31085
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#accept-a-repository-invitation"
|
|
@@ -31014,13 +31099,21 @@
|
|
|
31014
31099
|
"category": "repos",
|
|
31015
31100
|
"subcategory": "invitations"
|
|
31016
31101
|
},
|
|
31017
|
-
"x-octokit": {
|
|
31102
|
+
"x-octokit": {
|
|
31103
|
+
"changes": [
|
|
31104
|
+
{
|
|
31105
|
+
"type": "OPERATION",
|
|
31106
|
+
"date": "2021-10-05",
|
|
31107
|
+
"before": { "operationId": "repos/accept-invitation" }
|
|
31108
|
+
}
|
|
31109
|
+
]
|
|
31110
|
+
}
|
|
31018
31111
|
},
|
|
31019
31112
|
"delete": {
|
|
31020
31113
|
"summary": "Decline a repository invitation",
|
|
31021
31114
|
"description": "",
|
|
31022
31115
|
"tags": ["repos"],
|
|
31023
|
-
"operationId": "repos/decline-invitation",
|
|
31116
|
+
"operationId": "repos/decline-invitation-for-authenticated-user",
|
|
31024
31117
|
"externalDocs": {
|
|
31025
31118
|
"description": "API method documentation",
|
|
31026
31119
|
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#decline-a-repository-invitation"
|
|
@@ -31040,7 +31133,15 @@
|
|
|
31040
31133
|
"category": "repos",
|
|
31041
31134
|
"subcategory": "invitations"
|
|
31042
31135
|
},
|
|
31043
|
-
"x-octokit": {
|
|
31136
|
+
"x-octokit": {
|
|
31137
|
+
"changes": [
|
|
31138
|
+
{
|
|
31139
|
+
"type": "OPERATION",
|
|
31140
|
+
"date": "2021-10-05",
|
|
31141
|
+
"before": { "operationId": "repos/decline-invitation" }
|
|
31142
|
+
}
|
|
31143
|
+
]
|
|
31144
|
+
}
|
|
31044
31145
|
}
|
|
31045
31146
|
},
|
|
31046
31147
|
"/user/starred": {
|
|
@@ -31969,13 +32070,6 @@
|
|
|
31969
32070
|
"x-github": {
|
|
31970
32071
|
"githubCloudOnly": false,
|
|
31971
32072
|
"enabledForGitHubApps": true,
|
|
31972
|
-
"previews": [
|
|
31973
|
-
{
|
|
31974
|
-
"required": false,
|
|
31975
|
-
"name": "nebula",
|
|
31976
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
31977
|
-
}
|
|
31978
|
-
],
|
|
31979
32073
|
"category": "repos",
|
|
31980
32074
|
"subcategory": null
|
|
31981
32075
|
},
|
|
@@ -33905,6 +33999,20 @@
|
|
|
33905
33999
|
"responses": { "501": { "description": "Not Implemented" } }
|
|
33906
34000
|
}
|
|
33907
34001
|
},
|
|
34002
|
+
"/repos/{owner}/{repo}/releases/generate-notes": {
|
|
34003
|
+
"post": {
|
|
34004
|
+
"summary": "Generate release notes content for a release",
|
|
34005
|
+
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34006
|
+
"tags": ["repos"],
|
|
34007
|
+
"operationId": "repos/generate-release-notes",
|
|
34008
|
+
"externalDocs": {
|
|
34009
|
+
"description": "API method documentation",
|
|
34010
|
+
"url": "https://docs.github.com/rest/reference/repos#generate-release-notes"
|
|
34011
|
+
},
|
|
34012
|
+
"x-octokit": { "api.github.com.json": "removed" },
|
|
34013
|
+
"responses": { "501": { "description": "Not Implemented" } }
|
|
34014
|
+
}
|
|
34015
|
+
},
|
|
33908
34016
|
"/repos/{owner}/{repo}/secret-scanning/alerts": {
|
|
33909
34017
|
"get": {
|
|
33910
34018
|
"summary": "List secret scanning alerts for a repository",
|
|
@@ -34319,7 +34427,7 @@
|
|
|
34319
34427
|
"summary": "List users blocked by the authenticated user",
|
|
34320
34428
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34321
34429
|
"tags": ["users"],
|
|
34322
|
-
"operationId": "users/list-blocked-by-authenticated",
|
|
34430
|
+
"operationId": "users/list-blocked-by-authenticated-user",
|
|
34323
34431
|
"externalDocs": {
|
|
34324
34432
|
"description": "API method documentation",
|
|
34325
34433
|
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
|
|
@@ -34371,7 +34479,7 @@
|
|
|
34371
34479
|
"summary": "Set primary email visibility for the authenticated user",
|
|
34372
34480
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34373
34481
|
"tags": ["users"],
|
|
34374
|
-
"operationId": "users/set-primary-email-visibility-for-authenticated",
|
|
34482
|
+
"operationId": "users/set-primary-email-visibility-for-authenticated-user",
|
|
34375
34483
|
"externalDocs": {
|
|
34376
34484
|
"description": "API method documentation",
|
|
34377
34485
|
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
|
|
@@ -34385,7 +34493,7 @@
|
|
|
34385
34493
|
"summary": "List email addresses for the authenticated user",
|
|
34386
34494
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34387
34495
|
"tags": ["users"],
|
|
34388
|
-
"operationId": "users/list-emails-for-authenticated",
|
|
34496
|
+
"operationId": "users/list-emails-for-authenticated-user",
|
|
34389
34497
|
"externalDocs": {
|
|
34390
34498
|
"description": "API method documentation",
|
|
34391
34499
|
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
|
@@ -34397,7 +34505,7 @@
|
|
|
34397
34505
|
"summary": "Add an email address for the authenticated user",
|
|
34398
34506
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34399
34507
|
"tags": ["users"],
|
|
34400
|
-
"operationId": "users/add-email-for-authenticated",
|
|
34508
|
+
"operationId": "users/add-email-for-authenticated-user",
|
|
34401
34509
|
"externalDocs": {
|
|
34402
34510
|
"description": "API method documentation",
|
|
34403
34511
|
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
|
@@ -34409,7 +34517,7 @@
|
|
|
34409
34517
|
"summary": "Delete an email address for the authenticated user",
|
|
34410
34518
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34411
34519
|
"tags": ["users"],
|
|
34412
|
-
"operationId": "users/delete-email-for-authenticated",
|
|
34520
|
+
"operationId": "users/delete-email-for-authenticated-user",
|
|
34413
34521
|
"externalDocs": {
|
|
34414
34522
|
"description": "API method documentation",
|
|
34415
34523
|
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
|
@@ -34569,7 +34677,7 @@
|
|
|
34569
34677
|
"summary": "List repositories for a user migration",
|
|
34570
34678
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34571
34679
|
"tags": ["migrations"],
|
|
34572
|
-
"operationId": "migrations/list-repos-for-user",
|
|
34680
|
+
"operationId": "migrations/list-repos-for-authenticated-user",
|
|
34573
34681
|
"externalDocs": {
|
|
34574
34682
|
"description": "API method documentation",
|
|
34575
34683
|
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
|
|
@@ -34691,7 +34799,7 @@
|
|
|
34691
34799
|
"summary": "List public email addresses for the authenticated user",
|
|
34692
34800
|
"description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
|
|
34693
34801
|
"tags": ["users"],
|
|
34694
|
-
"operationId": "users/list-public-emails-for-authenticated",
|
|
34802
|
+
"operationId": "users/list-public-emails-for-authenticated-user",
|
|
34695
34803
|
"externalDocs": {
|
|
34696
34804
|
"description": "API method documentation",
|
|
34697
34805
|
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
|
@@ -35219,6 +35327,13 @@
|
|
|
35219
35327
|
"required": false,
|
|
35220
35328
|
"schema": { "type": "string", "format": "date-time" }
|
|
35221
35329
|
},
|
|
35330
|
+
"exclude-pull-requests": {
|
|
35331
|
+
"name": "exclude_pull_requests",
|
|
35332
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
35333
|
+
"in": "query",
|
|
35334
|
+
"required": false,
|
|
35335
|
+
"schema": { "type": "boolean", "default": false }
|
|
35336
|
+
},
|
|
35222
35337
|
"run-id": {
|
|
35223
35338
|
"name": "run_id",
|
|
35224
35339
|
"description": "The id of the workflow run.",
|
|
@@ -35226,6 +35341,13 @@
|
|
|
35226
35341
|
"required": true,
|
|
35227
35342
|
"schema": { "type": "integer" }
|
|
35228
35343
|
},
|
|
35344
|
+
"attempt-number": {
|
|
35345
|
+
"name": "attempt_number",
|
|
35346
|
+
"description": "The attempt number of the workflow run.",
|
|
35347
|
+
"in": "path",
|
|
35348
|
+
"required": true,
|
|
35349
|
+
"schema": { "type": "integer" }
|
|
35350
|
+
},
|
|
35229
35351
|
"workflow-id": {
|
|
35230
35352
|
"name": "workflow_id",
|
|
35231
35353
|
"in": "path",
|
|
@@ -41689,6 +41811,11 @@
|
|
|
41689
41811
|
"type": "string",
|
|
41690
41812
|
"example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
|
|
41691
41813
|
},
|
|
41814
|
+
"run_attempt": {
|
|
41815
|
+
"type": "integer",
|
|
41816
|
+
"description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
|
|
41817
|
+
"example": 1
|
|
41818
|
+
},
|
|
41692
41819
|
"node_id": { "type": "string", "example": "MDg6Q2hlY2tSdW40" },
|
|
41693
41820
|
"head_sha": {
|
|
41694
41821
|
"description": "The SHA of the commit that is being run.",
|
|
@@ -41779,6 +41906,36 @@
|
|
|
41779
41906
|
"check_run_url": {
|
|
41780
41907
|
"type": "string",
|
|
41781
41908
|
"example": "https://api.github.com/repos/github/hello-world/check-runs/4"
|
|
41909
|
+
},
|
|
41910
|
+
"labels": {
|
|
41911
|
+
"type": "array",
|
|
41912
|
+
"items": { "type": "string" },
|
|
41913
|
+
"description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.",
|
|
41914
|
+
"example": ["self-hosted", "foo", "bar"]
|
|
41915
|
+
},
|
|
41916
|
+
"runner_id": {
|
|
41917
|
+
"type": "integer",
|
|
41918
|
+
"nullable": true,
|
|
41919
|
+
"example": 1,
|
|
41920
|
+
"description": "The ID of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
|
|
41921
|
+
},
|
|
41922
|
+
"runner_name": {
|
|
41923
|
+
"type": "string",
|
|
41924
|
+
"nullable": true,
|
|
41925
|
+
"example": "my runner",
|
|
41926
|
+
"description": "The name of the runner to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
|
|
41927
|
+
},
|
|
41928
|
+
"runner_group_id": {
|
|
41929
|
+
"type": "integer",
|
|
41930
|
+
"nullable": true,
|
|
41931
|
+
"example": 2,
|
|
41932
|
+
"description": "The ID of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
|
|
41933
|
+
},
|
|
41934
|
+
"runner_group_name": {
|
|
41935
|
+
"type": "string",
|
|
41936
|
+
"nullable": true,
|
|
41937
|
+
"example": "my runner group",
|
|
41938
|
+
"description": "The name of the runner group to which this job has been assigned. (If a runner hasn't yet been assigned, this will be null.)"
|
|
41782
41939
|
}
|
|
41783
41940
|
},
|
|
41784
41941
|
"required": [
|
|
@@ -41794,7 +41951,12 @@
|
|
|
41794
41951
|
"conclusion",
|
|
41795
41952
|
"started_at",
|
|
41796
41953
|
"completed_at",
|
|
41797
|
-
"check_run_url"
|
|
41954
|
+
"check_run_url",
|
|
41955
|
+
"labels",
|
|
41956
|
+
"runner_id",
|
|
41957
|
+
"runner_name",
|
|
41958
|
+
"runner_group_id",
|
|
41959
|
+
"runner_group_name"
|
|
41798
41960
|
]
|
|
41799
41961
|
},
|
|
41800
41962
|
"actions-enabled": {
|
|
@@ -41938,7 +42100,7 @@
|
|
|
41938
42100
|
},
|
|
41939
42101
|
"run_attempt": {
|
|
41940
42102
|
"type": "integer",
|
|
41941
|
-
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was
|
|
42103
|
+
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.",
|
|
41942
42104
|
"example": 1
|
|
41943
42105
|
},
|
|
41944
42106
|
"event": { "type": "string", "example": "push" },
|
|
@@ -41973,6 +42135,11 @@
|
|
|
41973
42135
|
},
|
|
41974
42136
|
"created_at": { "type": "string", "format": "date-time" },
|
|
41975
42137
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
42138
|
+
"run_started_at": {
|
|
42139
|
+
"type": "string",
|
|
42140
|
+
"format": "date-time",
|
|
42141
|
+
"description": "The start time of the latest run. Resets on re-run."
|
|
42142
|
+
},
|
|
41976
42143
|
"jobs_url": {
|
|
41977
42144
|
"description": "The URL to the jobs for the workflow run.",
|
|
41978
42145
|
"type": "string",
|
|
@@ -43500,7 +43667,6 @@
|
|
|
43500
43667
|
"created_at": { "$ref": "#/components/schemas/alert-created-at" },
|
|
43501
43668
|
"url": { "$ref": "#/components/schemas/alert-url" },
|
|
43502
43669
|
"html_url": { "$ref": "#/components/schemas/alert-html-url" },
|
|
43503
|
-
"instances": { "deprecated": true },
|
|
43504
43670
|
"instances_url": {
|
|
43505
43671
|
"$ref": "#/components/schemas/alert-instances-url"
|
|
43506
43672
|
},
|
|
@@ -43617,8 +43783,7 @@
|
|
|
43617
43783
|
"type": "string",
|
|
43618
43784
|
"description": "Warning generated when processing the analysis",
|
|
43619
43785
|
"example": "123 results were ignored"
|
|
43620
|
-
}
|
|
43621
|
-
"tool_name": { "type": "string" }
|
|
43786
|
+
}
|
|
43622
43787
|
},
|
|
43623
43788
|
"required": [
|
|
43624
43789
|
"ref",
|
|
@@ -47519,6 +47684,10 @@
|
|
|
47519
47684
|
"master_branch": { "type": "string" },
|
|
47520
47685
|
"archived": { "type": "boolean" },
|
|
47521
47686
|
"disabled": { "type": "boolean" },
|
|
47687
|
+
"visibility": {
|
|
47688
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
47689
|
+
"type": "string"
|
|
47690
|
+
},
|
|
47522
47691
|
"mirror_url": {
|
|
47523
47692
|
"type": "string",
|
|
47524
47693
|
"format": "uri",
|
|
@@ -47567,7 +47736,8 @@
|
|
|
47567
47736
|
"watchers_count": { "type": "integer" },
|
|
47568
47737
|
"created_at": { "type": "string", "format": "date-time" },
|
|
47569
47738
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
47570
|
-
"allow_forking": { "type": "boolean" }
|
|
47739
|
+
"allow_forking": { "type": "boolean" },
|
|
47740
|
+
"is_template": { "type": "boolean" }
|
|
47571
47741
|
},
|
|
47572
47742
|
"required": [
|
|
47573
47743
|
"archive_url",
|
|
@@ -47723,6 +47893,7 @@
|
|
|
47723
47893
|
"hooks_url": { "type": "string", "format": "uri" },
|
|
47724
47894
|
"html_url": { "type": "string", "format": "uri" },
|
|
47725
47895
|
"id": { "type": "integer" },
|
|
47896
|
+
"is_template": { "type": "boolean" },
|
|
47726
47897
|
"node_id": { "type": "string" },
|
|
47727
47898
|
"issue_comment_url": { "type": "string" },
|
|
47728
47899
|
"issue_events_url": { "type": "string" },
|
|
@@ -47816,6 +47987,10 @@
|
|
|
47816
47987
|
"master_branch": { "type": "string" },
|
|
47817
47988
|
"archived": { "type": "boolean" },
|
|
47818
47989
|
"disabled": { "type": "boolean" },
|
|
47990
|
+
"visibility": {
|
|
47991
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
47992
|
+
"type": "string"
|
|
47993
|
+
},
|
|
47819
47994
|
"mirror_url": {
|
|
47820
47995
|
"type": "string",
|
|
47821
47996
|
"format": "uri",
|
|
@@ -49016,6 +49191,10 @@
|
|
|
49016
49191
|
"type": "boolean",
|
|
49017
49192
|
"description": "Returns whether or not this repository disabled."
|
|
49018
49193
|
},
|
|
49194
|
+
"visibility": {
|
|
49195
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
49196
|
+
"type": "string"
|
|
49197
|
+
},
|
|
49019
49198
|
"license": { "$ref": "#/components/schemas/nullable-license-simple" },
|
|
49020
49199
|
"permissions": {
|
|
49021
49200
|
"type": "object",
|
|
@@ -49037,7 +49216,8 @@
|
|
|
49037
49216
|
"allow_rebase_merge": { "type": "boolean" },
|
|
49038
49217
|
"allow_auto_merge": { "type": "boolean" },
|
|
49039
49218
|
"delete_branch_on_merge": { "type": "boolean" },
|
|
49040
|
-
"allow_forking": { "type": "boolean" }
|
|
49219
|
+
"allow_forking": { "type": "boolean" },
|
|
49220
|
+
"is_template": { "type": "boolean" }
|
|
49041
49221
|
},
|
|
49042
49222
|
"required": [
|
|
49043
49223
|
"archive_url",
|
|
@@ -54520,7 +54700,12 @@
|
|
|
54520
54700
|
"completed_at": "2020-01-20T09:44:39.000-08:00"
|
|
54521
54701
|
}
|
|
54522
54702
|
],
|
|
54523
|
-
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496"
|
|
54703
|
+
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
|
|
54704
|
+
"labels": ["self-hosted", "foo", "bar"],
|
|
54705
|
+
"runner_id": 1,
|
|
54706
|
+
"runner_name": "my runner",
|
|
54707
|
+
"runner_group_id": 2,
|
|
54708
|
+
"runner_group_name": "my runner group"
|
|
54524
54709
|
}
|
|
54525
54710
|
},
|
|
54526
54711
|
"actions-repository-permissions": {
|
|
@@ -54976,7 +55161,12 @@
|
|
|
54976
55161
|
"completed_at": "2020-01-20T09:44:39.000-08:00"
|
|
54977
55162
|
}
|
|
54978
55163
|
],
|
|
54979
|
-
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496"
|
|
55164
|
+
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
|
|
55165
|
+
"labels": ["self-hosted", "foo", "bar"],
|
|
55166
|
+
"runner_id": 1,
|
|
55167
|
+
"runner_name": "my runner",
|
|
55168
|
+
"runner_group_id": 2,
|
|
55169
|
+
"runner_group_name": "my runner group"
|
|
54980
55170
|
}
|
|
54981
55171
|
]
|
|
54982
55172
|
}
|
|
@@ -56394,8 +56584,7 @@
|
|
|
56394
56584
|
},
|
|
56395
56585
|
"classifications": ["test"]
|
|
56396
56586
|
},
|
|
56397
|
-
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
56398
|
-
"instances": null
|
|
56587
|
+
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
56399
56588
|
}
|
|
56400
56589
|
},
|
|
56401
56590
|
"code-scanning-alert-dismissed": {
|
|
@@ -63276,6 +63465,7 @@
|
|
|
63276
63465
|
"has_downloads": true,
|
|
63277
63466
|
"archived": true,
|
|
63278
63467
|
"disabled": true,
|
|
63468
|
+
"visibility": "private",
|
|
63279
63469
|
"license": {
|
|
63280
63470
|
"key": "mit",
|
|
63281
63471
|
"name": "MIT License",
|