From f677421627f7f5a68d254d037d19e7ce2e04cbeb Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Wed, 5 Nov 2025 10:37:06 -0800 Subject: [PATCH] Update OpenAPI Description (#58361) Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> --- .../fine-grained-pat-permissions.json | 42 ++++++++++++++++ .../ghec-2022-11-28/fine-grained-pat.json | 24 +++++++++ .../server-to-server-permissions.json | 50 +++++++++++++++++++ .../server-to-server-rest.json | 24 +++++++++ .../ghec-2022-11-28/user-to-server-rest.json | 24 +++++++++ src/github-apps/lib/config.json | 2 +- src/rest/data/ghec-2022-11-28/schema.json | 48 ++++++++++++------ src/rest/lib/config.json | 2 +- src/webhooks/lib/config.json | 2 +- 9 files changed, 199 insertions(+), 19 deletions(-) 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 c426fd69cd..4fb3219f6d 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 @@ -1,4 +1,46 @@ { + "enterprise_copilot_metrics": { + "title": "Enterprise Copilot metrics", + "displayTitle": "Enterprise permissions for \"Enterprise Copilot metrics\"", + "permissions": [ + { + "category": "copilot", + "slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot", + "slug": "get-copilot-enterprise-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot", + "slug": "get-copilot-users-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day", + "additional-permissions": false, + "access": "read" + }, + { + "category": "copilot", + "slug": "get-copilot-users-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest", + "additional-permissions": false, + "access": "read" + } + ] + }, "enterprise_custom_properties_for_organizations": { "title": "Enterprise custom properties for organizations", "displayTitle": "Enterprise permissions for \"Enterprise custom properties for organizations\"", 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 4d17557a46..cf30feebc9 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 @@ -2152,6 +2152,30 @@ } ], "copilot": [ + { + "slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day" + }, + { + "slug": "get-copilot-enterprise-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest" + }, + { + "slug": "get-copilot-users-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day" + }, + { + "slug": "get-copilot-users-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest" + }, { "slug": "get-copilot-seat-information-and-settings-for-an-organization", "subcategory": "copilot-user-management", 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 977613a34d..f639905e55 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 @@ -187,6 +187,56 @@ } ] }, + "enterprise_copilot_metrics": { + "title": "Enterprise Copilot metrics", + "displayTitle": "Enterprise permissions for \"Enterprise Copilot metrics\"", + "permissions": [ + { + "category": "copilot", + "slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot", + "slug": "get-copilot-enterprise-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot", + "slug": "get-copilot-users-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + }, + { + "category": "copilot", + "slug": "get-copilot-users-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest", + "access": "read", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": false + } + ] + }, "enterprise_scim": { "title": "Enterprise SCIM", "displayTitle": "Enterprise permissions for \"Enterprise SCIM\"", 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 82445dd1a5..9770f9b67a 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 @@ -2092,6 +2092,30 @@ } ], "copilot": [ + { + "slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day" + }, + { + "slug": "get-copilot-enterprise-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest" + }, + { + "slug": "get-copilot-users-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day" + }, + { + "slug": "get-copilot-users-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest" + }, { "slug": "get-copilot-seat-information-and-settings-for-an-organization", "subcategory": "copilot-user-management", 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 0799399fd7..0776b01ba4 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 @@ -2376,6 +2376,30 @@ } ], "copilot": [ + { + "slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day" + }, + { + "slug": "get-copilot-enterprise-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest" + }, + { + "slug": "get-copilot-users-usage-metrics-for-a-specific-day", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day" + }, + { + "slug": "get-copilot-users-usage-metrics", + "subcategory": "copilot-metrics", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest" + }, { "slug": "get-copilot-seat-information-and-settings-for-an-organization", "subcategory": "copilot-user-management", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index c78454438a..9c5aeeef72 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "b972b823e3572c9e6b64c3341401184e4eb0a474" + "sha": "e973182b530ffad0765b7713d0a9f80a0f46a220" } \ No newline at end of file diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 330a28ffb9..9640f9829a 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -265784,10 +265784,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] } }, { @@ -265885,10 +265889,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] } }, { @@ -265992,10 +266000,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] } }, { @@ -266093,10 +266105,14 @@ ], "previews": [], "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise Copilot metrics\" enterprise permissions": "read" + } + ] } }, { diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index 91332e6008..342c5cad5b 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -47,5 +47,5 @@ ] } }, - "sha": "b972b823e3572c9e6b64c3341401184e4eb0a474" + "sha": "e973182b530ffad0765b7713d0a9f80a0f46a220" } \ No newline at end of file diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index d66288ac1d..e286801345 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "b972b823e3572c9e6b64c3341401184e4eb0a474" + "sha": "e973182b530ffad0765b7713d0a9f80a0f46a220" } \ No newline at end of file