@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
|
@@ -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" },
|
|
@@ -2168,7 +2168,7 @@
|
|
|
2168
2168
|
"/enterprises/{enterprise}/actions/runner-groups": {
|
|
2169
2169
|
"get": {
|
|
2170
2170
|
"summary": "List self-hosted runner groups for an enterprise",
|
|
2171
|
-
"description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2171
|
+
"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.",
|
|
2172
2172
|
"operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise",
|
|
2173
2173
|
"tags": ["enterprise-admin"],
|
|
2174
2174
|
"externalDocs": {
|
|
@@ -2218,7 +2218,7 @@
|
|
|
2218
2218
|
},
|
|
2219
2219
|
"post": {
|
|
2220
2220
|
"summary": "Create a self-hosted runner group for an enterprise",
|
|
2221
|
-
"description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2221
|
+
"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.",
|
|
2222
2222
|
"operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise",
|
|
2223
2223
|
"tags": ["enterprise-admin"],
|
|
2224
2224
|
"externalDocs": {
|
|
@@ -2300,7 +2300,7 @@
|
|
|
2300
2300
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": {
|
|
2301
2301
|
"get": {
|
|
2302
2302
|
"summary": "Get a self-hosted runner group for an enterprise",
|
|
2303
|
-
"description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2303
|
+
"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.",
|
|
2304
2304
|
"operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise",
|
|
2305
2305
|
"tags": ["enterprise-admin"],
|
|
2306
2306
|
"externalDocs": {
|
|
@@ -2339,7 +2339,7 @@
|
|
|
2339
2339
|
},
|
|
2340
2340
|
"patch": {
|
|
2341
2341
|
"summary": "Update a self-hosted runner group for an enterprise",
|
|
2342
|
-
"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 `
|
|
2342
|
+
"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.",
|
|
2343
2343
|
"operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise",
|
|
2344
2344
|
"tags": ["enterprise-admin"],
|
|
2345
2345
|
"externalDocs": {
|
|
@@ -2403,7 +2403,7 @@
|
|
|
2403
2403
|
},
|
|
2404
2404
|
"delete": {
|
|
2405
2405
|
"summary": "Delete a self-hosted runner group from an enterprise",
|
|
2406
|
-
"description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2406
|
+
"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.",
|
|
2407
2407
|
"operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise",
|
|
2408
2408
|
"tags": ["enterprise-admin"],
|
|
2409
2409
|
"externalDocs": {
|
|
@@ -2428,7 +2428,7 @@
|
|
|
2428
2428
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations": {
|
|
2429
2429
|
"get": {
|
|
2430
2430
|
"summary": "List organization access to a self-hosted runner group in an enterprise",
|
|
2431
|
-
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `
|
|
2431
|
+
"description": "Lists the organizations with access to a self-hosted runner group.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
2432
2432
|
"operationId": "enterprise-admin/list-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
2433
2433
|
"tags": ["enterprise-admin"],
|
|
2434
2434
|
"externalDocs": {
|
|
@@ -2479,7 +2479,7 @@
|
|
|
2479
2479
|
},
|
|
2480
2480
|
"put": {
|
|
2481
2481
|
"summary": "Set organization access for a self-hosted runner group in an enterprise",
|
|
2482
|
-
"description": "Replaces the list of organizations that have access to a self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2482
|
+
"description": "Replaces the list of organizations that have access to a 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.",
|
|
2483
2483
|
"operationId": "enterprise-admin/set-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
2484
2484
|
"tags": ["enterprise-admin"],
|
|
2485
2485
|
"externalDocs": {
|
|
@@ -2526,7 +2526,7 @@
|
|
|
2526
2526
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/organizations/{org_id}": {
|
|
2527
2527
|
"put": {
|
|
2528
2528
|
"summary": "Add organization access to a self-hosted runner group in an enterprise",
|
|
2529
|
-
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `
|
|
2529
|
+
"description": "Adds an organization to the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-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.",
|
|
2530
2530
|
"operationId": "enterprise-admin/add-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
2531
2531
|
"tags": ["enterprise-admin"],
|
|
2532
2532
|
"externalDocs": {
|
|
@@ -2550,7 +2550,7 @@
|
|
|
2550
2550
|
},
|
|
2551
2551
|
"delete": {
|
|
2552
2552
|
"summary": "Remove organization access to a self-hosted runner group in an enterprise",
|
|
2553
|
-
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-a-self-hosted-runner-group-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `
|
|
2553
|
+
"description": "Removes an organization from the list of selected organizations that can access a self-hosted runner group. The runner group must have `visibility` set to `selected`. For more information, see \"[Create a self-hosted runner group for an enterprise](#create-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.",
|
|
2554
2554
|
"operationId": "enterprise-admin/remove-org-access-to-self-hosted-runner-group-in-enterprise",
|
|
2555
2555
|
"tags": ["enterprise-admin"],
|
|
2556
2556
|
"externalDocs": {
|
|
@@ -2576,7 +2576,7 @@
|
|
|
2576
2576
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": {
|
|
2577
2577
|
"get": {
|
|
2578
2578
|
"summary": "List self-hosted runners in a group for an enterprise",
|
|
2579
|
-
"description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `
|
|
2579
|
+
"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.",
|
|
2580
2580
|
"operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise",
|
|
2581
2581
|
"tags": ["enterprise-admin"],
|
|
2582
2582
|
"externalDocs": {
|
|
@@ -2626,7 +2626,7 @@
|
|
|
2626
2626
|
},
|
|
2627
2627
|
"put": {
|
|
2628
2628
|
"summary": "Set self-hosted runners in a group for an enterprise",
|
|
2629
|
-
"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 `
|
|
2629
|
+
"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.",
|
|
2630
2630
|
"operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise",
|
|
2631
2631
|
"tags": ["enterprise-admin"],
|
|
2632
2632
|
"externalDocs": {
|
|
@@ -2673,7 +2673,7 @@
|
|
|
2673
2673
|
"/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": {
|
|
2674
2674
|
"put": {
|
|
2675
2675
|
"summary": "Add a self-hosted runner to a group for an enterprise",
|
|
2676
|
-
"description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2676
|
+
"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.",
|
|
2677
2677
|
"operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise",
|
|
2678
2678
|
"tags": ["enterprise-admin"],
|
|
2679
2679
|
"externalDocs": {
|
|
@@ -2697,7 +2697,7 @@
|
|
|
2697
2697
|
},
|
|
2698
2698
|
"delete": {
|
|
2699
2699
|
"summary": "Remove a self-hosted runner from a group for an enterprise",
|
|
2700
|
-
"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 `
|
|
2700
|
+
"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.",
|
|
2701
2701
|
"operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise",
|
|
2702
2702
|
"tags": ["enterprise-admin"],
|
|
2703
2703
|
"externalDocs": {
|
|
@@ -2723,7 +2723,7 @@
|
|
|
2723
2723
|
"/enterprises/{enterprise}/actions/runners": {
|
|
2724
2724
|
"get": {
|
|
2725
2725
|
"summary": "List self-hosted runners for an enterprise",
|
|
2726
|
-
"description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2726
|
+
"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.",
|
|
2727
2727
|
"operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise",
|
|
2728
2728
|
"tags": ["enterprise-admin"],
|
|
2729
2729
|
"externalDocs": {
|
|
@@ -2773,7 +2773,7 @@
|
|
|
2773
2773
|
"/enterprises/{enterprise}/actions/runners/downloads": {
|
|
2774
2774
|
"get": {
|
|
2775
2775
|
"summary": "List runner applications for an enterprise",
|
|
2776
|
-
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `
|
|
2776
|
+
"description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.",
|
|
2777
2777
|
"operationId": "enterprise-admin/list-runner-applications-for-enterprise",
|
|
2778
2778
|
"tags": ["enterprise-admin"],
|
|
2779
2779
|
"externalDocs": {
|
|
@@ -2812,7 +2812,7 @@
|
|
|
2812
2812
|
"/enterprises/{enterprise}/actions/runners/registration-token": {
|
|
2813
2813
|
"post": {
|
|
2814
2814
|
"summary": "Create a registration token for an enterprise",
|
|
2815
|
-
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `
|
|
2815
|
+
"description": "Returns a token that you can pass to the `config` script. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using registration token\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/enterprises/octo-enterprise --token TOKEN\n```",
|
|
2816
2816
|
"operationId": "enterprise-admin/create-registration-token-for-enterprise",
|
|
2817
2817
|
"tags": ["enterprise-admin"],
|
|
2818
2818
|
"externalDocs": {
|
|
@@ -2850,7 +2850,7 @@
|
|
|
2850
2850
|
"/enterprises/{enterprise}/actions/runners/remove-token": {
|
|
2851
2851
|
"post": {
|
|
2852
2852
|
"summary": "Create a remove token for an enterprise",
|
|
2853
|
-
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `
|
|
2853
|
+
"description": "Returns a token that you can pass to the `config` script to remove a self-hosted runner from an enterprise. The token expires after one hour.\n\nYou must authenticate using an access token with the `manage_runners:enterprise` scope to use this endpoint.\n\n#### Example using remove token\n\nTo remove your self-hosted runner from an enterprise, replace `TOKEN` with the remove token provided by this\nendpoint.\n\n```\n./config.sh remove --token TOKEN\n```",
|
|
2854
2854
|
"operationId": "enterprise-admin/create-remove-token-for-enterprise",
|
|
2855
2855
|
"tags": ["enterprise-admin"],
|
|
2856
2856
|
"externalDocs": {
|
|
@@ -2888,7 +2888,7 @@
|
|
|
2888
2888
|
"/enterprises/{enterprise}/actions/runners/{runner_id}": {
|
|
2889
2889
|
"get": {
|
|
2890
2890
|
"summary": "Get a self-hosted runner for an enterprise",
|
|
2891
|
-
"description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `
|
|
2891
|
+
"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.",
|
|
2892
2892
|
"operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise",
|
|
2893
2893
|
"tags": ["enterprise-admin"],
|
|
2894
2894
|
"externalDocs": {
|
|
@@ -2923,7 +2923,7 @@
|
|
|
2923
2923
|
},
|
|
2924
2924
|
"delete": {
|
|
2925
2925
|
"summary": "Delete a self-hosted runner from an enterprise",
|
|
2926
|
-
"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 `
|
|
2926
|
+
"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.",
|
|
2927
2927
|
"operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise",
|
|
2928
2928
|
"tags": ["enterprise-admin"],
|
|
2929
2929
|
"externalDocs": {
|
|
@@ -5321,13 +5321,6 @@
|
|
|
5321
5321
|
"x-github": {
|
|
5322
5322
|
"githubCloudOnly": false,
|
|
5323
5323
|
"enabledForGitHubApps": true,
|
|
5324
|
-
"previews": [
|
|
5325
|
-
{
|
|
5326
|
-
"required": false,
|
|
5327
|
-
"name": "surtur",
|
|
5328
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
5329
|
-
}
|
|
5330
|
-
],
|
|
5331
5324
|
"category": "orgs",
|
|
5332
5325
|
"subcategory": null
|
|
5333
5326
|
},
|
|
@@ -5464,7 +5457,6 @@
|
|
|
5464
5457
|
}
|
|
5465
5458
|
},
|
|
5466
5459
|
"409": { "$ref": "#/components/responses/conflict" },
|
|
5467
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
5468
5460
|
"422": {
|
|
5469
5461
|
"description": "Validation failed",
|
|
5470
5462
|
"content": {
|
|
@@ -5482,13 +5474,6 @@
|
|
|
5482
5474
|
"x-github": {
|
|
5483
5475
|
"githubCloudOnly": false,
|
|
5484
5476
|
"enabledForGitHubApps": true,
|
|
5485
|
-
"previews": [
|
|
5486
|
-
{
|
|
5487
|
-
"required": false,
|
|
5488
|
-
"name": "surtur",
|
|
5489
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```"
|
|
5490
|
-
}
|
|
5491
|
-
],
|
|
5492
5477
|
"category": "orgs",
|
|
5493
5478
|
"subcategory": null
|
|
5494
5479
|
},
|
|
@@ -9672,18 +9657,6 @@
|
|
|
9672
9657
|
"x-github": {
|
|
9673
9658
|
"githubCloudOnly": false,
|
|
9674
9659
|
"enabledForGitHubApps": true,
|
|
9675
|
-
"previews": [
|
|
9676
|
-
{
|
|
9677
|
-
"required": false,
|
|
9678
|
-
"name": "nebula",
|
|
9679
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
9680
|
-
},
|
|
9681
|
-
{
|
|
9682
|
-
"required": false,
|
|
9683
|
-
"name": "baptiste",
|
|
9684
|
-
"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/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/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
9685
|
-
}
|
|
9686
|
-
],
|
|
9687
9660
|
"category": "repos",
|
|
9688
9661
|
"subcategory": null
|
|
9689
9662
|
},
|
|
@@ -9725,7 +9698,7 @@
|
|
|
9725
9698
|
},
|
|
9726
9699
|
"visibility": {
|
|
9727
9700
|
"type": "string",
|
|
9728
|
-
"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.
|
|
9701
|
+
"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.",
|
|
9729
9702
|
"enum": ["public", "private", "visibility", "internal"]
|
|
9730
9703
|
},
|
|
9731
9704
|
"has_issues": {
|
|
@@ -9829,18 +9802,6 @@
|
|
|
9829
9802
|
"x-github": {
|
|
9830
9803
|
"githubCloudOnly": false,
|
|
9831
9804
|
"enabledForGitHubApps": true,
|
|
9832
|
-
"previews": [
|
|
9833
|
-
{
|
|
9834
|
-
"required": false,
|
|
9835
|
-
"name": "nebula",
|
|
9836
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
9837
|
-
},
|
|
9838
|
-
{
|
|
9839
|
-
"required": false,
|
|
9840
|
-
"name": "baptiste",
|
|
9841
|
-
"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/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/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
9842
|
-
}
|
|
9843
|
-
],
|
|
9844
9805
|
"category": "repos",
|
|
9845
9806
|
"subcategory": null
|
|
9846
9807
|
},
|
|
@@ -9869,7 +9830,14 @@
|
|
|
9869
9830
|
{
|
|
9870
9831
|
"name": "secret_type",
|
|
9871
9832
|
"in": "query",
|
|
9872
|
-
"description": "A comma
|
|
9833
|
+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.",
|
|
9834
|
+
"required": false,
|
|
9835
|
+
"schema": { "type": "string" }
|
|
9836
|
+
},
|
|
9837
|
+
{
|
|
9838
|
+
"name": "resolution",
|
|
9839
|
+
"in": "query",
|
|
9840
|
+
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
|
9873
9841
|
"required": false,
|
|
9874
9842
|
"schema": { "type": "string" }
|
|
9875
9843
|
},
|
|
@@ -13013,13 +12981,6 @@
|
|
|
13013
12981
|
"x-github": {
|
|
13014
12982
|
"githubCloudOnly": false,
|
|
13015
12983
|
"enabledForGitHubApps": true,
|
|
13016
|
-
"previews": [
|
|
13017
|
-
{
|
|
13018
|
-
"required": false,
|
|
13019
|
-
"name": "nebula",
|
|
13020
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
13021
|
-
}
|
|
13022
|
-
],
|
|
13023
12984
|
"category": "repos",
|
|
13024
12985
|
"subcategory": null
|
|
13025
12986
|
},
|
|
@@ -13063,7 +13024,7 @@
|
|
|
13063
13024
|
},
|
|
13064
13025
|
"visibility": {
|
|
13065
13026
|
"type": "string",
|
|
13066
|
-
"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
|
|
13027
|
+
"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`.\"",
|
|
13067
13028
|
"enum": ["public", "private", "visibility", "internal"]
|
|
13068
13029
|
},
|
|
13069
13030
|
"security_and_analysis": {
|
|
@@ -13186,18 +13147,6 @@
|
|
|
13186
13147
|
"x-github": {
|
|
13187
13148
|
"githubCloudOnly": false,
|
|
13188
13149
|
"enabledForGitHubApps": true,
|
|
13189
|
-
"previews": [
|
|
13190
|
-
{
|
|
13191
|
-
"required": false,
|
|
13192
|
-
"name": "nebula",
|
|
13193
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
13194
|
-
},
|
|
13195
|
-
{
|
|
13196
|
-
"required": false,
|
|
13197
|
-
"name": "baptiste",
|
|
13198
|
-
"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/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/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
13199
|
-
}
|
|
13200
|
-
],
|
|
13201
13150
|
"category": "repos",
|
|
13202
13151
|
"subcategory": null
|
|
13203
13152
|
},
|
|
@@ -13897,7 +13846,8 @@
|
|
|
13897
13846
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
13898
13847
|
{ "$ref": "#/components/parameters/per-page" },
|
|
13899
13848
|
{ "$ref": "#/components/parameters/page" },
|
|
13900
|
-
{ "$ref": "#/components/parameters/created" }
|
|
13849
|
+
{ "$ref": "#/components/parameters/created" },
|
|
13850
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
13901
13851
|
],
|
|
13902
13852
|
"responses": {
|
|
13903
13853
|
"200": {
|
|
@@ -13948,7 +13898,8 @@
|
|
|
13948
13898
|
"parameters": [
|
|
13949
13899
|
{ "$ref": "#/components/parameters/owner" },
|
|
13950
13900
|
{ "$ref": "#/components/parameters/repo" },
|
|
13951
|
-
{ "$ref": "#/components/parameters/run-id" }
|
|
13901
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
13902
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
13952
13903
|
],
|
|
13953
13904
|
"responses": {
|
|
13954
13905
|
"200": {
|
|
@@ -14132,6 +14083,83 @@
|
|
|
14132
14083
|
"x-octokit": {}
|
|
14133
14084
|
}
|
|
14134
14085
|
},
|
|
14086
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
|
|
14087
|
+
"get": {
|
|
14088
|
+
"summary": "Get a workflow run attempt",
|
|
14089
|
+
"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.",
|
|
14090
|
+
"tags": ["actions"],
|
|
14091
|
+
"operationId": "actions/get-workflow-run-attempt",
|
|
14092
|
+
"externalDocs": {
|
|
14093
|
+
"description": "API method documentation",
|
|
14094
|
+
"url": "https://docs.github.com/rest/reference/actions#get-a-workflow-run-attempt"
|
|
14095
|
+
},
|
|
14096
|
+
"parameters": [
|
|
14097
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
14098
|
+
{ "$ref": "#/components/parameters/repo" },
|
|
14099
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
14100
|
+
{ "$ref": "#/components/parameters/attempt-number" },
|
|
14101
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
14102
|
+
],
|
|
14103
|
+
"responses": {
|
|
14104
|
+
"200": {
|
|
14105
|
+
"description": "Response",
|
|
14106
|
+
"content": {
|
|
14107
|
+
"application/json": {
|
|
14108
|
+
"schema": { "$ref": "#/components/schemas/workflow-run" },
|
|
14109
|
+
"examples": {
|
|
14110
|
+
"default": { "$ref": "#/components/examples/workflow-run" }
|
|
14111
|
+
}
|
|
14112
|
+
}
|
|
14113
|
+
}
|
|
14114
|
+
}
|
|
14115
|
+
},
|
|
14116
|
+
"x-github": {
|
|
14117
|
+
"githubCloudOnly": false,
|
|
14118
|
+
"enabledForGitHubApps": true,
|
|
14119
|
+
"previews": [],
|
|
14120
|
+
"category": "actions",
|
|
14121
|
+
"subcategory": "workflow-runs"
|
|
14122
|
+
},
|
|
14123
|
+
"x-octokit": {}
|
|
14124
|
+
}
|
|
14125
|
+
},
|
|
14126
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
|
|
14127
|
+
"get": {
|
|
14128
|
+
"summary": "Download workflow run attempt logs",
|
|
14129
|
+
"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.",
|
|
14130
|
+
"tags": ["actions"],
|
|
14131
|
+
"operationId": "actions/download-workflow-run-attempt-logs",
|
|
14132
|
+
"externalDocs": {
|
|
14133
|
+
"description": "API method documentation",
|
|
14134
|
+
"url": "https://docs.github.com/rest/reference/actions#download-workflow-run-attempt-logs"
|
|
14135
|
+
},
|
|
14136
|
+
"parameters": [
|
|
14137
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
14138
|
+
{ "$ref": "#/components/parameters/repo" },
|
|
14139
|
+
{ "$ref": "#/components/parameters/run-id" },
|
|
14140
|
+
{ "$ref": "#/components/parameters/attempt-number" }
|
|
14141
|
+
],
|
|
14142
|
+
"responses": {
|
|
14143
|
+
"302": {
|
|
14144
|
+
"description": "Response",
|
|
14145
|
+
"headers": {
|
|
14146
|
+
"Location": {
|
|
14147
|
+
"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",
|
|
14148
|
+
"schema": { "type": "string" }
|
|
14149
|
+
}
|
|
14150
|
+
}
|
|
14151
|
+
}
|
|
14152
|
+
},
|
|
14153
|
+
"x-github": {
|
|
14154
|
+
"githubCloudOnly": false,
|
|
14155
|
+
"enabledForGitHubApps": true,
|
|
14156
|
+
"previews": [],
|
|
14157
|
+
"category": "actions",
|
|
14158
|
+
"subcategory": "workflow-runs"
|
|
14159
|
+
},
|
|
14160
|
+
"x-octokit": {}
|
|
14161
|
+
}
|
|
14162
|
+
},
|
|
14135
14163
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": {
|
|
14136
14164
|
"post": {
|
|
14137
14165
|
"summary": "Cancel a workflow run",
|
|
@@ -14410,7 +14438,7 @@
|
|
|
14410
14438
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": {
|
|
14411
14439
|
"post": {
|
|
14412
14440
|
"summary": "Re-run a workflow",
|
|
14413
|
-
"description": "
|
|
14441
|
+
"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.",
|
|
14414
14442
|
"tags": ["actions"],
|
|
14415
14443
|
"operationId": "actions/re-run-workflow",
|
|
14416
14444
|
"externalDocs": {
|
|
@@ -14448,45 +14476,6 @@
|
|
|
14448
14476
|
"x-octokit": {}
|
|
14449
14477
|
}
|
|
14450
14478
|
},
|
|
14451
|
-
"/repos/{owner}/{repo}/actions/runs/{run_id}/retry": {
|
|
14452
|
-
"post": {
|
|
14453
|
-
"summary": "Retry a workflow",
|
|
14454
|
-
"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.",
|
|
14455
|
-
"tags": ["actions"],
|
|
14456
|
-
"operationId": "actions/retry-workflow",
|
|
14457
|
-
"externalDocs": {
|
|
14458
|
-
"description": "API method documentation",
|
|
14459
|
-
"url": "https://docs.github.com/rest/reference/actions#retry-a-workflow"
|
|
14460
|
-
},
|
|
14461
|
-
"parameters": [
|
|
14462
|
-
{ "$ref": "#/components/parameters/owner" },
|
|
14463
|
-
{ "$ref": "#/components/parameters/repo" },
|
|
14464
|
-
{ "$ref": "#/components/parameters/run-id" }
|
|
14465
|
-
],
|
|
14466
|
-
"responses": {
|
|
14467
|
-
"201": {
|
|
14468
|
-
"description": "Response",
|
|
14469
|
-
"content": {
|
|
14470
|
-
"application/json": {
|
|
14471
|
-
"schema": {
|
|
14472
|
-
"type": "object",
|
|
14473
|
-
"properties": {},
|
|
14474
|
-
"additionalProperties": false
|
|
14475
|
-
}
|
|
14476
|
-
}
|
|
14477
|
-
}
|
|
14478
|
-
}
|
|
14479
|
-
},
|
|
14480
|
-
"x-github": {
|
|
14481
|
-
"githubCloudOnly": false,
|
|
14482
|
-
"enabledForGitHubApps": false,
|
|
14483
|
-
"previews": [],
|
|
14484
|
-
"category": "actions",
|
|
14485
|
-
"subcategory": "workflow-runs"
|
|
14486
|
-
},
|
|
14487
|
-
"x-octokit": {}
|
|
14488
|
-
}
|
|
14489
|
-
},
|
|
14490
14479
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
|
|
14491
14480
|
"get": {
|
|
14492
14481
|
"summary": "Get workflow run usage",
|
|
@@ -14961,7 +14950,8 @@
|
|
|
14961
14950
|
{ "$ref": "#/components/parameters/workflow-run-status" },
|
|
14962
14951
|
{ "$ref": "#/components/parameters/per-page" },
|
|
14963
14952
|
{ "$ref": "#/components/parameters/page" },
|
|
14964
|
-
{ "$ref": "#/components/parameters/created" }
|
|
14953
|
+
{ "$ref": "#/components/parameters/created" },
|
|
14954
|
+
{ "$ref": "#/components/parameters/exclude-pull-requests" }
|
|
14965
14955
|
],
|
|
14966
14956
|
"responses": {
|
|
14967
14957
|
"200": {
|
|
@@ -15989,13 +15979,6 @@
|
|
|
15989
15979
|
"x-github": {
|
|
15990
15980
|
"githubCloudOnly": false,
|
|
15991
15981
|
"enabledForGitHubApps": true,
|
|
15992
|
-
"previews": [
|
|
15993
|
-
{
|
|
15994
|
-
"required": true,
|
|
15995
|
-
"name": "zzzax",
|
|
15996
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
15997
|
-
}
|
|
15998
|
-
],
|
|
15999
15982
|
"category": "repos",
|
|
16000
15983
|
"subcategory": "branches"
|
|
16001
15984
|
},
|
|
@@ -16036,13 +16019,6 @@
|
|
|
16036
16019
|
"x-github": {
|
|
16037
16020
|
"githubCloudOnly": false,
|
|
16038
16021
|
"enabledForGitHubApps": true,
|
|
16039
|
-
"previews": [
|
|
16040
|
-
{
|
|
16041
|
-
"required": true,
|
|
16042
|
-
"name": "zzzax",
|
|
16043
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
16044
|
-
}
|
|
16045
|
-
],
|
|
16046
16022
|
"category": "repos",
|
|
16047
16023
|
"subcategory": "branches"
|
|
16048
16024
|
},
|
|
@@ -16069,13 +16045,6 @@
|
|
|
16069
16045
|
"x-github": {
|
|
16070
16046
|
"githubCloudOnly": false,
|
|
16071
16047
|
"enabledForGitHubApps": true,
|
|
16072
|
-
"previews": [
|
|
16073
|
-
{
|
|
16074
|
-
"required": true,
|
|
16075
|
-
"name": "zzzax",
|
|
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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```"
|
|
16077
|
-
}
|
|
16078
|
-
],
|
|
16079
16048
|
"category": "repos",
|
|
16080
16049
|
"subcategory": "branches"
|
|
16081
16050
|
},
|
|
@@ -17925,6 +17894,62 @@
|
|
|
17925
17894
|
"x-octokit": {}
|
|
17926
17895
|
}
|
|
17927
17896
|
},
|
|
17897
|
+
"/repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest": {
|
|
17898
|
+
"post": {
|
|
17899
|
+
"summary": "Rerequest a check run",
|
|
17900
|
+
"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/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.",
|
|
17901
|
+
"tags": ["checks"],
|
|
17902
|
+
"operationId": "checks/rerequest-run",
|
|
17903
|
+
"externalDocs": {
|
|
17904
|
+
"description": "API method documentation",
|
|
17905
|
+
"url": "https://docs.github.com/rest/reference/checks#rerequest-a-check-run"
|
|
17906
|
+
},
|
|
17907
|
+
"parameters": [
|
|
17908
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
17909
|
+
{ "$ref": "#/components/parameters/repo" },
|
|
17910
|
+
{ "$ref": "#/components/parameters/check-run-id" }
|
|
17911
|
+
],
|
|
17912
|
+
"responses": {
|
|
17913
|
+
"201": {
|
|
17914
|
+
"description": "Response",
|
|
17915
|
+
"content": {
|
|
17916
|
+
"application/json": {
|
|
17917
|
+
"schema": {
|
|
17918
|
+
"type": "object",
|
|
17919
|
+
"properties": {},
|
|
17920
|
+
"additionalProperties": false
|
|
17921
|
+
}
|
|
17922
|
+
}
|
|
17923
|
+
}
|
|
17924
|
+
},
|
|
17925
|
+
"403": {
|
|
17926
|
+
"description": "Forbidden if the check run is not rerequestable or doesn't belong to the authenticated GitHub App",
|
|
17927
|
+
"content": {
|
|
17928
|
+
"application/json": {
|
|
17929
|
+
"schema": { "$ref": "#/components/schemas/basic-error" }
|
|
17930
|
+
}
|
|
17931
|
+
}
|
|
17932
|
+
},
|
|
17933
|
+
"404": { "$ref": "#/components/responses/not_found" },
|
|
17934
|
+
"422": {
|
|
17935
|
+
"description": "Validation error if the check run is not rerequestable",
|
|
17936
|
+
"content": {
|
|
17937
|
+
"application/json": {
|
|
17938
|
+
"schema": { "$ref": "#/components/schemas/basic-error" }
|
|
17939
|
+
}
|
|
17940
|
+
}
|
|
17941
|
+
}
|
|
17942
|
+
},
|
|
17943
|
+
"x-github": {
|
|
17944
|
+
"githubCloudOnly": false,
|
|
17945
|
+
"enabledForGitHubApps": true,
|
|
17946
|
+
"previews": [],
|
|
17947
|
+
"category": "checks",
|
|
17948
|
+
"subcategory": "runs"
|
|
17949
|
+
},
|
|
17950
|
+
"x-octokit": {}
|
|
17951
|
+
}
|
|
17952
|
+
},
|
|
17928
17953
|
"/repos/{owner}/{repo}/check-suites": {
|
|
17929
17954
|
"post": {
|
|
17930
17955
|
"summary": "Create a check suite",
|
|
@@ -18529,7 +18554,7 @@
|
|
|
18529
18554
|
"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
|
|
18530
18555
|
"get": {
|
|
18531
18556
|
"summary": "Get a code scanning analysis for a repository",
|
|
18532
|
-
"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)
|
|
18557
|
+
"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).",
|
|
18533
18558
|
"operationId": "code-scanning/get-analysis",
|
|
18534
18559
|
"tags": ["code-scanning"],
|
|
18535
18560
|
"externalDocs": {
|
|
@@ -26426,19 +26451,11 @@
|
|
|
26426
26451
|
}
|
|
26427
26452
|
},
|
|
26428
26453
|
"409": { "$ref": "#/components/responses/conflict" },
|
|
26429
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
26430
26454
|
"422": { "$ref": "#/components/responses/validation_failed" }
|
|
26431
26455
|
},
|
|
26432
26456
|
"x-github": {
|
|
26433
26457
|
"githubCloudOnly": false,
|
|
26434
26458
|
"enabledForGitHubApps": true,
|
|
26435
|
-
"previews": [
|
|
26436
|
-
{
|
|
26437
|
-
"required": true,
|
|
26438
|
-
"name": "switcheroo",
|
|
26439
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
|
26440
|
-
}
|
|
26441
|
-
],
|
|
26442
26459
|
"category": "repos",
|
|
26443
26460
|
"subcategory": "pages"
|
|
26444
26461
|
},
|
|
@@ -26547,19 +26564,11 @@
|
|
|
26547
26564
|
"responses": {
|
|
26548
26565
|
"204": { "description": "Response" },
|
|
26549
26566
|
"404": { "$ref": "#/components/responses/not_found" },
|
|
26550
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" },
|
|
26551
26567
|
"422": { "$ref": "#/components/responses/validation_failed" }
|
|
26552
26568
|
},
|
|
26553
26569
|
"x-github": {
|
|
26554
26570
|
"githubCloudOnly": false,
|
|
26555
26571
|
"enabledForGitHubApps": true,
|
|
26556
|
-
"previews": [
|
|
26557
|
-
{
|
|
26558
|
-
"required": true,
|
|
26559
|
-
"name": "switcheroo",
|
|
26560
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.switcheroo-preview+json\n```"
|
|
26561
|
-
}
|
|
26562
|
-
],
|
|
26563
26572
|
"category": "repos",
|
|
26564
26573
|
"subcategory": "pages"
|
|
26565
26574
|
},
|
|
@@ -28985,6 +28994,11 @@
|
|
|
28985
28994
|
"discussion_category_name": {
|
|
28986
28995
|
"type": "string",
|
|
28987
28996
|
"description": "If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see \"[Managing categories for discussions in your repository](https://docs.github.com/discussions/managing-discussions-for-your-community/managing-categories-for-discussions-in-your-repository).\""
|
|
28997
|
+
},
|
|
28998
|
+
"generate_release_notes": {
|
|
28999
|
+
"type": "boolean",
|
|
29000
|
+
"description": "Whether to automatically generate the name and body for this release. If `name` is specified, the specified name will be used; otherwise, a name will be automatically generated. If `body` is specified, the body will be pre-pended to the automatically generated notes.",
|
|
29001
|
+
"default": false
|
|
28988
29002
|
}
|
|
28989
29003
|
},
|
|
28990
29004
|
"required": ["tag_name"]
|
|
@@ -28995,7 +29009,8 @@
|
|
|
28995
29009
|
"name": "v1.0.0",
|
|
28996
29010
|
"body": "Description of the release",
|
|
28997
29011
|
"draft": false,
|
|
28998
|
-
"prerelease": false
|
|
29012
|
+
"prerelease": false,
|
|
29013
|
+
"generate_release_notes": false
|
|
28999
29014
|
}
|
|
29000
29015
|
}
|
|
29001
29016
|
}
|
|
@@ -29161,6 +29176,83 @@
|
|
|
29161
29176
|
"x-octokit": {}
|
|
29162
29177
|
}
|
|
29163
29178
|
},
|
|
29179
|
+
"/repos/{owner}/{repo}/releases/generate-notes": {
|
|
29180
|
+
"post": {
|
|
29181
|
+
"summary": "Generate release notes content for a release",
|
|
29182
|
+
"description": "Generate a name and body describing a [release](https://docs.github.com/rest/reference/repos#releases). The body content will be markdown formatted and contain information like the changes since last release and users who contributed. The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release.",
|
|
29183
|
+
"tags": ["repos"],
|
|
29184
|
+
"operationId": "repos/generate-release-notes",
|
|
29185
|
+
"externalDocs": {
|
|
29186
|
+
"description": "API method documentation",
|
|
29187
|
+
"url": "https://docs.github.com/rest/reference/repos#generate-release-notes"
|
|
29188
|
+
},
|
|
29189
|
+
"parameters": [
|
|
29190
|
+
{ "$ref": "#/components/parameters/owner" },
|
|
29191
|
+
{ "$ref": "#/components/parameters/repo" }
|
|
29192
|
+
],
|
|
29193
|
+
"requestBody": {
|
|
29194
|
+
"required": true,
|
|
29195
|
+
"content": {
|
|
29196
|
+
"application/json": {
|
|
29197
|
+
"schema": {
|
|
29198
|
+
"type": "object",
|
|
29199
|
+
"properties": {
|
|
29200
|
+
"tag_name": {
|
|
29201
|
+
"type": "string",
|
|
29202
|
+
"description": "The tag name for the release. This can be an existing tag or a new one."
|
|
29203
|
+
},
|
|
29204
|
+
"target_commitish": {
|
|
29205
|
+
"type": "string",
|
|
29206
|
+
"description": "Specifies the commitish value that will be the target for the release's tag. Required if the supplied tag_name does not reference an existing tag. Ignored if the tag_name already exists."
|
|
29207
|
+
},
|
|
29208
|
+
"previous_tag_name": {
|
|
29209
|
+
"type": "string",
|
|
29210
|
+
"description": "The name of the previous tag to use as the starting point for the release notes. Use to manually specify the range for the set of changes considered as part this release."
|
|
29211
|
+
},
|
|
29212
|
+
"configuration_file_path": {
|
|
29213
|
+
"type": "string",
|
|
29214
|
+
"description": "Specifies a path to a file in the repository containing configuration settings used for generating the release notes. If unspecified, the configuration file located in the repository at '.github/release.yml' or '.github/release.yaml' will be used. If that is not present, the default configuration will be used."
|
|
29215
|
+
}
|
|
29216
|
+
},
|
|
29217
|
+
"required": ["tag_name"]
|
|
29218
|
+
},
|
|
29219
|
+
"example": {
|
|
29220
|
+
"tag_name": "v1.0.0",
|
|
29221
|
+
"target_commitish": "main",
|
|
29222
|
+
"previous_tag_name": "v0.9.2",
|
|
29223
|
+
"configuration_file_path": ".github/custom_release_config.yml"
|
|
29224
|
+
}
|
|
29225
|
+
}
|
|
29226
|
+
}
|
|
29227
|
+
},
|
|
29228
|
+
"responses": {
|
|
29229
|
+
"200": {
|
|
29230
|
+
"description": "Name and body of generated release notes",
|
|
29231
|
+
"content": {
|
|
29232
|
+
"application/json": {
|
|
29233
|
+
"schema": {
|
|
29234
|
+
"$ref": "#/components/schemas/release-notes-content"
|
|
29235
|
+
},
|
|
29236
|
+
"examples": {
|
|
29237
|
+
"default": {
|
|
29238
|
+
"$ref": "#/components/examples/release-notes-content"
|
|
29239
|
+
}
|
|
29240
|
+
}
|
|
29241
|
+
}
|
|
29242
|
+
}
|
|
29243
|
+
},
|
|
29244
|
+
"404": { "$ref": "#/components/responses/not_found" }
|
|
29245
|
+
},
|
|
29246
|
+
"x-github": {
|
|
29247
|
+
"githubCloudOnly": false,
|
|
29248
|
+
"enabledForGitHubApps": true,
|
|
29249
|
+
"previews": [],
|
|
29250
|
+
"category": "repos",
|
|
29251
|
+
"subcategory": "releases"
|
|
29252
|
+
},
|
|
29253
|
+
"x-octokit": {}
|
|
29254
|
+
}
|
|
29255
|
+
},
|
|
29164
29256
|
"/repos/{owner}/{repo}/releases/latest": {
|
|
29165
29257
|
"get": {
|
|
29166
29258
|
"summary": "Get the latest release",
|
|
@@ -29598,7 +29690,14 @@
|
|
|
29598
29690
|
{
|
|
29599
29691
|
"name": "secret_type",
|
|
29600
29692
|
"in": "query",
|
|
29601
|
-
"description": "A comma
|
|
29693
|
+
"description": "A comma-separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug).",
|
|
29694
|
+
"required": false,
|
|
29695
|
+
"schema": { "type": "string" }
|
|
29696
|
+
},
|
|
29697
|
+
{
|
|
29698
|
+
"name": "resolution",
|
|
29699
|
+
"in": "query",
|
|
29700
|
+
"description": "A comma-separated list of resolutions. Only secret scanning alerts with one of these resolutions are listed. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.",
|
|
29602
29701
|
"required": false,
|
|
29603
29702
|
"schema": { "type": "string" }
|
|
29604
29703
|
},
|
|
@@ -29670,6 +29769,7 @@
|
|
|
29670
29769
|
}
|
|
29671
29770
|
}
|
|
29672
29771
|
},
|
|
29772
|
+
"304": { "$ref": "#/components/responses/not_modified" },
|
|
29673
29773
|
"404": {
|
|
29674
29774
|
"description": "Repository is public, or secret scanning is disabled for the repository, or the resource is not found"
|
|
29675
29775
|
},
|
|
@@ -30970,13 +31070,6 @@
|
|
|
30970
31070
|
"x-github": {
|
|
30971
31071
|
"githubCloudOnly": false,
|
|
30972
31072
|
"enabledForGitHubApps": false,
|
|
30973
|
-
"previews": [
|
|
30974
|
-
{
|
|
30975
|
-
"required": true,
|
|
30976
|
-
"name": "baptiste",
|
|
30977
|
-
"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/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
30978
|
-
}
|
|
30979
|
-
],
|
|
30980
31073
|
"category": "repos",
|
|
30981
31074
|
"subcategory": null
|
|
30982
31075
|
},
|
|
@@ -32625,19 +32718,11 @@
|
|
|
32625
32718
|
}
|
|
32626
32719
|
}
|
|
32627
32720
|
},
|
|
32628
|
-
"304": { "$ref": "#/components/responses/not_modified" }
|
|
32629
|
-
"415": { "$ref": "#/components/responses/preview_header_missing" }
|
|
32721
|
+
"304": { "$ref": "#/components/responses/not_modified" }
|
|
32630
32722
|
},
|
|
32631
32723
|
"x-github": {
|
|
32632
32724
|
"githubCloudOnly": false,
|
|
32633
32725
|
"enabledForGitHubApps": true,
|
|
32634
|
-
"previews": [
|
|
32635
|
-
{
|
|
32636
|
-
"required": true,
|
|
32637
|
-
"name": "cloak",
|
|
32638
|
-
"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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.cloak-preview\n```"
|
|
32639
|
-
}
|
|
32640
|
-
],
|
|
32641
32726
|
"category": "search",
|
|
32642
32727
|
"subcategory": null
|
|
32643
32728
|
},
|
|
@@ -34947,7 +35032,7 @@
|
|
|
34947
35032
|
"summary": "List users blocked by the authenticated user",
|
|
34948
35033
|
"description": "List the users you've blocked on your personal account.",
|
|
34949
35034
|
"tags": ["users"],
|
|
34950
|
-
"operationId": "users/list-blocked-by-authenticated",
|
|
35035
|
+
"operationId": "users/list-blocked-by-authenticated-user",
|
|
34951
35036
|
"externalDocs": {
|
|
34952
35037
|
"description": "API method documentation",
|
|
34953
35038
|
"url": "https://docs.github.com/rest/reference/users#list-users-blocked-by-the-authenticated-user"
|
|
@@ -34983,7 +35068,15 @@
|
|
|
34983
35068
|
"category": "users",
|
|
34984
35069
|
"subcategory": "blocking"
|
|
34985
35070
|
},
|
|
34986
|
-
"x-octokit": {
|
|
35071
|
+
"x-octokit": {
|
|
35072
|
+
"changes": [
|
|
35073
|
+
{
|
|
35074
|
+
"type": "OPERATION",
|
|
35075
|
+
"date": "2021-10-05",
|
|
35076
|
+
"before": { "operationId": "users/list-blocked-by-authenticated" }
|
|
35077
|
+
}
|
|
35078
|
+
]
|
|
35079
|
+
}
|
|
34987
35080
|
}
|
|
34988
35081
|
},
|
|
34989
35082
|
"/user/blocks/{username}": {
|
|
@@ -35079,7 +35172,7 @@
|
|
|
35079
35172
|
"summary": "Set primary email visibility for the authenticated user",
|
|
35080
35173
|
"description": "Sets the visibility for your primary email addresses.",
|
|
35081
35174
|
"tags": ["users"],
|
|
35082
|
-
"operationId": "users/set-primary-email-visibility-for-authenticated",
|
|
35175
|
+
"operationId": "users/set-primary-email-visibility-for-authenticated-user",
|
|
35083
35176
|
"externalDocs": {
|
|
35084
35177
|
"description": "API method documentation",
|
|
35085
35178
|
"url": "https://docs.github.com/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user"
|
|
@@ -35131,7 +35224,17 @@
|
|
|
35131
35224
|
"category": "users",
|
|
35132
35225
|
"subcategory": "emails"
|
|
35133
35226
|
},
|
|
35134
|
-
"x-octokit": {
|
|
35227
|
+
"x-octokit": {
|
|
35228
|
+
"changes": [
|
|
35229
|
+
{
|
|
35230
|
+
"type": "OPERATION",
|
|
35231
|
+
"date": "2021-10-05",
|
|
35232
|
+
"before": {
|
|
35233
|
+
"operationId": "users/set-primary-email-visibility-for-authenticated"
|
|
35234
|
+
}
|
|
35235
|
+
}
|
|
35236
|
+
]
|
|
35237
|
+
}
|
|
35135
35238
|
}
|
|
35136
35239
|
},
|
|
35137
35240
|
"/user/emails": {
|
|
@@ -35139,7 +35242,7 @@
|
|
|
35139
35242
|
"summary": "List email addresses for the authenticated user",
|
|
35140
35243
|
"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.",
|
|
35141
35244
|
"tags": ["users"],
|
|
35142
|
-
"operationId": "users/list-emails-for-authenticated",
|
|
35245
|
+
"operationId": "users/list-emails-for-authenticated-user",
|
|
35143
35246
|
"externalDocs": {
|
|
35144
35247
|
"description": "API method documentation",
|
|
35145
35248
|
"url": "https://docs.github.com/rest/reference/users#list-email-addresses-for-the-authenticated-user"
|
|
@@ -35176,13 +35279,21 @@
|
|
|
35176
35279
|
"category": "users",
|
|
35177
35280
|
"subcategory": "emails"
|
|
35178
35281
|
},
|
|
35179
|
-
"x-octokit": {
|
|
35282
|
+
"x-octokit": {
|
|
35283
|
+
"changes": [
|
|
35284
|
+
{
|
|
35285
|
+
"type": "OPERATION",
|
|
35286
|
+
"date": "2021-10-05",
|
|
35287
|
+
"before": { "operationId": "users/list-emails-for-authenticated" }
|
|
35288
|
+
}
|
|
35289
|
+
]
|
|
35290
|
+
}
|
|
35180
35291
|
},
|
|
35181
35292
|
"post": {
|
|
35182
35293
|
"summary": "Add an email address for the authenticated user",
|
|
35183
35294
|
"description": "This endpoint is accessible with the `user` scope.",
|
|
35184
35295
|
"tags": ["users"],
|
|
35185
|
-
"operationId": "users/add-email-for-authenticated",
|
|
35296
|
+
"operationId": "users/add-email-for-authenticated-user",
|
|
35186
35297
|
"externalDocs": {
|
|
35187
35298
|
"description": "API method documentation",
|
|
35188
35299
|
"url": "https://docs.github.com/rest/reference/users#add-an-email-address-for-the-authenticated-user"
|
|
@@ -35245,13 +35356,21 @@
|
|
|
35245
35356
|
"category": "users",
|
|
35246
35357
|
"subcategory": "emails"
|
|
35247
35358
|
},
|
|
35248
|
-
"x-octokit": {
|
|
35359
|
+
"x-octokit": {
|
|
35360
|
+
"changes": [
|
|
35361
|
+
{
|
|
35362
|
+
"type": "OPERATION",
|
|
35363
|
+
"date": "2021-10-05",
|
|
35364
|
+
"before": { "operationId": "users/add-email-for-authenticated" }
|
|
35365
|
+
}
|
|
35366
|
+
]
|
|
35367
|
+
}
|
|
35249
35368
|
},
|
|
35250
35369
|
"delete": {
|
|
35251
35370
|
"summary": "Delete an email address for the authenticated user",
|
|
35252
35371
|
"description": "This endpoint is accessible with the `user` scope.",
|
|
35253
35372
|
"tags": ["users"],
|
|
35254
|
-
"operationId": "users/delete-email-for-authenticated",
|
|
35373
|
+
"operationId": "users/delete-email-for-authenticated-user",
|
|
35255
35374
|
"externalDocs": {
|
|
35256
35375
|
"description": "API method documentation",
|
|
35257
35376
|
"url": "https://docs.github.com/rest/reference/users#delete-an-email-address-for-the-authenticated-user"
|
|
@@ -35301,7 +35420,17 @@
|
|
|
35301
35420
|
"category": "users",
|
|
35302
35421
|
"subcategory": "emails"
|
|
35303
35422
|
},
|
|
35304
|
-
"x-octokit": {
|
|
35423
|
+
"x-octokit": {
|
|
35424
|
+
"changes": [
|
|
35425
|
+
{
|
|
35426
|
+
"type": "OPERATION",
|
|
35427
|
+
"date": "2021-10-05",
|
|
35428
|
+
"before": {
|
|
35429
|
+
"operationId": "users/delete-email-for-authenticated"
|
|
35430
|
+
}
|
|
35431
|
+
}
|
|
35432
|
+
]
|
|
35433
|
+
}
|
|
35305
35434
|
}
|
|
35306
35435
|
},
|
|
35307
35436
|
"/user/followers": {
|
|
@@ -35347,53 +35476,63 @@
|
|
|
35347
35476
|
"category": "users",
|
|
35348
35477
|
"subcategory": "followers"
|
|
35349
35478
|
},
|
|
35350
|
-
"x-octokit": {}
|
|
35351
|
-
}
|
|
35352
|
-
},
|
|
35353
|
-
"/user/following": {
|
|
35354
|
-
"get": {
|
|
35355
|
-
"summary": "List the people the authenticated user follows",
|
|
35356
|
-
"description": "Lists the people who the authenticated user follows.",
|
|
35357
|
-
"tags": ["users"],
|
|
35358
|
-
"operationId": "users/list-followed-by-authenticated",
|
|
35359
|
-
"externalDocs": {
|
|
35360
|
-
"description": "API method documentation",
|
|
35361
|
-
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
|
35362
|
-
},
|
|
35363
|
-
"parameters": [
|
|
35364
|
-
{ "$ref": "#/components/parameters/per-page" },
|
|
35365
|
-
{ "$ref": "#/components/parameters/page" }
|
|
35366
|
-
],
|
|
35367
|
-
"responses": {
|
|
35368
|
-
"200": {
|
|
35369
|
-
"description": "Response",
|
|
35370
|
-
"content": {
|
|
35371
|
-
"application/json": {
|
|
35372
|
-
"schema": {
|
|
35373
|
-
"type": "array",
|
|
35374
|
-
"items": { "$ref": "#/components/schemas/simple-user" }
|
|
35375
|
-
},
|
|
35376
|
-
"examples": {
|
|
35377
|
-
"default": {
|
|
35378
|
-
"$ref": "#/components/examples/simple-user-items"
|
|
35379
|
-
}
|
|
35380
|
-
}
|
|
35479
|
+
"x-octokit": {}
|
|
35480
|
+
}
|
|
35481
|
+
},
|
|
35482
|
+
"/user/following": {
|
|
35483
|
+
"get": {
|
|
35484
|
+
"summary": "List the people the authenticated user follows",
|
|
35485
|
+
"description": "Lists the people who the authenticated user follows.",
|
|
35486
|
+
"tags": ["users"],
|
|
35487
|
+
"operationId": "users/list-followed-by-authenticated-user",
|
|
35488
|
+
"externalDocs": {
|
|
35489
|
+
"description": "API method documentation",
|
|
35490
|
+
"url": "https://docs.github.com/rest/reference/users#list-the-people-the-authenticated-user-follows"
|
|
35491
|
+
},
|
|
35492
|
+
"parameters": [
|
|
35493
|
+
{ "$ref": "#/components/parameters/per-page" },
|
|
35494
|
+
{ "$ref": "#/components/parameters/page" }
|
|
35495
|
+
],
|
|
35496
|
+
"responses": {
|
|
35497
|
+
"200": {
|
|
35498
|
+
"description": "Response",
|
|
35499
|
+
"content": {
|
|
35500
|
+
"application/json": {
|
|
35501
|
+
"schema": {
|
|
35502
|
+
"type": "array",
|
|
35503
|
+
"items": { "$ref": "#/components/schemas/simple-user" }
|
|
35504
|
+
},
|
|
35505
|
+
"examples": {
|
|
35506
|
+
"default": {
|
|
35507
|
+
"$ref": "#/components/examples/simple-user-items"
|
|
35508
|
+
}
|
|
35509
|
+
}
|
|
35510
|
+
}
|
|
35511
|
+
},
|
|
35512
|
+
"headers": { "Link": { "$ref": "#/components/headers/link" } }
|
|
35513
|
+
},
|
|
35514
|
+
"304": { "$ref": "#/components/responses/not_modified" },
|
|
35515
|
+
"401": { "$ref": "#/components/responses/requires_authentication" },
|
|
35516
|
+
"403": { "$ref": "#/components/responses/forbidden" }
|
|
35517
|
+
},
|
|
35518
|
+
"x-github": {
|
|
35519
|
+
"githubCloudOnly": false,
|
|
35520
|
+
"enabledForGitHubApps": false,
|
|
35521
|
+
"previews": [],
|
|
35522
|
+
"category": "users",
|
|
35523
|
+
"subcategory": "followers"
|
|
35524
|
+
},
|
|
35525
|
+
"x-octokit": {
|
|
35526
|
+
"changes": [
|
|
35527
|
+
{
|
|
35528
|
+
"type": "OPERATION",
|
|
35529
|
+
"date": "2021-10-05",
|
|
35530
|
+
"before": {
|
|
35531
|
+
"operationId": "users/list-followed-by-authenticated"
|
|
35381
35532
|
}
|
|
35382
|
-
}
|
|
35383
|
-
|
|
35384
|
-
|
|
35385
|
-
"304": { "$ref": "#/components/responses/not_modified" },
|
|
35386
|
-
"401": { "$ref": "#/components/responses/requires_authentication" },
|
|
35387
|
-
"403": { "$ref": "#/components/responses/forbidden" }
|
|
35388
|
-
},
|
|
35389
|
-
"x-github": {
|
|
35390
|
-
"githubCloudOnly": false,
|
|
35391
|
-
"enabledForGitHubApps": false,
|
|
35392
|
-
"previews": [],
|
|
35393
|
-
"category": "users",
|
|
35394
|
-
"subcategory": "followers"
|
|
35395
|
-
},
|
|
35396
|
-
"x-octokit": {}
|
|
35533
|
+
}
|
|
35534
|
+
]
|
|
35535
|
+
}
|
|
35397
35536
|
}
|
|
35398
35537
|
},
|
|
35399
35538
|
"/user/following/{username}": {
|
|
@@ -35490,7 +35629,7 @@
|
|
|
35490
35629
|
"summary": "List GPG keys for the authenticated user",
|
|
35491
35630
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
35492
35631
|
"tags": ["users"],
|
|
35493
|
-
"operationId": "users/list-gpg-keys-for-authenticated",
|
|
35632
|
+
"operationId": "users/list-gpg-keys-for-authenticated-user",
|
|
35494
35633
|
"externalDocs": {
|
|
35495
35634
|
"description": "API method documentation",
|
|
35496
35635
|
"url": "https://docs.github.com/rest/reference/users#list-gpg-keys-for-the-authenticated-user"
|
|
@@ -35527,12 +35666,22 @@
|
|
|
35527
35666
|
"category": "users",
|
|
35528
35667
|
"subcategory": "gpg-keys"
|
|
35529
35668
|
},
|
|
35530
|
-
"x-octokit": {
|
|
35669
|
+
"x-octokit": {
|
|
35670
|
+
"changes": [
|
|
35671
|
+
{
|
|
35672
|
+
"type": "OPERATION",
|
|
35673
|
+
"date": "2021-10-05",
|
|
35674
|
+
"before": {
|
|
35675
|
+
"operationId": "users/list-gpg-keys-for-authenticated"
|
|
35676
|
+
}
|
|
35677
|
+
}
|
|
35678
|
+
]
|
|
35679
|
+
}
|
|
35531
35680
|
},
|
|
35532
35681
|
"post": {
|
|
35533
35682
|
"summary": "Create a GPG key for the authenticated user",
|
|
35534
35683
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
35535
|
-
"operationId": "users/create-gpg-key-for-authenticated",
|
|
35684
|
+
"operationId": "users/create-gpg-key-for-authenticated-user",
|
|
35536
35685
|
"tags": ["users"],
|
|
35537
35686
|
"externalDocs": {
|
|
35538
35687
|
"description": "API method documentation",
|
|
@@ -35581,7 +35730,17 @@
|
|
|
35581
35730
|
"category": "users",
|
|
35582
35731
|
"subcategory": "gpg-keys"
|
|
35583
35732
|
},
|
|
35584
|
-
"x-octokit": {
|
|
35733
|
+
"x-octokit": {
|
|
35734
|
+
"changes": [
|
|
35735
|
+
{
|
|
35736
|
+
"type": "OPERATION",
|
|
35737
|
+
"date": "2021-10-05",
|
|
35738
|
+
"before": {
|
|
35739
|
+
"operationId": "users/create-gpg-key-for-authenticated"
|
|
35740
|
+
}
|
|
35741
|
+
}
|
|
35742
|
+
]
|
|
35743
|
+
}
|
|
35585
35744
|
}
|
|
35586
35745
|
},
|
|
35587
35746
|
"/user/gpg_keys/{gpg_key_id}": {
|
|
@@ -35589,7 +35748,7 @@
|
|
|
35589
35748
|
"summary": "Get a GPG key for the authenticated user",
|
|
35590
35749
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
35591
35750
|
"tags": ["users"],
|
|
35592
|
-
"operationId": "users/get-gpg-key-for-authenticated",
|
|
35751
|
+
"operationId": "users/get-gpg-key-for-authenticated-user",
|
|
35593
35752
|
"externalDocs": {
|
|
35594
35753
|
"description": "API method documentation",
|
|
35595
35754
|
"url": "https://docs.github.com/rest/reference/users#get-a-gpg-key-for-the-authenticated-user"
|
|
@@ -35619,13 +35778,21 @@
|
|
|
35619
35778
|
"category": "users",
|
|
35620
35779
|
"subcategory": "gpg-keys"
|
|
35621
35780
|
},
|
|
35622
|
-
"x-octokit": {
|
|
35781
|
+
"x-octokit": {
|
|
35782
|
+
"changes": [
|
|
35783
|
+
{
|
|
35784
|
+
"type": "OPERATION",
|
|
35785
|
+
"date": "2021-10-05",
|
|
35786
|
+
"before": { "operationId": "users/get-gpg-key-for-authenticated" }
|
|
35787
|
+
}
|
|
35788
|
+
]
|
|
35789
|
+
}
|
|
35623
35790
|
},
|
|
35624
35791
|
"delete": {
|
|
35625
35792
|
"summary": "Delete a GPG key for the authenticated user",
|
|
35626
35793
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
35627
35794
|
"tags": ["users"],
|
|
35628
|
-
"operationId": "users/delete-gpg-key-for-authenticated",
|
|
35795
|
+
"operationId": "users/delete-gpg-key-for-authenticated-user",
|
|
35629
35796
|
"externalDocs": {
|
|
35630
35797
|
"description": "API method documentation",
|
|
35631
35798
|
"url": "https://docs.github.com/rest/reference/users#delete-a-gpg-key-for-the-authenticated-user"
|
|
@@ -35646,7 +35813,17 @@
|
|
|
35646
35813
|
"category": "users",
|
|
35647
35814
|
"subcategory": "gpg-keys"
|
|
35648
35815
|
},
|
|
35649
|
-
"x-octokit": {
|
|
35816
|
+
"x-octokit": {
|
|
35817
|
+
"changes": [
|
|
35818
|
+
{
|
|
35819
|
+
"type": "OPERATION",
|
|
35820
|
+
"date": "2021-10-05",
|
|
35821
|
+
"before": {
|
|
35822
|
+
"operationId": "users/delete-gpg-key-for-authenticated"
|
|
35823
|
+
}
|
|
35824
|
+
}
|
|
35825
|
+
]
|
|
35826
|
+
}
|
|
35650
35827
|
}
|
|
35651
35828
|
},
|
|
35652
35829
|
"/user/installations": {
|
|
@@ -35769,7 +35946,7 @@
|
|
|
35769
35946
|
"summary": "Add a repository to an app installation",
|
|
35770
35947
|
"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/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
|
|
35771
35948
|
"tags": ["apps"],
|
|
35772
|
-
"operationId": "apps/add-repo-to-installation",
|
|
35949
|
+
"operationId": "apps/add-repo-to-installation-for-authenticated-user",
|
|
35773
35950
|
"externalDocs": {
|
|
35774
35951
|
"description": "API method documentation",
|
|
35775
35952
|
"url": "https://docs.github.com/rest/reference/apps#add-a-repository-to-an-app-installation"
|
|
@@ -35791,13 +35968,21 @@
|
|
|
35791
35968
|
"category": "apps",
|
|
35792
35969
|
"subcategory": "installations"
|
|
35793
35970
|
},
|
|
35794
|
-
"x-octokit": {
|
|
35971
|
+
"x-octokit": {
|
|
35972
|
+
"changes": [
|
|
35973
|
+
{
|
|
35974
|
+
"type": "OPERATION",
|
|
35975
|
+
"date": "2021-10-05",
|
|
35976
|
+
"before": { "operationId": "apps/add-repo-to-installation" }
|
|
35977
|
+
}
|
|
35978
|
+
]
|
|
35979
|
+
}
|
|
35795
35980
|
},
|
|
35796
35981
|
"delete": {
|
|
35797
35982
|
"summary": "Remove a repository from an app installation",
|
|
35798
35983
|
"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/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint.",
|
|
35799
35984
|
"tags": ["apps"],
|
|
35800
|
-
"operationId": "apps/remove-repo-from-installation",
|
|
35985
|
+
"operationId": "apps/remove-repo-from-installation-for-authenticated-user",
|
|
35801
35986
|
"externalDocs": {
|
|
35802
35987
|
"description": "API method documentation",
|
|
35803
35988
|
"url": "https://docs.github.com/rest/reference/apps#remove-a-repository-from-an-app-installation"
|
|
@@ -35819,7 +36004,15 @@
|
|
|
35819
36004
|
"category": "apps",
|
|
35820
36005
|
"subcategory": "installations"
|
|
35821
36006
|
},
|
|
35822
|
-
"x-octokit": {
|
|
36007
|
+
"x-octokit": {
|
|
36008
|
+
"changes": [
|
|
36009
|
+
{
|
|
36010
|
+
"type": "OPERATION",
|
|
36011
|
+
"date": "2021-10-05",
|
|
36012
|
+
"before": { "operationId": "apps/remove-repo-from-installation" }
|
|
36013
|
+
}
|
|
36014
|
+
]
|
|
36015
|
+
}
|
|
35823
36016
|
}
|
|
35824
36017
|
},
|
|
35825
36018
|
"/user/interaction-limits": {
|
|
@@ -36054,7 +36247,7 @@
|
|
|
36054
36247
|
"summary": "List public SSH keys for the authenticated user",
|
|
36055
36248
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
36056
36249
|
"tags": ["users"],
|
|
36057
|
-
"operationId": "users/list-public-ssh-keys-for-authenticated",
|
|
36250
|
+
"operationId": "users/list-public-ssh-keys-for-authenticated-user",
|
|
36058
36251
|
"externalDocs": {
|
|
36059
36252
|
"description": "API method documentation",
|
|
36060
36253
|
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-keys-for-the-authenticated-user"
|
|
@@ -36091,12 +36284,22 @@
|
|
|
36091
36284
|
"category": "users",
|
|
36092
36285
|
"subcategory": "keys"
|
|
36093
36286
|
},
|
|
36094
|
-
"x-octokit": {
|
|
36287
|
+
"x-octokit": {
|
|
36288
|
+
"changes": [
|
|
36289
|
+
{
|
|
36290
|
+
"type": "OPERATION",
|
|
36291
|
+
"date": "2021-10-05",
|
|
36292
|
+
"before": {
|
|
36293
|
+
"operationId": "users/list-public-ssh-keys-for-authenticated"
|
|
36294
|
+
}
|
|
36295
|
+
}
|
|
36296
|
+
]
|
|
36297
|
+
}
|
|
36095
36298
|
},
|
|
36096
36299
|
"post": {
|
|
36097
36300
|
"summary": "Create a public SSH key for the authenticated user",
|
|
36098
36301
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
36099
|
-
"operationId": "users/create-public-ssh-key-for-authenticated",
|
|
36302
|
+
"operationId": "users/create-public-ssh-key-for-authenticated-user",
|
|
36100
36303
|
"tags": ["users"],
|
|
36101
36304
|
"externalDocs": {
|
|
36102
36305
|
"description": "API method documentation",
|
|
@@ -36151,7 +36354,17 @@
|
|
|
36151
36354
|
"category": "users",
|
|
36152
36355
|
"subcategory": "keys"
|
|
36153
36356
|
},
|
|
36154
|
-
"x-octokit": {
|
|
36357
|
+
"x-octokit": {
|
|
36358
|
+
"changes": [
|
|
36359
|
+
{
|
|
36360
|
+
"type": "OPERATION",
|
|
36361
|
+
"date": "2021-10-05",
|
|
36362
|
+
"before": {
|
|
36363
|
+
"operationId": "users/create-public-ssh-key-for-authenticated"
|
|
36364
|
+
}
|
|
36365
|
+
}
|
|
36366
|
+
]
|
|
36367
|
+
}
|
|
36155
36368
|
}
|
|
36156
36369
|
},
|
|
36157
36370
|
"/user/keys/{key_id}": {
|
|
@@ -36159,7 +36372,7 @@
|
|
|
36159
36372
|
"summary": "Get a public SSH key for the authenticated user",
|
|
36160
36373
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
36161
36374
|
"tags": ["users"],
|
|
36162
|
-
"operationId": "users/get-public-ssh-key-for-authenticated",
|
|
36375
|
+
"operationId": "users/get-public-ssh-key-for-authenticated-user",
|
|
36163
36376
|
"externalDocs": {
|
|
36164
36377
|
"description": "API method documentation",
|
|
36165
36378
|
"url": "https://docs.github.com/rest/reference/users#get-a-public-ssh-key-for-the-authenticated-user"
|
|
@@ -36189,13 +36402,23 @@
|
|
|
36189
36402
|
"category": "users",
|
|
36190
36403
|
"subcategory": "keys"
|
|
36191
36404
|
},
|
|
36192
|
-
"x-octokit": {
|
|
36405
|
+
"x-octokit": {
|
|
36406
|
+
"changes": [
|
|
36407
|
+
{
|
|
36408
|
+
"type": "OPERATION",
|
|
36409
|
+
"date": "2021-10-05",
|
|
36410
|
+
"before": {
|
|
36411
|
+
"operationId": "users/get-public-ssh-key-for-authenticated"
|
|
36412
|
+
}
|
|
36413
|
+
}
|
|
36414
|
+
]
|
|
36415
|
+
}
|
|
36193
36416
|
},
|
|
36194
36417
|
"delete": {
|
|
36195
36418
|
"summary": "Delete a public SSH key for the authenticated user",
|
|
36196
36419
|
"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/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
|
|
36197
36420
|
"tags": ["users"],
|
|
36198
|
-
"operationId": "users/delete-public-ssh-key-for-authenticated",
|
|
36421
|
+
"operationId": "users/delete-public-ssh-key-for-authenticated-user",
|
|
36199
36422
|
"externalDocs": {
|
|
36200
36423
|
"description": "API method documentation",
|
|
36201
36424
|
"url": "https://docs.github.com/rest/reference/users#delete-a-public-ssh-key-for-the-authenticated-user"
|
|
@@ -36215,7 +36438,17 @@
|
|
|
36215
36438
|
"category": "users",
|
|
36216
36439
|
"subcategory": "keys"
|
|
36217
36440
|
},
|
|
36218
|
-
"x-octokit": {
|
|
36441
|
+
"x-octokit": {
|
|
36442
|
+
"changes": [
|
|
36443
|
+
{
|
|
36444
|
+
"type": "OPERATION",
|
|
36445
|
+
"date": "2021-10-05",
|
|
36446
|
+
"before": {
|
|
36447
|
+
"operationId": "users/delete-public-ssh-key-for-authenticated"
|
|
36448
|
+
}
|
|
36449
|
+
}
|
|
36450
|
+
]
|
|
36451
|
+
}
|
|
36219
36452
|
}
|
|
36220
36453
|
},
|
|
36221
36454
|
"/user/marketplace_purchases": {
|
|
@@ -36726,7 +36959,7 @@
|
|
|
36726
36959
|
"summary": "List repositories for a user migration",
|
|
36727
36960
|
"description": "Lists all the repositories for this user migration.",
|
|
36728
36961
|
"tags": ["migrations"],
|
|
36729
|
-
"operationId": "migrations/list-repos-for-user",
|
|
36962
|
+
"operationId": "migrations/list-repos-for-authenticated-user",
|
|
36730
36963
|
"externalDocs": {
|
|
36731
36964
|
"description": "API method documentation",
|
|
36732
36965
|
"url": "https://docs.github.com/rest/reference/migrations#list-repositories-for-a-user-migration"
|
|
@@ -36762,7 +36995,15 @@
|
|
|
36762
36995
|
"category": "migrations",
|
|
36763
36996
|
"subcategory": "users"
|
|
36764
36997
|
},
|
|
36765
|
-
"x-octokit": {
|
|
36998
|
+
"x-octokit": {
|
|
36999
|
+
"changes": [
|
|
37000
|
+
{
|
|
37001
|
+
"type": "OPERATION",
|
|
37002
|
+
"date": "2021-10-05",
|
|
37003
|
+
"before": { "operationId": "migrations/list-repos-for-user" }
|
|
37004
|
+
}
|
|
37005
|
+
]
|
|
37006
|
+
}
|
|
36766
37007
|
}
|
|
36767
37008
|
},
|
|
36768
37009
|
"/user/orgs": {
|
|
@@ -37208,7 +37449,7 @@
|
|
|
37208
37449
|
"summary": "List public email addresses for the authenticated user",
|
|
37209
37450
|
"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/rest/reference/users#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope.",
|
|
37210
37451
|
"tags": ["users"],
|
|
37211
|
-
"operationId": "users/list-public-emails-for-authenticated",
|
|
37452
|
+
"operationId": "users/list-public-emails-for-authenticated-user",
|
|
37212
37453
|
"externalDocs": {
|
|
37213
37454
|
"description": "API method documentation",
|
|
37214
37455
|
"url": "https://docs.github.com/rest/reference/users#list-public-email-addresses-for-the-authenticated-user"
|
|
@@ -37245,7 +37486,17 @@
|
|
|
37245
37486
|
"category": "users",
|
|
37246
37487
|
"subcategory": "emails"
|
|
37247
37488
|
},
|
|
37248
|
-
"x-octokit": {
|
|
37489
|
+
"x-octokit": {
|
|
37490
|
+
"changes": [
|
|
37491
|
+
{
|
|
37492
|
+
"type": "OPERATION",
|
|
37493
|
+
"date": "2021-10-05",
|
|
37494
|
+
"before": {
|
|
37495
|
+
"operationId": "users/list-public-emails-for-authenticated"
|
|
37496
|
+
}
|
|
37497
|
+
}
|
|
37498
|
+
]
|
|
37499
|
+
}
|
|
37249
37500
|
}
|
|
37250
37501
|
},
|
|
37251
37502
|
"/user/repos": {
|
|
@@ -37493,18 +37744,6 @@
|
|
|
37493
37744
|
"x-github": {
|
|
37494
37745
|
"githubCloudOnly": false,
|
|
37495
37746
|
"enabledForGitHubApps": false,
|
|
37496
|
-
"previews": [
|
|
37497
|
-
{
|
|
37498
|
-
"required": false,
|
|
37499
|
-
"name": "nebula",
|
|
37500
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
37501
|
-
},
|
|
37502
|
-
{
|
|
37503
|
-
"required": false,
|
|
37504
|
-
"name": "baptiste",
|
|
37505
|
-
"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/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/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
|
|
37506
|
-
}
|
|
37507
|
-
],
|
|
37508
37747
|
"category": "repos",
|
|
37509
37748
|
"subcategory": null
|
|
37510
37749
|
},
|
|
@@ -37565,7 +37804,7 @@
|
|
|
37565
37804
|
"summary": "Accept a repository invitation",
|
|
37566
37805
|
"description": "",
|
|
37567
37806
|
"tags": ["repos"],
|
|
37568
|
-
"operationId": "repos/accept-invitation",
|
|
37807
|
+
"operationId": "repos/accept-invitation-for-authenticated-user",
|
|
37569
37808
|
"externalDocs": {
|
|
37570
37809
|
"description": "API method documentation",
|
|
37571
37810
|
"url": "https://docs.github.com/rest/reference/repos#accept-a-repository-invitation"
|
|
@@ -37585,13 +37824,21 @@
|
|
|
37585
37824
|
"category": "repos",
|
|
37586
37825
|
"subcategory": "invitations"
|
|
37587
37826
|
},
|
|
37588
|
-
"x-octokit": {
|
|
37827
|
+
"x-octokit": {
|
|
37828
|
+
"changes": [
|
|
37829
|
+
{
|
|
37830
|
+
"type": "OPERATION",
|
|
37831
|
+
"date": "2021-10-05",
|
|
37832
|
+
"before": { "operationId": "repos/accept-invitation" }
|
|
37833
|
+
}
|
|
37834
|
+
]
|
|
37835
|
+
}
|
|
37589
37836
|
},
|
|
37590
37837
|
"delete": {
|
|
37591
37838
|
"summary": "Decline a repository invitation",
|
|
37592
37839
|
"description": "",
|
|
37593
37840
|
"tags": ["repos"],
|
|
37594
|
-
"operationId": "repos/decline-invitation",
|
|
37841
|
+
"operationId": "repos/decline-invitation-for-authenticated-user",
|
|
37595
37842
|
"externalDocs": {
|
|
37596
37843
|
"description": "API method documentation",
|
|
37597
37844
|
"url": "https://docs.github.com/rest/reference/repos#decline-a-repository-invitation"
|
|
@@ -37611,7 +37858,15 @@
|
|
|
37611
37858
|
"category": "repos",
|
|
37612
37859
|
"subcategory": "invitations"
|
|
37613
37860
|
},
|
|
37614
|
-
"x-octokit": {
|
|
37861
|
+
"x-octokit": {
|
|
37862
|
+
"changes": [
|
|
37863
|
+
{
|
|
37864
|
+
"type": "OPERATION",
|
|
37865
|
+
"date": "2021-10-05",
|
|
37866
|
+
"before": { "operationId": "repos/decline-invitation" }
|
|
37867
|
+
}
|
|
37868
|
+
]
|
|
37869
|
+
}
|
|
37615
37870
|
}
|
|
37616
37871
|
},
|
|
37617
37872
|
"/user/starred": {
|
|
@@ -38969,13 +39224,6 @@
|
|
|
38969
39224
|
"x-github": {
|
|
38970
39225
|
"githubCloudOnly": false,
|
|
38971
39226
|
"enabledForGitHubApps": true,
|
|
38972
|
-
"previews": [
|
|
38973
|
-
{
|
|
38974
|
-
"required": false,
|
|
38975
|
-
"name": "nebula",
|
|
38976
|
-
"note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/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/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```"
|
|
38977
|
-
}
|
|
38978
|
-
],
|
|
38979
39227
|
"category": "repos",
|
|
38980
39228
|
"subcategory": null
|
|
38981
39229
|
},
|
|
@@ -46568,6 +46816,11 @@
|
|
|
46568
46816
|
"type": "string",
|
|
46569
46817
|
"example": "https://api.github.com/repos/github/hello-world/actions/runs/5"
|
|
46570
46818
|
},
|
|
46819
|
+
"run_attempt": {
|
|
46820
|
+
"type": "integer",
|
|
46821
|
+
"description": "Attempt number of the associated workflow run, 1 for first attempt and higher if the workflow was re-run.",
|
|
46822
|
+
"example": 1
|
|
46823
|
+
},
|
|
46571
46824
|
"node_id": { "type": "string", "example": "MDg6Q2hlY2tSdW40" },
|
|
46572
46825
|
"head_sha": {
|
|
46573
46826
|
"description": "The SHA of the commit that is being run.",
|
|
@@ -46658,6 +46911,36 @@
|
|
|
46658
46911
|
"check_run_url": {
|
|
46659
46912
|
"type": "string",
|
|
46660
46913
|
"example": "https://api.github.com/repos/github/hello-world/check-runs/4"
|
|
46914
|
+
},
|
|
46915
|
+
"labels": {
|
|
46916
|
+
"type": "array",
|
|
46917
|
+
"items": { "type": "string" },
|
|
46918
|
+
"description": "Labels for the workflow job. Specified by the \"runs_on\" attribute in the action's workflow file.",
|
|
46919
|
+
"example": ["self-hosted", "foo", "bar"]
|
|
46920
|
+
},
|
|
46921
|
+
"runner_id": {
|
|
46922
|
+
"type": "integer",
|
|
46923
|
+
"nullable": true,
|
|
46924
|
+
"example": 1,
|
|
46925
|
+
"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.)"
|
|
46926
|
+
},
|
|
46927
|
+
"runner_name": {
|
|
46928
|
+
"type": "string",
|
|
46929
|
+
"nullable": true,
|
|
46930
|
+
"example": "my runner",
|
|
46931
|
+
"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.)"
|
|
46932
|
+
},
|
|
46933
|
+
"runner_group_id": {
|
|
46934
|
+
"type": "integer",
|
|
46935
|
+
"nullable": true,
|
|
46936
|
+
"example": 2,
|
|
46937
|
+
"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.)"
|
|
46938
|
+
},
|
|
46939
|
+
"runner_group_name": {
|
|
46940
|
+
"type": "string",
|
|
46941
|
+
"nullable": true,
|
|
46942
|
+
"example": "my runner group",
|
|
46943
|
+
"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.)"
|
|
46661
46944
|
}
|
|
46662
46945
|
},
|
|
46663
46946
|
"required": [
|
|
@@ -46673,7 +46956,12 @@
|
|
|
46673
46956
|
"conclusion",
|
|
46674
46957
|
"started_at",
|
|
46675
46958
|
"completed_at",
|
|
46676
|
-
"check_run_url"
|
|
46959
|
+
"check_run_url",
|
|
46960
|
+
"labels",
|
|
46961
|
+
"runner_id",
|
|
46962
|
+
"runner_name",
|
|
46963
|
+
"runner_group_id",
|
|
46964
|
+
"runner_group_name"
|
|
46677
46965
|
]
|
|
46678
46966
|
},
|
|
46679
46967
|
"actions-enabled": {
|
|
@@ -46817,7 +47105,7 @@
|
|
|
46817
47105
|
},
|
|
46818
47106
|
"run_attempt": {
|
|
46819
47107
|
"type": "integer",
|
|
46820
|
-
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was
|
|
47108
|
+
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was re-run.",
|
|
46821
47109
|
"example": 1
|
|
46822
47110
|
},
|
|
46823
47111
|
"event": { "type": "string", "example": "push" },
|
|
@@ -46852,6 +47140,11 @@
|
|
|
46852
47140
|
},
|
|
46853
47141
|
"created_at": { "type": "string", "format": "date-time" },
|
|
46854
47142
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
47143
|
+
"run_started_at": {
|
|
47144
|
+
"type": "string",
|
|
47145
|
+
"format": "date-time",
|
|
47146
|
+
"description": "The start time of the latest run. Resets on re-run."
|
|
47147
|
+
},
|
|
46855
47148
|
"jobs_url": {
|
|
46856
47149
|
"description": "The URL to the jobs for the workflow run.",
|
|
46857
47150
|
"type": "string",
|
|
@@ -48596,7 +48889,6 @@
|
|
|
48596
48889
|
"created_at": { "$ref": "#/components/schemas/alert-created-at" },
|
|
48597
48890
|
"url": { "$ref": "#/components/schemas/alert-url" },
|
|
48598
48891
|
"html_url": { "$ref": "#/components/schemas/alert-html-url" },
|
|
48599
|
-
"instances": { "deprecated": true },
|
|
48600
48892
|
"instances_url": {
|
|
48601
48893
|
"$ref": "#/components/schemas/alert-instances-url"
|
|
48602
48894
|
},
|
|
@@ -48713,8 +49005,7 @@
|
|
|
48713
49005
|
"type": "string",
|
|
48714
49006
|
"description": "Warning generated when processing the analysis",
|
|
48715
49007
|
"example": "123 results were ignored"
|
|
48716
|
-
}
|
|
48717
|
-
"tool_name": { "type": "string" }
|
|
49008
|
+
}
|
|
48718
49009
|
},
|
|
48719
49010
|
"required": [
|
|
48720
49011
|
"ref",
|
|
@@ -52853,6 +53144,10 @@
|
|
|
52853
53144
|
"master_branch": { "type": "string" },
|
|
52854
53145
|
"archived": { "type": "boolean" },
|
|
52855
53146
|
"disabled": { "type": "boolean" },
|
|
53147
|
+
"visibility": {
|
|
53148
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
53149
|
+
"type": "string"
|
|
53150
|
+
},
|
|
52856
53151
|
"mirror_url": {
|
|
52857
53152
|
"type": "string",
|
|
52858
53153
|
"format": "uri",
|
|
@@ -52901,7 +53196,8 @@
|
|
|
52901
53196
|
"watchers_count": { "type": "integer" },
|
|
52902
53197
|
"created_at": { "type": "string", "format": "date-time" },
|
|
52903
53198
|
"updated_at": { "type": "string", "format": "date-time" },
|
|
52904
|
-
"allow_forking": { "type": "boolean" }
|
|
53199
|
+
"allow_forking": { "type": "boolean" },
|
|
53200
|
+
"is_template": { "type": "boolean" }
|
|
52905
53201
|
},
|
|
52906
53202
|
"required": [
|
|
52907
53203
|
"archive_url",
|
|
@@ -53057,6 +53353,7 @@
|
|
|
53057
53353
|
"hooks_url": { "type": "string", "format": "uri" },
|
|
53058
53354
|
"html_url": { "type": "string", "format": "uri" },
|
|
53059
53355
|
"id": { "type": "integer" },
|
|
53356
|
+
"is_template": { "type": "boolean" },
|
|
53060
53357
|
"node_id": { "type": "string" },
|
|
53061
53358
|
"issue_comment_url": { "type": "string" },
|
|
53062
53359
|
"issue_events_url": { "type": "string" },
|
|
@@ -53150,6 +53447,10 @@
|
|
|
53150
53447
|
"master_branch": { "type": "string" },
|
|
53151
53448
|
"archived": { "type": "boolean" },
|
|
53152
53449
|
"disabled": { "type": "boolean" },
|
|
53450
|
+
"visibility": {
|
|
53451
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
53452
|
+
"type": "string"
|
|
53453
|
+
},
|
|
53153
53454
|
"mirror_url": {
|
|
53154
53455
|
"type": "string",
|
|
53155
53456
|
"format": "uri",
|
|
@@ -53764,6 +54065,23 @@
|
|
|
53764
54065
|
"url"
|
|
53765
54066
|
]
|
|
53766
54067
|
},
|
|
54068
|
+
"release-notes-content": {
|
|
54069
|
+
"title": "Generated Release Notes Content",
|
|
54070
|
+
"description": "Generated name and body describing a release",
|
|
54071
|
+
"type": "object",
|
|
54072
|
+
"properties": {
|
|
54073
|
+
"name": {
|
|
54074
|
+
"description": "The generated name of the release",
|
|
54075
|
+
"type": "string",
|
|
54076
|
+
"example": "Release v1.0.0 is now available!"
|
|
54077
|
+
},
|
|
54078
|
+
"body": {
|
|
54079
|
+
"description": "The generated body describing the contents of the release supporting markdown formatting",
|
|
54080
|
+
"type": "string"
|
|
54081
|
+
}
|
|
54082
|
+
},
|
|
54083
|
+
"required": ["name", "body"]
|
|
54084
|
+
},
|
|
53767
54085
|
"secret-scanning-alert": {
|
|
53768
54086
|
"type": "object",
|
|
53769
54087
|
"properties": {
|
|
@@ -54730,6 +55048,10 @@
|
|
|
54730
55048
|
"type": "boolean",
|
|
54731
55049
|
"description": "Returns whether or not this repository disabled."
|
|
54732
55050
|
},
|
|
55051
|
+
"visibility": {
|
|
55052
|
+
"description": "The repository visibility: public, private, or internal.",
|
|
55053
|
+
"type": "string"
|
|
55054
|
+
},
|
|
54733
55055
|
"license": { "$ref": "#/components/schemas/nullable-license-simple" },
|
|
54734
55056
|
"permissions": {
|
|
54735
55057
|
"type": "object",
|
|
@@ -54751,7 +55073,8 @@
|
|
|
54751
55073
|
"allow_rebase_merge": { "type": "boolean" },
|
|
54752
55074
|
"allow_auto_merge": { "type": "boolean" },
|
|
54753
55075
|
"delete_branch_on_merge": { "type": "boolean" },
|
|
54754
|
-
"allow_forking": { "type": "boolean" }
|
|
55076
|
+
"allow_forking": { "type": "boolean" },
|
|
55077
|
+
"is_template": { "type": "boolean" }
|
|
54755
55078
|
},
|
|
54756
55079
|
"required": [
|
|
54757
55080
|
"archive_url",
|
|
@@ -61937,7 +62260,12 @@
|
|
|
61937
62260
|
"completed_at": "2020-01-20T09:44:39.000-08:00"
|
|
61938
62261
|
}
|
|
61939
62262
|
],
|
|
61940
|
-
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496"
|
|
62263
|
+
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
|
|
62264
|
+
"labels": ["self-hosted", "foo", "bar"],
|
|
62265
|
+
"runner_id": 1,
|
|
62266
|
+
"runner_name": "my runner",
|
|
62267
|
+
"runner_group_id": 2,
|
|
62268
|
+
"runner_group_name": "my runner group"
|
|
61941
62269
|
}
|
|
61942
62270
|
},
|
|
61943
62271
|
"actions-repository-permissions": {
|
|
@@ -62432,7 +62760,12 @@
|
|
|
62432
62760
|
"completed_at": "2020-01-20T09:44:39.000-08:00"
|
|
62433
62761
|
}
|
|
62434
62762
|
],
|
|
62435
|
-
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496"
|
|
62763
|
+
"check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496",
|
|
62764
|
+
"labels": ["self-hosted", "foo", "bar"],
|
|
62765
|
+
"runner_id": 1,
|
|
62766
|
+
"runner_name": "my runner",
|
|
62767
|
+
"runner_group_id": 2,
|
|
62768
|
+
"runner_group_name": "my runner group"
|
|
62436
62769
|
}
|
|
62437
62770
|
]
|
|
62438
62771
|
}
|
|
@@ -64049,8 +64382,7 @@
|
|
|
64049
64382
|
},
|
|
64050
64383
|
"classifications": ["test"]
|
|
64051
64384
|
},
|
|
64052
|
-
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
64053
|
-
"instances": null
|
|
64385
|
+
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances"
|
|
64054
64386
|
}
|
|
64055
64387
|
},
|
|
64056
64388
|
"code-scanning-alert-dismissed": {
|
|
@@ -70205,6 +70537,12 @@
|
|
|
70205
70537
|
}
|
|
70206
70538
|
}
|
|
70207
70539
|
},
|
|
70540
|
+
"release-notes-content": {
|
|
70541
|
+
"value": {
|
|
70542
|
+
"name": "Release v1.0.0 is now available!",
|
|
70543
|
+
"body": "##Changes in Release v1.0.0 ... ##Contributors @monalisa"
|
|
70544
|
+
}
|
|
70545
|
+
},
|
|
70208
70546
|
"release-asset-items": {
|
|
70209
70547
|
"value": [
|
|
70210
70548
|
{
|
|
@@ -71875,6 +72213,7 @@
|
|
|
71875
72213
|
"has_downloads": true,
|
|
71876
72214
|
"archived": true,
|
|
71877
72215
|
"disabled": true,
|
|
72216
|
+
"visibility": "private",
|
|
71878
72217
|
"license": {
|
|
71879
72218
|
"key": "mit",
|
|
71880
72219
|
"name": "MIT License",
|
|
@@ -74658,6 +74997,13 @@
|
|
|
74658
74997
|
"required": false,
|
|
74659
74998
|
"schema": { "type": "string", "format": "date-time" }
|
|
74660
74999
|
},
|
|
75000
|
+
"exclude-pull-requests": {
|
|
75001
|
+
"name": "exclude_pull_requests",
|
|
75002
|
+
"description": "If `true` pull requests are omitted from the response (empty array).",
|
|
75003
|
+
"in": "query",
|
|
75004
|
+
"required": false,
|
|
75005
|
+
"schema": { "type": "boolean", "default": false }
|
|
75006
|
+
},
|
|
74661
75007
|
"run-id": {
|
|
74662
75008
|
"name": "run_id",
|
|
74663
75009
|
"description": "The id of the workflow run.",
|
|
@@ -74665,6 +75011,13 @@
|
|
|
74665
75011
|
"required": true,
|
|
74666
75012
|
"schema": { "type": "integer" }
|
|
74667
75013
|
},
|
|
75014
|
+
"attempt-number": {
|
|
75015
|
+
"name": "attempt_number",
|
|
75016
|
+
"description": "The attempt number of the workflow run.",
|
|
75017
|
+
"in": "path",
|
|
75018
|
+
"required": true,
|
|
75019
|
+
"schema": { "type": "integer" }
|
|
75020
|
+
},
|
|
74668
75021
|
"workflow-id": {
|
|
74669
75022
|
"name": "workflow_id",
|
|
74670
75023
|
"in": "path",
|