From ab205d9b47952735280e6dc68837b7a9bd644984 Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 18 Oct 2024 17:24:27 -0400 Subject: [PATCH 1/4] Update OpenAPI Description (#52777) --- .../rest/actions/self-hosted-runner-groups.md | 1 + .../fine-grained-pat-permissions.json | 135 + .../data/fpt-2022-11-28/fine-grained-pat.json | 78 + .../server-to-server-permissions.json | 165 + .../fpt-2022-11-28/server-to-server-rest.json | 78 + .../fpt-2022-11-28/user-to-server-rest.json | 78 + src/github-apps/lib/config.json | 2 +- src/rest/data/fpt-2022-11-28/schema.json | 4310 +++++++++++++++-- src/rest/data/ghec-2022-11-28/schema.json | 958 +++- .../data/ghes-3.11-2022-11-28/schema.json | 40 +- .../data/ghes-3.12-2022-11-28/schema.json | 40 +- .../data/ghes-3.13-2022-11-28/schema.json | 40 +- .../data/ghes-3.14-2022-11-28/schema.json | 40 +- src/rest/lib/config.json | 2 +- src/webhooks/data/fpt/schema.json | 86 +- src/webhooks/data/ghec/schema.json | 86 +- src/webhooks/data/ghes-3.11/schema.json | 6 +- src/webhooks/data/ghes-3.12/schema.json | 6 +- src/webhooks/data/ghes-3.13/schema.json | 6 +- src/webhooks/data/ghes-3.14/schema.json | 6 +- src/webhooks/lib/config.json | 2 +- 21 files changed, 5757 insertions(+), 408 deletions(-) diff --git a/content/rest/actions/self-hosted-runner-groups.md b/content/rest/actions/self-hosted-runner-groups.md index 83f49797b05f..111887f94d8c 100644 --- a/content/rest/actions/self-hosted-runner-groups.md +++ b/content/rest/actions/self-hosted-runner-groups.md @@ -8,6 +8,7 @@ intro: >- topics: - API versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' ghec: '*' ghes: '*' autogenerated: rest diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index 469ef7b6043e..1afc805e1099 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -1641,6 +1641,123 @@ "title": "Self-hosted runners", "displayTitle": "Organization permissions for \"Self-hosted runners\"", "permissions": [ + { + "category": "actions", + "slug": "list-self-hosted-runner-groups-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups", + "additional-permissions": false, + "access": "read" + }, + { + "category": "actions", + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups", + "additional-permissions": false, + "access": "write" + }, + { + "category": "actions", + "slug": "get-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "actions", + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "actions", + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "actions", + "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "additional-permissions": false, + "access": "read" + }, + { + "category": "actions", + "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "additional-permissions": false, + "access": "write" + }, + { + "category": "actions", + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "actions", + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "additional-permissions": true, + "access": "write" + }, + { + "category": "actions", + "slug": "list-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "additional-permissions": false, + "access": "read" + }, + { + "category": "actions", + "slug": "set-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "additional-permissions": false, + "access": "write" + }, + { + "category": "actions", + "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "actions", + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "additional-permissions": false, + "access": "write" + }, { "category": "actions", "slug": "list-self-hosted-runners-for-an-organization", @@ -5349,6 +5466,24 @@ "additional-permissions": true, "access": "read" }, + { + "category": "actions", + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "additional-permissions": true, + "access": "read" + }, + { + "category": "actions", + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "additional-permissions": true, + "access": "read" + }, { "category": "actions", "slug": "add-selected-repository-to-an-organization-secret", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index 506ae040ce1a..5062b2b05e6c 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -84,6 +84,84 @@ "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/workflow" }, + { + "slug": "list-self-hosted-runner-groups-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups" + }, + { + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups" + }, + { + "slug": "get-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" + }, + { + "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" + }, + { + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" + }, + { + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" + }, + { + "slug": "list-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" + }, + { + "slug": "set-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" + }, + { + "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" + }, + { + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" + }, { "slug": "list-self-hosted-runners-for-an-organization", "subcategory": "self-hosted-runners", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 2f61a7cddf69..8ca9de217ea7 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -2024,6 +2024,149 @@ "title": "Self-hosted runners", "displayTitle": "Organization permissions for \"Self-hosted runners\"", "permissions": [ + { + "category": "actions", + "slug": "list-self-hosted-runner-groups-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "get-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "actions", + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "actions", + "slug": "list-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "set-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "actions", + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, { "category": "actions", "slug": "list-self-hosted-runners-for-an-organization", @@ -6539,6 +6682,28 @@ "server-to-server": true, "additional-permissions": true }, + { + "category": "actions", + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, + { + "category": "actions", + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": true + }, { "category": "actions", "slug": "add-selected-repository-to-an-organization-secret", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 6aa6d64ca77a..fe1be3eadf86 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -84,6 +84,84 @@ "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/workflow" }, + { + "slug": "list-self-hosted-runner-groups-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups" + }, + { + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups" + }, + { + "slug": "get-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" + }, + { + "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" + }, + { + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" + }, + { + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" + }, + { + "slug": "list-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" + }, + { + "slug": "set-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" + }, + { + "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" + }, + { + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" + }, { "slug": "list-self-hosted-runners-for-an-organization", "subcategory": "self-hosted-runners", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index 506ae040ce1a..5062b2b05e6c 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -84,6 +84,84 @@ "verb": "put", "requestPath": "/orgs/{org}/actions/permissions/workflow" }, + { + "slug": "list-self-hosted-runner-groups-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups" + }, + { + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups" + }, + { + "slug": "get-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}" + }, + { + "slug": "list-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" + }, + { + "slug": "set-repository-access-for-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories" + }, + { + "slug": "add-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" + }, + { + "slug": "remove-repository-access-to-a-self-hosted-runner-group-in-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}" + }, + { + "slug": "list-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" + }, + { + "slug": "set-self-hosted-runners-in-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners" + }, + { + "slug": "add-a-self-hosted-runner-to-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" + }, + { + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-organization", + "subcategory": "self-hosted-runner-groups", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}" + }, { "slug": "list-self-hosted-runners-for-an-organization", "subcategory": "self-hosted-runners", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index ef4afe29613d..7edb9907f8c4 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "5b32856c2a9e0b8bf9ec957b5a7d46afa6e6d8f4" + "sha": "e165265240d01bb9ca924b4ace9893455200257e" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index c48425ad0c6a..bf0446e8fe55 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -6153,6 +6153,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -7223,8 +7235,2842 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "read", - "\"Environments\" repository permissions": "read" + "\"Secrets\" repository permissions": "read", + "\"Environments\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "
Response
", + "example": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key", + "title": "Get an environment public key", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
Response
", + "example": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "1234567" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + ] + }, + "id": { + "type": "integer", + "examples": [ + 2 + ] + }, + "url": { + "type": "string", + "examples": [ + "https://api.github.com/user/keys/2" + ] + }, + "title": { + "type": "string", + "examples": [ + "ssh-rsa AAAAB3NzaC1yc2EAAA" + ] + }, + "created_at": { + "type": "string", + "examples": [ + "2011-01-26T19:01:12Z" + ] + } + }, + "required": [ + "key_id", + "key" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", + "title": "Get an environment secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" repository permissions": "read", + "\"Environments\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "type": "string", + "examples": [ + "SECRET_TOKEN" + ] + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", + "title": "Create or update an environment secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "ID of the key you used to encrypt the secret.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" repository permissions": "write", + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example 1: Status Code 201", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response when creating a secret
", + "example": null, + "schema": { + "title": "Empty Object", + "description": "An object without any properties.", + "type": "object", + "properties": {}, + "additionalProperties": false + } + } + }, + { + "key": "204", + "request": { + "contentType": "application/json", + "description": "Example 2: Status Code 204", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response when updating a secret
" + } + } + ], + "previews": [], + "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Response when creating a secret
" + }, + { + "httpStatusCode": "204", + "description": "Response when updating a secret
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", + "title": "Delete an environment secret", + "category": "actions", + "subcategory": "secrets", + "parameters": [ + { + "name": "owner", + "description": "The account owner of the repository. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Secrets\" repository permissions": "write", + "\"Environments\" repository permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "owner": "OWNER", + "repo": "REPO", + "environment_name": "ENVIRONMENT_NAME", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Default response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes a secret in an environment using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Default response
" + } + ] + } + ], + "self-hosted-runner-groups": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups", + "title": "List self-hosted runner groups for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "visible_to_repository", + "description": "Only return runner groups that are allowed to be used by this repository.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/1/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [], + "workflow_restrictions_read_only": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": true, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/3/runners", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": false, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "runner_groups" + ], + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists all self-hosted runner groups configured in an organization and inherited from an enterprise.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups", + "title": "Create a self-hosted runner group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "Name of the runner group.
", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories.
", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "List of repository IDs that can access the runner group.
" + }, + { + "type": "array of integers", + "name": "runners", + "in": "body", + "description": "List of runner IDs to add to the runner group.
" + }, + { + "type": "boolean", + "name": "allows_public_repositories", + "in": "body", + "description": "Whether the runner group can be used by public repositories.
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Response
", + "example": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Creates a new self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Created
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "title": "Get a self-hosted runner group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Gets a specific self-hosted runner group for an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "title": "Update a self-hosted runner group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "Name of the runner group.
", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.
", + "enum": [ + "selected", + "all", + "private" + ] + }, + { + "type": "boolean", + "name": "allows_public_repositories", + "in": "body", + "description": "Whether the runner group can be used by public repositories.
If true, the runner group will be restricted to running only the workflows specified in the selected_workflows array.
List of workflows the runner group should be allowed to run. This setting will be ignored unless restricted_to_workflows is set to true.
Response
", + "example": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "hosted_runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/hosted-runners", + "network_configuration_id": "EC486D5D793175D7E3B29C27318D5C1AAE49A7833FC85F2E82C3D2C54AC7D3BA", + "inherited": false, + "allows_public_repositories": true, + "restricted_to_workflows": true, + "selected_workflows": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main" + ], + "workflow_restrictions_read_only": false + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "hosted_runners_url": { + "type": "string" + }, + "inherited": { + "type": "boolean" + }, + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" + }, + "workflow_restrictions_read_only": { + "description": "If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.", + "type": "boolean", + "default": false + }, + "restricted_to_workflows": { + "description": "If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.", + "type": "boolean", + "default": false + }, + "selected_workflows": { + "description": "List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.", + "type": "array", + "items": { + "type": "string", + "description": "Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.", + "examples": [ + "octo-org/octo-repo/.github/workflows/deploy.yaml@main" + ] + } + } + }, + "required": [ + "id", + "name", + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Updates the name and visibility of a self-hosted runner group in an organization.
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "title": "Delete a self-hosted runner group from an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Deletes a self-hosted runner group for an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "title": "List repository access to a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "organization": null, + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "allow_auto_merge": false, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + ] + }, + "name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "owner": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" + ] + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" + ] + }, + "archive_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + ] + }, + "assignees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + ] + }, + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + ] + }, + "branches_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + ] + }, + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + ] + }, + "comments_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + ] + }, + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] + }, + "compare_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + ] + }, + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" + ] + }, + "deployments_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] + }, + "downloads_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" + ] + }, + "forks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" + ] + }, + "git_commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + ] + }, + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + ] + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" + ] + }, + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" + ] + }, + "milestones_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + ] + }, + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + ] + }, + "pulls_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + ] + }, + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + ] + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" + ] + }, + "statuses_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] + }, + "tags_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] + }, + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] + }, + "trees_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": [ + "string", + "null" + ] + }, + "hooks_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" + ] + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": [ + "string", + "null" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "has_discussions": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] + }, + "created_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] + }, + "updated_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "role_name": { + "type": "string", + "examples": [ + "admin" + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "code_of_conduct": { + "title": "Code Of Conduct", + "description": "Code Of Conduct", + "type": "object", + "properties": { + "key": { + "type": "string", + "examples": [ + "contributor_covenant" + ] + }, + "name": { + "type": "string", + "examples": [ + "Contributor Covenant" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/codes_of_conduct/contributor_covenant" + ] + }, + "body": { + "type": "string", + "examples": [ + "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri" + } + }, + "required": [ + "url", + "html_url", + "key", + "name" + ] + }, + "license": { + "type": [ + "object", + "null" + ], + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "forks": { + "type": "integer", + "examples": [ + 0 + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 0 + ] + }, + "watchers": { + "type": "integer", + "examples": [ + 0 + ] + }, + "allow_forking": { + "type": "boolean" + }, + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] + }, + "security_and_analysis": { + "type": [ + "object", + "null" + ], + "properties": { + "advanced_security": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "dependabot_security_updates": { + "description": "Enable or disable Dependabot security updates for the repository.", + "type": "object", + "properties": { + "status": { + "description": "The enablement status of Dependabot security updates for the repository.", + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_push_protection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_non_provider_patterns": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + } + } + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Lists the repositories with access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories", + "title": "Set repository access for a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "array of integers", + "name": "selected_repository_ids", + "in": "body", + "description": "List of repository IDs that can access the runner group.
", + "isRequired": true + } + ], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "selected_repository_ids": [ + 32, + 91 + ] + }, + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Replaces the list of repositories that have access to a self-hosted runner group configured in an organization.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "title": "Add repository access to a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Adds a repository to the list of repositories 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 organization.\"
OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/repositories/{repository_id}", + "title": "Remove repository access to a self-hosted runner group in an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "repository_id", + "description": "The unique identifier of the repository.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "write", + "\"Metadata\" repository permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "repository_id": "REPOSITORY_ID" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Removes a repository from the list of selected repositories 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 organization.\"
OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
No Content
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners", + "title": "List self-hosted runners in a group for an organization", + "category": "actions", + "subcategory": "self-hosted-runner-groups", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Self-hosted runners\" organization permissions": "read" } ] }, @@ -7235,9 +10081,8 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { @@ -7246,16 +10091,59 @@ "description": "Response
", "example": { "total_count": 2, - "secrets": [ + "runners": [ { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] }, { - "name": "GIST_ID", - "created_at": "2020-01-10T10:59:22Z", - "updated_at": "2020-01-11T11:59:22Z" + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] } ] }, @@ -7263,39 +10151,94 @@ "type": "object", "required": [ "total_count", - "secrets" + "runners" ], "properties": { "total_count": { - "type": "integer" + "type": "number" }, - "secrets": { + "runners": { "type": "array", "items": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "examples": [ + 5 + ] + }, + "runner_group_id": { + "description": "The id of the runner group.", + "type": "integer", + "examples": [ + 1 + ] + }, "name": { - "description": "The name of the secret.", + "description": "The name of the runner.", "type": "string", "examples": [ - "SECRET_TOKEN" + "iMac" ] }, - "created_at": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "date-time" + "examples": [ + "macos" + ] }, - "updated_at": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "date-time" + "examples": [ + "online" + ] + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "title": "Self hosted runner label", + "description": "A label for a self hosted runner", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + }, + "required": [ + "name" + ] + } } }, "required": [ + "id", "name", - "created_at", - "updated_at" + "os", + "status", + "busy", + "labels" ] } } @@ -7305,7 +10248,7 @@ } ], "previews": [], - "descriptionHTML": "Lists all secrets available in an environment without revealing their\nencrypted values.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Lists self-hosted runners that are in a specific organization group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -7340,162 +10274,31 @@ } }, { - "name": "environment_name", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, - "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
Response
", - "example": { - "key_id": "012345678912345678", - "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" - }, - "schema": { - "title": "ActionsPublicKey", - "description": "The public key used for setting Actions Secrets.", - "type": "object", - "properties": { - "key_id": { - "description": "The identifier for the key.", - "type": "string", - "examples": [ - "1234567" - ] - }, - "key": { - "description": "The Base64 encoded public key.", - "type": "string", - "examples": [ - "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" - ] - }, - "id": { - "type": "integer", - "examples": [ - 2 - ] - }, - "url": { - "type": "string", - "examples": [ - "https://api.github.com/user/keys/2" - ] - }, - "title": { - "type": "string", - "examples": [ - "ssh-rsa AAAAB3NzaC1yc2EAAA" - ] - }, - "created_at": { - "type": "string", - "examples": [ - "2011-01-26T19:01:12Z" - ] - } - }, - "required": [ - "key_id", - "key" - ] - } + "type": "integer" } } ], - "previews": [], - "descriptionHTML": "Get the public key for an environment, which you need to encrypt environment\nsecrets. You need to encrypt a secret before you can create or update secrets.
\nAnyone with read access to the repository can use this endpoint.
\nIf the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
OK
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Get an environment secret", - "category": "actions", - "subcategory": "secrets", - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
The name of the secret.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "array of integers", + "name": "runners", + "in": "body", + "description": "List of runner IDs to add to the runner group.
", + "isRequired": true } ], - "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "read", - "\"Environments\" repository permissions": "read" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -7503,83 +10306,46 @@ { "key": "default", "request": { + "contentType": "application/json", "description": "Example", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "runners": [ + 9, + 2 + ] + }, "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID" } }, "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "name": "GH_TOKEN", - "created_at": "2019-08-10T14:59:22Z", - "updated_at": "2020-01-10T14:59:22Z" - }, - "schema": { - "title": "Actions Secret", - "description": "Set secrets for GitHub Actions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the secret.", - "type": "string", - "examples": [ - "SECRET_TOKEN" - ] - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "name", - "created_at", - "updated_at" - ] - } + "statusCode": "204", + "description": "Response
" } } ], "previews": [], - "descriptionHTML": "Gets a single environment secret without revealing its encrypted value.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Replaces the list of self-hosted runners that are part of an organization runner group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
OK
" + "httpStatusCode": "204", + "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "put", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Create or update an environment secret", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "title": "Add a self-hosted runner to a group for an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -7587,48 +10353,32 @@ } }, { - "name": "environment_name", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, - "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
The name of the secret.
", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], - "bodyParameters": [ - { - "type": "string", - "name": "encrypted_value", - "in": "body", - "description": "Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.
", - "isRequired": true - }, - { - "type": "string", - "name": "key_id", - "in": "body", - "description": "ID of the key you used to encrypt the secret.
", - "isRequired": true - } - ], + "bodyParameters": [], "progAccess": { "userToServerRest": true, "serverToServer": true, "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "write", - "\"Environments\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -7636,90 +10386,40 @@ { "key": "default", "request": { - "contentType": "application/json", - "description": "Example 1: Status Code 201", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, - "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" - } - }, - "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response when creating a secret
", - "example": null, - "schema": { - "title": "Empty Object", - "description": "An object without any properties.", - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - }, - { - "key": "204", - "request": { - "contentType": "application/json", - "description": "Example 2: Status Code 204", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "encrypted_value": "c2VjcmV0", - "key_id": "012345678912345678" - }, "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", - "description": "Response when updating a secret
" + "description": "Response
" } } ], "previews": [], - "descriptionHTML": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Adds a self-hosted runner to a runner group configured in an organization.
\nOAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Response when creating a secret
" - }, { "httpStatusCode": "204", - "description": "Response when updating a secret
" + "description": "No Content
" } ] }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}", - "title": "Delete an environment secret", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", + "title": "Remove a self-hosted runner from a group for an organization", "category": "actions", - "subcategory": "secrets", + "subcategory": "self-hosted-runner-groups", "parameters": [ { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the .git extension. The name is not case sensitive.
The organization name. The name is not case sensitive.
", "in": "path", "required": true, "schema": { @@ -7727,21 +10427,21 @@ } }, { - "name": "environment_name", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.
", "in": "path", "required": true, - "description": "The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.
The name of the secret.
", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.
", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -7752,8 +10452,7 @@ "fineGrainedPat": true, "permissions": [ { - "\"Secrets\" repository permissions": "write", - "\"Environments\" repository permissions": "write" + "\"Self-hosted runners\" organization permissions": "write" } ] }, @@ -7764,24 +10463,23 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "owner": "OWNER", - "repo": "REPO", - "environment_name": "ENVIRONMENT_NAME", - "secret_name": "SECRET_NAME" + "org": "ORG", + "runner_group_id": "RUNNER_GROUP_ID", + "runner_id": "RUNNER_ID" } }, "response": { "statusCode": "204", - "description": "Default response
" + "description": "Response
" } } ], "previews": [], - "descriptionHTML": "Deletes a secret in an environment using the secret name.
\nAuthenticated users must have collaborator access to a repository to create, update, or read secrets.
\nOAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.
Removes a self-hosted runner from a group configured in an organization. The runner is then returned to the default group.
\nOAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
Default response
" + "description": "No Content
" } ] } @@ -16699,6 +19397,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -21959,6 +24669,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -22777,6 +25499,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -24715,6 +27449,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -25533,6 +28279,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -28010,6 +30768,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -28828,6 +31598,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -33200,6 +35982,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -34018,6 +36812,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -67980,6 +70786,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -69101,6 +71919,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -70650,6 +73480,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -77878,6 +80720,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -78905,6 +81759,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -133636,6 +136502,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -135455,6 +138333,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -136788,6 +139678,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -138521,6 +141423,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -140412,6 +143326,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -143766,6 +146692,24 @@ "default": "desc" } }, + { + "name": "before", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "The property by which to sort the results.
", @@ -159325,6 +162269,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -161162,6 +164118,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -162858,6 +165826,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -165297,6 +168277,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -166994,6 +169986,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -169058,6 +172062,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -170905,6 +173921,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -172598,6 +175626,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -174348,6 +177388,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -176121,6 +179173,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -181864,6 +184928,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, @@ -183634,6 +186710,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -185396,6 +188484,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -187757,6 +190857,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -189727,6 +192839,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -192088,6 +195212,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -193962,6 +197098,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -196535,6 +199683,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -198257,6 +201417,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -200099,6 +203271,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -201534,6 +204718,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -203014,6 +206210,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -216200,6 +219408,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -229464,6 +232684,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -338957,6 +342189,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -346418,6 +349662,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -360163,6 +363419,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -361856,6 +365124,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -362648,7 +365928,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -365175,7 +368458,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -366529,7 +369815,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -369062,7 +372351,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -373686,6 +376978,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -374939,6 +378243,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -376140,6 +379456,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -378235,6 +381563,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -379468,6 +382808,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -380718,6 +384070,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -382775,6 +386139,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -384028,6 +387404,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -385296,6 +388684,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -447910,6 +451310,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } } @@ -452650,6 +456062,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, @@ -457256,6 +460680,18 @@ ] } } + }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } } } }, @@ -457472,6 +460908,18 @@ } ] }, + { + "type": "object", + "name": "secret_scanning_ai_detection", + "description": "Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see \"Responsible detection of generic secrets with AI.\"
Can be enabled or disabled.
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "sort", "description": "The property by which to sort the results.
", @@ -170652,6 +170922,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -172501,6 +172783,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -174209,6 +174503,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -176660,6 +176966,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -178369,6 +178687,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -180445,6 +180775,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -182304,6 +182646,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -184009,6 +184363,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -185771,6 +186137,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -187556,6 +187934,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -193311,6 +193701,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -195093,6 +195495,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -196867,6 +197281,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -199240,6 +199666,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -201222,6 +201660,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -203595,6 +204045,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -205481,6 +205943,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -208066,6 +208540,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -209800,6 +210286,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -211654,6 +212152,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -213101,6 +213611,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -214593,6 +215115,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -227791,6 +228325,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -241067,6 +241613,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -358621,6 +359179,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -366094,6 +366664,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -384395,6 +384977,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -386100,6 +386694,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -386904,7 +387510,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -389433,7 +390042,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -390788,7 +391400,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -393323,7 +393938,10 @@ } }, "html": { - "type": "object", + "type": [ + "object", + "null" + ], "properties": { "href": { "type": "string", @@ -397948,6 +398566,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -399213,6 +399843,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -400426,6 +401068,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -402533,6 +403187,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -403778,6 +404444,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -405040,6 +405718,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -407109,6 +407799,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -408374,6 +409076,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -409654,6 +410368,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -472285,6 +473011,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -477038,6 +477776,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -481661,6 +482411,18 @@ } } }, + "secret_scanning_ai_detection": { + "type": "object", + "properties": { + "status": { + "type": "string", + "enum": [ + "enabled", + "disabled" + ] + } + } + }, "secret_scanning_validity_checks": { "type": "object", "properties": { @@ -481889,6 +482651,18 @@ } ] }, + { + "type": "object", + "name": "secret_scanning_ai_detection", + "description": "Use the status property to enable or disable secret scanning AI detection for this repository. For more information, see \"Responsible detection of generic secrets with AI.\"
Can be enabled or disabled.
Type EPSS was added
Type UserViewType was added
Argument epssPercentage: Float added to field Query.securityAdvisories
Argument epssPercentile: Float added to field Query.securityAdvisories
Field epss was added to object type SecurityAdvisory
Field userViewType was added to object type User
A list of classifications to filter advisories by.
" }, + { + "name": "epssPercentage", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float", + "description": "The EPSS percentage to filter advisories by.
" + }, + { + "name": "epssPercentile", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float", + "description": "The EPSS percentile to filter advisories by.
" + }, { "name": "first", "type": "Int", @@ -21047,6 +21063,31 @@ } ] }, + { + "name": "EPSS", + "kind": "objects", + "id": "epss", + "href": "/graphql/reference/objects#epss", + "description": "The Exploit Prediction Scoring System.
", + "fields": [ + { + "name": "percentage", + "description": "The EPSS percentage represents the likelihood of a CVE being exploited.
", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float" + }, + { + "name": "percentile", + "description": "The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float" + } + ] + }, { "name": "Enterprise", "kind": "objects", @@ -66883,6 +66924,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "epss", + "description": "The Exploit Prediction Scoring System.
", + "type": "EPSS", + "id": "epss", + "kind": "objects", + "href": "/graphql/reference/objects#epss" + }, { "name": "ghsaId", "description": "The GitHub Security Advisory ID.
", @@ -77601,6 +77650,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#uri" }, + { + "name": "userViewType", + "description": "Whether the request returns publicly visible information or privately visible information about the user.
", + "type": "UserViewType!", + "id": "userviewtype", + "kind": "enums", + "href": "/graphql/reference/enums#userviewtype" + }, { "name": "viewerCanChangePinnedItems", "description": "Can the viewer pin repositories and gists to the profile?.
", @@ -89778,6 +89835,23 @@ } ] }, + { + "name": "UserViewType", + "kind": "enums", + "id": "userviewtype", + "href": "/graphql/reference/enums#userviewtype", + "description": "Whether a user being viewed contains public or private information.
", + "values": [ + { + "name": "PRIVATE", + "description": "A user containing information only visible to the authenticated user.
" + }, + { + "name": "PUBLIC", + "description": "A user that is publicly visible.
" + } + ] + }, { "name": "VerifiableDomainOrderField", "kind": "enums", diff --git a/src/graphql/data/ghec/schema.docs.graphql b/src/graphql/data/ghec/schema.docs.graphql index 9dd37ceca05f..d0d150443939 100644 --- a/src/graphql/data/ghec/schema.docs.graphql +++ b/src/graphql/data/ghec/schema.docs.graphql @@ -12662,6 +12662,21 @@ input DraftPullRequestReviewThread { startSide: DiffSide = RIGHT } +""" +The Exploit Prediction Scoring System +""" +type EPSS { + """ + The EPSS percentage represents the likelihood of a CVE being exploited. + """ + percentage: Float + + """ + The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. + """ + percentile: Float +} + """ Autogenerated input type of EnablePullRequestAutoMerge """ @@ -40066,6 +40081,16 @@ type Query implements Node { """ classifications: [SecurityAdvisoryClassification!] + """ + The EPSS percentage to filter advisories by. + """ + epssPercentage: Float + + """ + The EPSS percentile to filter advisories by. + """ + epssPercentile: Float + """ Returns the first _n_ elements from the list. """ @@ -50013,6 +50038,11 @@ type SecurityAdvisory implements Node { """ description: String! + """ + The Exploit Prediction Scoring System + """ + epss: EPSS + """ The GitHub Security Advisory ID """ @@ -62697,6 +62727,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ url: URI! + """ + Whether the request returns publicly visible information or privately visible information about the user + """ + userViewType: UserViewType! + """ Can the viewer pin repositories and gists to the profile? """ @@ -63300,6 +63335,21 @@ enum UserStatusOrderField { UPDATED_AT } +""" +Whether a user being viewed contains public or private information. +""" +enum UserViewType { + """ + A user containing information only visible to the authenticated user. + """ + PRIVATE + + """ + A user that is publicly visible. + """ + PUBLIC +} + """ A domain that can be verified or approved for an organization or an enterprise. """ diff --git a/src/graphql/data/ghec/schema.json b/src/graphql/data/ghec/schema.json index ae304a2af5b8..c79f7582559d 100644 --- a/src/graphql/data/ghec/schema.json +++ b/src/graphql/data/ghec/schema.json @@ -631,6 +631,22 @@ "href": "/graphql/reference/enums#securityadvisoryclassification", "description": "A list of classifications to filter advisories by.
" }, + { + "name": "epssPercentage", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float", + "description": "The EPSS percentage to filter advisories by.
" + }, + { + "name": "epssPercentile", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float", + "description": "The EPSS percentile to filter advisories by.
" + }, { "name": "first", "type": "Int", @@ -21047,6 +21063,31 @@ } ] }, + { + "name": "EPSS", + "kind": "objects", + "id": "epss", + "href": "/graphql/reference/objects#epss", + "description": "The Exploit Prediction Scoring System.
", + "fields": [ + { + "name": "percentage", + "description": "The EPSS percentage represents the likelihood of a CVE being exploited.
", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float" + }, + { + "name": "percentile", + "description": "The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs.
", + "type": "Float", + "id": "float", + "kind": "scalars", + "href": "/graphql/reference/scalars#float" + } + ] + }, { "name": "Enterprise", "kind": "objects", @@ -66883,6 +66924,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#string" }, + { + "name": "epss", + "description": "The Exploit Prediction Scoring System.
", + "type": "EPSS", + "id": "epss", + "kind": "objects", + "href": "/graphql/reference/objects#epss" + }, { "name": "ghsaId", "description": "The GitHub Security Advisory ID.
", @@ -77601,6 +77650,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#uri" }, + { + "name": "userViewType", + "description": "Whether the request returns publicly visible information or privately visible information about the user.
", + "type": "UserViewType!", + "id": "userviewtype", + "kind": "enums", + "href": "/graphql/reference/enums#userviewtype" + }, { "name": "viewerCanChangePinnedItems", "description": "Can the viewer pin repositories and gists to the profile?.
", @@ -89778,6 +89835,23 @@ } ] }, + { + "name": "UserViewType", + "kind": "enums", + "id": "userviewtype", + "href": "/graphql/reference/enums#userviewtype", + "description": "Whether a user being viewed contains public or private information.
", + "values": [ + { + "name": "PRIVATE", + "description": "A user containing information only visible to the authenticated user.
" + }, + { + "name": "PUBLIC", + "description": "A user that is publicly visible.
" + } + ] + }, { "name": "VerifiableDomainOrderField", "kind": "enums", From 3bfda9ecda989f4cf60a61605496d8cdb884f30d Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Fri, 18 Oct 2024 18:03:45 -0400 Subject: [PATCH 4/4] Update audit log event data (#52783) Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> --- src/audit-logs/data/fpt/organization.json | 5 +++++ src/audit-logs/data/fpt/user.json | 15 +++++++++++++++ src/audit-logs/data/ghec/enterprise.json | 15 +++++++++++++++ src/audit-logs/data/ghec/organization.json | 5 +++++ src/audit-logs/data/ghec/user.json | 15 +++++++++++++++ src/audit-logs/lib/config.json | 2 +- 6 files changed, 56 insertions(+), 1 deletion(-) diff --git a/src/audit-logs/data/fpt/organization.json b/src/audit-logs/data/fpt/organization.json index 8d75de024fa1..b730c4319473 100644 --- a/src/audit-logs/data/fpt/organization.json +++ b/src/audit-logs/data/fpt/organization.json @@ -1544,6 +1544,11 @@ "description": "Push protection for secret scanning was enabled for all new repositories in the organization.", "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations" }, + { + "action": "org.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the CodeQL pull request alerts page.", + "docs_reference_links": "N/A" + }, { "action": "org.security_center_export_coverage", "description": "A CSV export was requested on the Coverage page.", diff --git a/src/audit-logs/data/fpt/user.json b/src/audit-logs/data/fpt/user.json index 89957cd4c3ff..732408ee7f4e 100644 --- a/src/audit-logs/data/fpt/user.json +++ b/src/audit-logs/data/fpt/user.json @@ -59,6 +59,16 @@ "description": "N/A", "docs_reference_links": "N/A" }, + { + "action": "business.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the \"CodeQL pull request alerts\" page.", + "docs_reference_links": "N/A" + }, + { + "action": "business.security_center_export_overview_dashboard", + "description": "A CSV export was requested on the \"Overview Dashboard\" page.", + "docs_reference_links": "N/A" + }, { "action": "business.set_actions_fork_pr_approvals_policy", "description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.", @@ -684,6 +694,11 @@ "description": "A member was removed from an organization, either manually or due to a two-factor authentication requirement.", "docs_reference_links": "N/A" }, + { + "action": "org.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the CodeQL pull request alerts page.", + "docs_reference_links": "N/A" + }, { "action": "org.security_center_export_coverage", "description": "A CSV export was requested on the Coverage page.", diff --git a/src/audit-logs/data/ghec/enterprise.json b/src/audit-logs/data/ghec/enterprise.json index 88ac2f9f49c7..95e5ce70a9fd 100644 --- a/src/audit-logs/data/ghec/enterprise.json +++ b/src/audit-logs/data/ghec/enterprise.json @@ -219,6 +219,11 @@ "description": "The policy for Code scanning autofix was updated for an enterprise.", "docs_reference_links": "N/A" }, + { + "action": "business.code_scanning_autofix_third_party_tools_policy_update", + "description": "The policy for Code scanning autofix third party tools was updated for an enterprise.", + "docs_reference_links": "N/A" + }, { "action": "business.connect_usage_metrics_export", "description": "Server statistics were exported for the enterprise.", @@ -554,6 +559,16 @@ "description": "N/A", "docs_reference_links": "N/A" }, + { + "action": "business.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the \"CodeQL pull request alerts\" page.", + "docs_reference_links": "N/A" + }, + { + "action": "business.security_center_export_overview_dashboard", + "description": "A CSV export was requested on the \"Overview Dashboard\" page.", + "docs_reference_links": "N/A" + }, { "action": "business.set_actions_fork_pr_approvals_policy", "description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.", diff --git a/src/audit-logs/data/ghec/organization.json b/src/audit-logs/data/ghec/organization.json index 8d75de024fa1..b730c4319473 100644 --- a/src/audit-logs/data/ghec/organization.json +++ b/src/audit-logs/data/ghec/organization.json @@ -1544,6 +1544,11 @@ "description": "Push protection for secret scanning was enabled for all new repositories in the organization.", "docs_reference_links": "/code-security/secret-scanning/push-protection-for-repositories-and-organizations" }, + { + "action": "org.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the CodeQL pull request alerts page.", + "docs_reference_links": "N/A" + }, { "action": "org.security_center_export_coverage", "description": "A CSV export was requested on the Coverage page.", diff --git a/src/audit-logs/data/ghec/user.json b/src/audit-logs/data/ghec/user.json index 89957cd4c3ff..732408ee7f4e 100644 --- a/src/audit-logs/data/ghec/user.json +++ b/src/audit-logs/data/ghec/user.json @@ -59,6 +59,16 @@ "description": "N/A", "docs_reference_links": "N/A" }, + { + "action": "business.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the \"CodeQL pull request alerts\" page.", + "docs_reference_links": "N/A" + }, + { + "action": "business.security_center_export_overview_dashboard", + "description": "A CSV export was requested on the \"Overview Dashboard\" page.", + "docs_reference_links": "N/A" + }, { "action": "business.set_actions_fork_pr_approvals_policy", "description": "The policy for requiring approvals for workflows from public forks was changed for an enterprise.", @@ -684,6 +694,11 @@ "description": "A member was removed from an organization, either manually or due to a two-factor authentication requirement.", "docs_reference_links": "N/A" }, + { + "action": "org.security_center_export_code_scanning_metrics", + "description": "A CSV export was requested on the CodeQL pull request alerts page.", + "docs_reference_links": "N/A" + }, { "action": "org.security_center_export_coverage", "description": "A CSV export was requested on the Coverage page.", diff --git a/src/audit-logs/lib/config.json b/src/audit-logs/lib/config.json index 53f5a7a61024..2c5d19981be9 100644 --- a/src/audit-logs/lib/config.json +++ b/src/audit-logs/lib/config.json @@ -3,5 +3,5 @@ "apiOnlyEvents": "This event is not available in the web interface, only via the REST API, audit log streaming, or JSON/CSV exports.", "apiRequestEvent": "This event is only available via audit log streaming." }, - "sha": "d5e464291d8f2559b1c5b7398c16d43c61f79548" + "sha": "04cd944770d148dc72b686a2f1a03894f120dbc6" } \ No newline at end of file