Update OpenAPI Description (#52910)

Co-authored-by: Sunbrye Ly <[email protected]>
github · Oct 30, 2024 · 0a0806c · 0a0806c
1 parent 4f1b56e
commit 0a0806c
Show file tree

Hide file tree

Showing 22 changed files with 4,989 additions and 10 deletions.
diff --git a/content/rest/copilot/copilot-metrics.md b/content/rest/copilot/copilot-metrics.md
@@ -0,0 +1,14 @@
+---
+title: REST API endpoints for Copilot metrics
+shortTitle: Copilot metrics
+intro: Use the REST API to view Copilot metrics.
+versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
+  fpt: '*'
+  ghec: '*'
+topics:
+  - API
+autogenerated: rest
+allowTitleToDifferFromFilename: true
+---
+
+<!-- Content after this section is automatically generated -->
diff --git a/content/rest/copilot/index.md b/content/rest/copilot/index.md
@@ -10,6 +10,7 @@ topics:
 autogenerated: rest
 allowTitleToDifferFromFilename: true
 children:
+  - /copilot-metrics
   - /copilot-usage
   - /copilot-user-management
 versions:

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
@@ -291,6 +291,15 @@
         "additional-permissions": true,
         "access": "write"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-organization",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -462,6 +471,15 @@
         "additional-permissions": false,
         "access": "read"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-a-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-a-team",
@@ -690,6 +708,15 @@
         "additional-permissions": true,
         "access": "write"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-organization",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -708,6 +735,15 @@
         "additional-permissions": true,
         "access": "read"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-a-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-a-team",

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
@@ -2030,6 +2030,12 @@
       "verb": "delete",
       "requestPath": "/orgs/{org}/copilot/billing/selected_users"
     },
+    {
+      "slug": "get-copilot-metrics-for-an-organization",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-organization-members",
       "subcategory": "copilot-usage",
@@ -2042,6 +2048,12 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/members/{username}/copilot"
     },
+    {
+      "slug": "get-copilot-metrics-for-a-team",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-a-team",
       "subcategory": "copilot-usage",

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
@@ -14,6 +14,17 @@
         "server-to-server": false,
         "additional-permissions": false
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-enterprise",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/enterprises/{enterprise}/copilot/metrics",
+        "access": "read",
+        "user-to-server": false,
+        "server-to-server": false,
+        "additional-permissions": false
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-enterprise-members",
@@ -25,6 +36,17 @@
         "server-to-server": false,
         "additional-permissions": false
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-enterprise-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics",
+        "access": "read",
+        "user-to-server": false,
+        "server-to-server": false,
+        "additional-permissions": false
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-an-enterprise-team",
@@ -394,6 +416,17 @@
         "server-to-server": true,
         "additional-permissions": true
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-organization",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/copilot/metrics",
+        "access": "read",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": true
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -603,6 +636,17 @@
         "server-to-server": true,
         "additional-permissions": false
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-a-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
+        "access": "read",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": true
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-a-team",
@@ -875,6 +919,17 @@
         "server-to-server": true,
         "additional-permissions": true
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-organization",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/copilot/metrics",
+        "access": "read",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": true
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -897,6 +952,17 @@
         "server-to-server": true,
         "additional-permissions": true
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-a-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
+        "access": "read",
+        "user-to-server": true,
+        "server-to-server": true,
+        "additional-permissions": true
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-a-team",

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
@@ -1758,6 +1758,12 @@
       "verb": "delete",
       "requestPath": "/orgs/{org}/copilot/billing/selected_users"
     },
+    {
+      "slug": "get-copilot-metrics-for-an-organization",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-organization-members",
       "subcategory": "copilot-usage",
@@ -1770,6 +1776,12 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/members/{username}/copilot"
     },
+    {
+      "slug": "get-copilot-metrics-for-a-team",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-a-team",
       "subcategory": "copilot-usage",

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
@@ -2030,6 +2030,12 @@
       "verb": "delete",
       "requestPath": "/orgs/{org}/copilot/billing/selected_users"
     },
+    {
+      "slug": "get-copilot-metrics-for-an-organization",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-organization-members",
       "subcategory": "copilot-usage",
@@ -2042,6 +2048,12 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/members/{username}/copilot"
     },
+    {
+      "slug": "get-copilot-metrics-for-a-team",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-a-team",
       "subcategory": "copilot-usage",

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
@@ -522,6 +522,15 @@
         "additional-permissions": true,
         "access": "write"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-organization",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -765,6 +774,15 @@
         "additional-permissions": false,
         "access": "read"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-a-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-a-team",
@@ -1143,6 +1161,15 @@
         "additional-permissions": true,
         "access": "write"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-an-organization",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -1161,6 +1188,15 @@
         "additional-permissions": true,
         "access": "read"
       },
+      {
+        "category": "copilot",
+        "slug": "get-copilot-metrics-for-a-team",
+        "subcategory": "copilot-metrics",
+        "verb": "get",
+        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
+        "additional-permissions": true,
+        "access": "read"
+      },
       {
         "category": "copilot",
         "slug": "get-a-summary-of-copilot-usage-for-a-team",

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
@@ -2068,6 +2068,12 @@
       "verb": "delete",
       "requestPath": "/orgs/{org}/copilot/billing/selected_users"
     },
+    {
+      "slug": "get-copilot-metrics-for-an-organization",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-organization-members",
       "subcategory": "copilot-usage",
@@ -2080,6 +2086,12 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/members/{username}/copilot"
     },
+    {
+      "slug": "get-copilot-metrics-for-a-team",
+      "subcategory": "copilot-metrics",
+      "verb": "get",
+      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
+    },
     {
       "slug": "get-a-summary-of-copilot-usage-for-a-team",
       "subcategory": "copilot-usage",