diff --git a/.github/branch_protection_settings/main.json b/.github/branch_protection_settings/main.json index 39c2b0491e00..29e0c828d766 100644 --- a/.github/branch_protection_settings/main.json +++ b/.github/branch_protection_settings/main.json @@ -41,7 +41,10 @@ "workflows", "lint-code", "secret-scanning", - "pagelist" + "pagelist", + "docs-internal-docker-image / docs-internal-docker-image", + "docs-internal-docker-security / docs-internal-docker-security", + "docs-internal-moda-config-bundle / docs-internal-moda-config-bundle" ], "contexts_url": "https://api.github.com/repos/github/docs-internal/branches/main/protection/required_status_checks/contexts", "checks": [ @@ -85,7 +88,19 @@ { "context": "workflows", "app_id": 15368 }, { "context": "lint-code", "app_id": 15368 }, { "context": "secret-scanning", "app_id": 15368 }, - { "context": "pagelist", "app_id": 15368 } + { "context": "pagelist", "app_id": 15368 }, + { + "context": "docs-internal-docker-image / docs-internal-docker-image", + "app_id": 15368 + }, + { + "context": "docs-internal-docker-security / docs-internal-docker-security", + "app_id": 15368 + }, + { + "context": "docs-internal-moda-config-bundle / docs-internal-moda-config-bundle", + "app_id": 15368 + } ] }, "restrictions": { diff --git a/config/moda/deployment.yaml b/config/moda/deployment.yaml index a8edafe09980..d77c5bb51341 100644 --- a/config/moda/deployment.yaml +++ b/config/moda/deployment.yaml @@ -1,13 +1,36 @@ -required_builds: - - docs-internal-moda-config-bundle / docs-internal-moda-config-bundle - - docs-internal-docker-image / docs-internal-docker-image - - docs-internal-docker-security / docs-internal-docker-security +# Deploy configuration reference: https://thehub.github.com/epd/engineering/products-and-services/internal/moda/reference/deployment-yaml/ + environments: - name: production - auto_deploy: true + require_pipeline: true cluster_selector: profile: general region: iad + +required_builds: + - docs-internal-moda-config-bundle / docs-internal-moda-config-bundle + - docs-internal-docker-image / docs-internal-docker-image + - docs-internal-docker-security / docs-internal-docker-security + +# Make the pipeline start automatically when a PR is enqueued +auto_start_pipeline: production_rollout + +pipelines: + production_rollout: + thread_notifications: true + notify_users_via_dm: false + timeout: 1200 + stages: + - name: full_production + kind: deployment + start_message: We are now going to deploy {{app}}/{{ref}}! Please pause or cancel the pipeline after the deploy if you want more time before auto-merging your pull request(s). + config: + environment: production + timeout: 1200 + # gates: + # - kind: timer + # duration: 1200 + notifications: slack_channels: - '#docs-ops' diff --git a/content/rest/index.md b/content/rest/index.md index 6322d88ce478..9987a9f92c42 100644 --- a/content/rest/index.md +++ b/content/rest/index.md @@ -75,6 +75,7 @@ children: - /orgs - /packages - /pages + - /private-registries - /projects - /pulls - /rate-limit diff --git a/content/rest/private-registries/index.md b/content/rest/private-registries/index.md new file mode 100644 index 000000000000..2532d3ce1501 --- /dev/null +++ b/content/rest/private-registries/index.md @@ -0,0 +1,13 @@ +--- +title: Private registries +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +children: + - /organization-configurations +versions: + fpt: '*' + ghec: '*' +--- + diff --git a/content/rest/private-registries/organization-configurations.md b/content/rest/private-registries/organization-configurations.md new file mode 100644 index 000000000000..649e5a58edbc --- /dev/null +++ b/content/rest/private-registries/organization-configurations.md @@ -0,0 +1,17 @@ +--- +title: Organization configurations +shortTitle: Organization configurations +intro: Use the REST API to manage private registry configurations for organizations. +versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖 + fpt: '*' + ghec: '*' +topics: + - API +autogenerated: rest +allowTitleToDifferFromFilename: true +--- + +> [!NOTE] +> The ability to use the REST API to manage private registries is currently in {% data variables.release-phases.public_preview %} and subject to change. + + 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 02ad6c8b8341..935004d4ed0e 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 @@ -1403,6 +1403,66 @@ } ] }, + "organization_private_registries": { + "title": "Organization private registries", + "displayTitle": "Organization permissions for \"Organization private registries\"", + "permissions": [ + { + "category": "private-registries", + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries", + "additional-permissions": false, + "access": "read" + }, + { + "category": "private-registries", + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries", + "additional-permissions": false, + "access": "write" + }, + { + "category": "private-registries", + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key", + "additional-permissions": false, + "access": "read" + }, + { + "category": "private-registries", + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "private-registries", + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "private-registries", + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "additional-permissions": false, + "access": "write" + } + ] + }, "organization_personal_access_token_requests": { "title": "Personal access token requests", "displayTitle": "Organization permissions for \"Personal access token requests\"", 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 85cd57f03151..aa2060e730ba 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 @@ -3819,6 +3819,44 @@ "requestPath": "/repos/{owner}/{repo}/pages/health" } ], + "private-registries": [ + { + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key" + }, + { + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + } + ], "projects": [ { "slug": "list-organization-projects", 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 7211a26bc2ea..3cc75ac63cd9 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 @@ -1699,6 +1699,78 @@ } ] }, + "organization_private_registries": { + "title": "Organization private registries", + "displayTitle": "Organization permissions for \"Organization private registries\"", + "permissions": [ + { + "category": "private-registries", + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_personal_access_token_requests": { "title": "Personal access token requests", "displayTitle": "Organization permissions for \"Personal access token requests\"", 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 4084c5e5c665..bab111dbeb74 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 @@ -3351,6 +3351,44 @@ "requestPath": "/repos/{owner}/{repo}/pages/health" } ], + "private-registries": [ + { + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key" + }, + { + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + } + ], "projects": [ { "slug": "list-organization-projects", 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 85cd57f03151..aa2060e730ba 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 @@ -3819,6 +3819,44 @@ "requestPath": "/repos/{owner}/{repo}/pages/health" } ], + "private-registries": [ + { + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key" + }, + { + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + } + ], "projects": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index bb3d84f31b89..885680b630a3 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -1853,6 +1853,66 @@ } ] }, + "organization_private_registries": { + "title": "Organization private registries", + "displayTitle": "Organization permissions for \"Organization private registries\"", + "permissions": [ + { + "category": "private-registries", + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries", + "additional-permissions": false, + "access": "read" + }, + { + "category": "private-registries", + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries", + "additional-permissions": false, + "access": "write" + }, + { + "category": "private-registries", + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key", + "additional-permissions": false, + "access": "read" + }, + { + "category": "private-registries", + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "additional-permissions": false, + "access": "read" + }, + { + "category": "private-registries", + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "additional-permissions": false, + "access": "write" + }, + { + "category": "private-registries", + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "additional-permissions": false, + "access": "write" + } + ] + }, "organization_personal_access_token_requests": { "title": "Personal access token requests", "displayTitle": "Organization permissions for \"Personal access token requests\"", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 8642c242cb0a..606265a4a1b3 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -4153,6 +4153,44 @@ "requestPath": "/repos/{owner}/{repo}/pages/health" } ], + "private-registries": [ + { + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key" + }, + { + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + } + ], "projects": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 6bb9f379cb5a..cbdff423ff3f 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -2245,6 +2245,78 @@ } ] }, + "organization_private_registries": { + "title": "Organization private registries", + "displayTitle": "Organization permissions for \"Organization private registries\"", + "permissions": [ + { + "category": "private-registries", + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "private-registries", + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "organization_personal_access_token_requests": { "title": "Personal access token requests", "displayTitle": "Organization permissions for \"Personal access token requests\"", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index d0711314b56a..add62e840b71 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -3685,6 +3685,44 @@ "requestPath": "/repos/{owner}/{repo}/pages/health" } ], + "private-registries": [ + { + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key" + }, + { + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + } + ], "projects": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index 8642c242cb0a..606265a4a1b3 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4153,6 +4153,44 @@ "requestPath": "/repos/{owner}/{repo}/pages/health" } ], + "private-registries": [ + { + "slug": "list-private-registries-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "create-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries" + }, + { + "slug": "get-private-registries-public-key-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key" + }, + { + "slug": "get-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "update-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + }, + { + "slug": "delete-a-private-registry-for-an-organization", + "subcategory": "organization-configurations", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}" + } + ], "projects": [ { "slug": "list-organization-projects", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index 82273c01fde7..6d62152a58f2 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "99b100d4af04d83bdb08024aa6af991edd2ea02f" + "sha": "9a474fd38005b61bee9706e8f4f6f2bea8561745" } \ No newline at end of file diff --git a/src/products/README.md b/src/products/README.md index e69de29bb2d1..129c5bd19973 100644 --- a/src/products/README.md +++ b/src/products/README.md @@ -0,0 +1 @@ +❤︎ diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index 57b5fd72aa24..309097e34ba2 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -159122,6 +159122,7 @@ "items": { "type": "string", "enum": [ + "actions", "c-cpp", "csharp", "go", @@ -159135,6 +159136,28 @@ ] } }, + "runner_type": { + "description": "Runner type to be used.", + "type": [ + "string", + "null" + ], + "enum": [ + "standard", + "labeled", + null + ] + }, + "runner_label": { + "description": "Runner label to be used if the runner type is labeled.", + "type": [ + "string", + "null" + ], + "examples": [ + "code-scanning" + ] + }, "query_suite": { "description": "CodeQL query suite to be used.", "type": "string", @@ -159259,7 +159282,7 @@ "type": "array of strings", "name": "languages", "in": "body", - "description": "
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
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 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" 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": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries", + "title": "Create a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "registry_type", + "in": "body", + "description": "The registry type.
", + "isRequired": true, + "enum": [ + "maven_repository" + ] + }, + { + "type": "string or null", + "name": "username", + "in": "body", + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
" + }, + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "The ID of the key you used to encrypt the secret.
", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "Which type of organization repositories have access to the private registry. selected
means only the repositories specified by selected_repository_ids
can access the private registry.
An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility
is set to selected
. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility
is set to all
or private
.
The organization private registry configuration
", + "example": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": "string", + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + }, + { + "key": "org-private-registry-with-selected-visibility", + "request": { + "contentType": "application/json", + "description": "Example of a private registry configuration with selected visibility", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "registry_type": "maven_repository", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "The organization private registry configuration
", + "example": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": "string", + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
The organization private registry configuration
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key", + "title": "Get private registries public key for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" 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": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "012345678912345678" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "title": "Get a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The specified private registry configuration for the organization
", + "example": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
The specified private registry configuration for the organization
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "title": "Update a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "registry_type", + "in": "body", + "description": "The registry type.
", + "enum": [ + "maven_repository" + ] + }, + { + "type": "string or null", + "name": "username", + "in": "body", + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
" + }, + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.
" + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "The ID of the key you used to encrypt the secret.
" + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "Which type of organization repositories have access to the private registry. selected
means only the repositories specified by selected_repository_ids
can access the private registry.
An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility
is set to selected
. This field should be omitted if visibility
is set to all
or private
.
Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "title": "Delete a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nDelete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ] + }, "projects": { "projects": [ { @@ -538623,8 +539573,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true + "permissions": [] }, "codeExamples": [ { @@ -545391,7 +546340,7 @@ } ], "previews": [], - "descriptionHTML": "Lists the latest incremental and backfill scans by type for a repository.
\nOAuth app tokens and personal access tokens (classic) need the repo
or security_events
scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo
scope instead.
Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.
\nOAuth app tokens and personal access tokens (classic) need the repo
or security_events
scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo
scope instead.
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
Response
", + "example": [ + { + "day": "2023-10-15", + "total_suggestions_count": 1000, + "total_acceptances_count": 800, + "total_lines_suggested": 1800, + "total_lines_accepted": 1200, + "total_active_users": 10, + "total_chat_acceptances": 32, + "total_chat_turns": 200, + "total_active_chat_users": 4, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 250, + "lines_suggested": 900, + "lines_accepted": 700, + "active_users": 5 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 400, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 400, + "acceptances_count": 350, + "lines_suggested": 500, + "lines_accepted": 200, + "active_users": 3 + } + ] + }, + { + "day": "2023-10-16", + "total_suggestions_count": 800, + "total_acceptances_count": 600, + "total_lines_suggested": 1100, + "total_lines_accepted": 700, + "total_active_users": 12, + "total_chat_acceptances": 57, + "total_chat_turns": 426, + "total_active_chat_users": 8, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 600, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 150, + "lines_suggested": 300, + "lines_accepted": 250, + "active_users": 6 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 200, + "acceptances_count": 150, + "lines_suggested": 200, + "lines_accepted": 150, + "active_users": 3 + } + ] + } + ], + "schema": { + "type": "array", + "items": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "type": "object", + "properties": { + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": [ + "array", + "null" + ], + "description": "Breakdown of Copilot code completions usage by language and editor", + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } + } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.
\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot
or read:enterprise
scopes to use this endpoint.
OK
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "500", + "description": "Internal Error
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/copilot/usage", + "title": "Get a summary of Copilot usage for organization members", + "category": "copilot", + "subcategory": "copilot-usage", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "since", + "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ
). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ
) and should not preceed the since
date if it is passed.
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 days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 28 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, "permissions": [ { - "\"Enterprise administration\" business permissions": "read" + "\"GitHub Copilot Business\" organization permissions": "read" + }, + { + "\"Administration\" organization permissions": "read" } ] }, @@ -239039,294 +239333,7 @@ "description": "Example", "acceptHeader": "application/vnd.github.v3+json", "parameters": { - "enterprise": "ENTERPRISE", - "team_slug": "TEAM_SLUG" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ], - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - } - } - } - ], - "previews": [], - "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"About enterprise accounts for Copilot Business.\"
\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.
\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.
\nNote
\n\nThis endpoint will only return results for a given day if the enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day.
\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage metrics for the enterprise team.
\nOAuth app tokens and personal access tokens (classic) need either the manage_billing:copilot
or read:enterprise
scopes to use this endpoint.
OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "500", - "description": "Internal Error
" - } - ] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/copilot/usage", - "title": "Get a summary of Copilot usage for organization members", - "category": "copilot", - "subcategory": "copilot-usage", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ
). Maximum value is 28 days ago.
Show usage metrics until this date. This is a timestamp in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ
) and should not preceed the since
date if it is passed.
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 days of metrics to display per page (max 28). For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "bodyParameters": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"GitHub Copilot Business\" organization permissions": "read" - }, - { - "\"Administration\" organization permissions": "read" - } - ] - }, - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "org": "ORG" + "org": "ORG" } }, "response": { @@ -239876,11 +239883,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" business permissions": "read" - } - ] + "permissions": [] }, "codeExamples": [ { @@ -266756,11 +266759,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" business permissions": "write" - } - ] + "permissions": [] }, "codeExamples": [ { @@ -266904,11 +266903,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" business permissions": "write" - } - ] + "permissions": [] }, "codeExamples": [ { @@ -267014,11 +267009,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" business permissions": "write" - } - ] + "permissions": [] }, "codeExamples": [ { @@ -267312,11 +267303,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [ - { - "\"Enterprise administration\" business permissions": "write" - } - ] + "permissions": [] }, "codeExamples": [ { @@ -281605,6 +281592,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -282105,6 +282095,7 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, + "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { @@ -282728,6 +282719,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -283192,6 +283186,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -283592,6 +283589,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -284185,6 +284185,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -284654,6 +284657,7 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, + "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { @@ -285277,6 +285281,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -285741,6 +285748,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -286057,6 +286067,7 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, + "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { @@ -286680,6 +286691,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -287144,6 +287158,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -287985,6 +288002,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -288449,6 +288469,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -289302,6 +289325,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -289766,6 +289792,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -291048,6 +291077,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -291512,6 +291544,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -291892,6 +291927,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -292569,6 +292607,7 @@ "updated_at": "2022-09-21T10:28:06Z", "description": "An updated gist description.", "comments": 0, + "comments_enabled": true, "user": null, "comments_url": "https://api.github.com/gists/2decf6c462d9b4418f2/comments", "owner": { @@ -293192,6 +293231,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -293656,6 +293698,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "type": [ "string", @@ -294064,6 +294109,9 @@ "comments": { "type": "integer" }, + "comments_enabled": { + "type": "boolean" + }, "user": { "anyOf": [ { @@ -448718,6 +448766,872 @@ } ] }, + "private-registries": { + "organization-configurations": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries", + "title": "List private registries for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "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 + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" 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": 1, + "configurations": [ + { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected" + } + ] + }, + "schema": { + "type": "object", + "required": [ + "total_count", + "configurations" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "configurations": { + "type": "array", + "items": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nLists all private registry configurations available at the organization-level without revealing their encrypted\nvalues.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/orgs/{org}/private-registries", + "title": "Create a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "registry_type", + "in": "body", + "description": "The registry type.
", + "isRequired": true, + "enum": [ + "maven_repository" + ] + }, + { + "type": "string or null", + "name": "username", + "in": "body", + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
" + }, + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.
", + "isRequired": true + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "The ID of the key you used to encrypt the secret.
", + "isRequired": true + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "Which type of organization repositories have access to the private registry. selected
means only the repositories specified by selected_repository_ids
can access the private registry.
An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility
is set to selected
. You can manage the list of selected repositories using the Update a private registry for an organization endpoint. This field should be omitted if visibility
is set to all
or private
.
The organization private registry configuration
", + "example": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ], + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": "string", + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + }, + { + "key": "org-private-registry-with-selected-visibility", + "request": { + "contentType": "application/json", + "description": "Example of a private registry configuration with selected visibility", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "registry_type": "maven_repository", + "username": "monalisa", + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + 1296269, + 1296280 + ] + }, + "parameters": { + "org": "ORG" + } + }, + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "The organization private registry configuration
", + "example": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": "string", + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repository_ids": { + "type": "array", + "description": "An array of repository IDs that can access the organization private registry when `visibility` is set to `selected`.", + "items": { + "type": "integer" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nCreates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
The organization private registry configuration
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/public-key", + "title": "Get private registries public key for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" 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": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + }, + "schema": { + "type": "object", + "required": [ + "key_id", + "key" + ], + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "examples": [ + "012345678912345678" + ] + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "examples": [ + "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + ] + } + } + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.
\nOAuth tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
OK
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "title": "Get a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" organization permissions": "read" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "The specified private registry configuration for the organization
", + "example": { + "name": "MAVEN_REPOSITORY_SECRET", + "registry_type": "maven_repository", + "username": "monalisa", + "visibility": "private", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + "schema": { + "title": "Organization private registry", + "description": "Private registry configuration for an organization", + "type": "object", + "properties": { + "name": { + "description": "The name of the private registry configuration.", + "type": "string", + "examples": [ + "MAVEN_REPOSITORY_SECRET" + ] + }, + "registry_type": { + "description": "The registry type.", + "enum": [ + "maven_repository" + ], + "type": "string" + }, + "username": { + "description": "The username to use when authenticating with the private registry.", + "type": [ + "string", + "null" + ], + "examples": [ + "monalisa" + ] + }, + "visibility": { + "description": "Which type of organization repositories have access to the private registry.", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "registry_type", + "visibility", + "created_at", + "updated_at" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nGet the configuration of a single private registry defined for an organization, omitting its encrypted value.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
The specified private registry configuration for the organization
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "title": "Update a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "registry_type", + "in": "body", + "description": "The registry type.
", + "enum": [ + "maven_repository" + ] + }, + { + "type": "string or null", + "name": "username", + "in": "body", + "description": "The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
" + }, + { + "type": "string", + "name": "encrypted_value", + "in": "body", + "description": "The value for your secret, encrypted with LibSodium using the public key retrieved from the Get private registries public key for an organization endpoint.
" + }, + { + "type": "string", + "name": "key_id", + "in": "body", + "description": "The ID of the key you used to encrypt the secret.
" + }, + { + "type": "string", + "name": "visibility", + "in": "body", + "description": "Which type of organization repositories have access to the private registry. selected
means only the repositories specified by selected_repository_ids
can access the private registry.
An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when visibility
is set to selected
. This field should be omitted if visibility
is set to all
or private
.
Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nUpdates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see \"Encrypting secrets for the REST API.\"
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "delete", + "requestPath": "/orgs/{org}/private-registries/{secret_name}", + "title": "Delete a private registry for an organization", + "category": "private-registries", + "subcategory": "organization-configurations", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "The name of the secret.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Organization private registries\" organization permissions": "write" + } + ] + }, + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "org": "ORG", + "secret_name": "SECRET_NAME" + } + }, + "response": { + "statusCode": "204", + "description": "Response
" + } + } + ], + "previews": [], + "descriptionHTML": "Note
\n\nThis endpoint is in public preview and is subject to change.
\nDelete a private registry configuration at the organization-level.
\nOAuth app tokens and personal access tokens (classic) need the admin:org
scope to use this endpoint.
No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ] + } + ] + }, "projects": { "projects": [ { @@ -575993,8 +576907,7 @@ "userToServerRest": false, "serverToServer": false, "fineGrainedPat": false, - "permissions": [], - "allowPermissionlessAccess": true + "permissions": [] }, "codeExamples": [ { @@ -582761,7 +583674,7 @@ } ], "previews": [], - "descriptionHTML": "Lists the latest incremental and backfill scans by type for a repository.
\nOAuth app tokens and personal access tokens (classic) need the repo
or security_events
scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo
scope instead.
Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.
\nOAuth app tokens and personal access tokens (classic) need the repo
or security_events
scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo
scope instead.
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift
CodeQL languages to be analyzed.\nSupported values are: actions
, c-cpp
, csharp
, go
, java-kotlin
, javascript-typescript
, python
, ruby
, swift