Update OpenAPI Description (#55029)

Co-authored-by: Fernando <[email protected]>
Co-authored-by: Ben Ahmady <[email protected]>

Author: 3 people

content/rest/copilot/copilot-metrics.md

@@ -9,6 +9,8 @@ topics:
   - API
 autogenerated: rest
 allowTitleToDifferFromFilename: true
+redirect_from:
+  - /rest/copilot/copilot-usage
 ---
 
 You can use these endpoints to get a breakdown of aggregated metrics for various {% data variables.product.prodname_copilot %} features. The API includes:
@@ -18,8 +20,6 @@ You can use these endpoints to get a breakdown of aggregated metrics for various
 * Breakdowns by language and IDE
 * The option to view metrics for an enterprise, organization, or team
 
-If you currently use the [AUTOTITLE](/rest/copilot/copilot-usage), we recommend migrating to these endpoints as soon as possible.
-
 For help getting started, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/analyzing-usage-over-time-with-the-copilot-metrics-api).
 
 {% data reusables.copilot.metrics-api-ghecom %}

content/rest/copilot/copilot-usage.md

@@ -11,7 +11,6 @@ autogenerated: rest
 allowTitleToDifferFromFilename: true
 children:
   - /copilot-metrics
-  - /copilot-usage
   - /copilot-user-management
 versions:
   fpt: '*'

content/rest/copilot/index.md

@@ -486,15 +486,6 @@
         "additional-permissions": true,
         "access": "read"
       },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/copilot/usage",
-        "additional-permissions": true,
-        "access": "read"
-      },
       {
         "category": "orgs",
         "slug": "list-app-installations-for-an-organization",
@@ -684,15 +675,6 @@
         "additional-permissions": true,
         "access": "read"
       },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-a-team",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage",
-        "additional-permissions": true,
-        "access": "read"
-      },
       {
         "category": "orgs",
         "slug": "enable-or-disable-a-security-feature-for-an-organization",
@@ -921,15 +903,6 @@
         "additional-permissions": true,
         "access": "read"
       },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/copilot/usage",
-        "additional-permissions": true,
-        "access": "read"
-      },
       {
         "category": "copilot",
         "slug": "get-copilot-seat-assignment-details-for-a-user",
@@ -947,15 +920,6 @@
         "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",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage",
-        "additional-permissions": true,
-        "access": "read"
       }
     ]
   },
@@ -2805,15 +2769,6 @@
         "additional-permissions": false,
         "access": "read"
       },
-      {
-        "category": "actions",
-        "slug": "review-pending-deployments-for-a-workflow-run",
-        "subcategory": "workflow-runs",
-        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
-        "additional-permissions": true,
-        "access": "read"
-      },
       {
         "category": "actions",
         "slug": "re-run-a-workflow",
@@ -4065,15 +4020,6 @@
     "title": "Checks",
     "displayTitle": "Repository permissions for \"Checks\"",
     "permissions": [
-      {
-        "category": "actions",
-        "slug": "review-pending-deployments-for-a-workflow-run",
-        "subcategory": "workflow-runs",
-        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
-        "additional-permissions": true,
-        "access": "read"
-      },
       {
         "category": "checks",
         "slug": "create-a-check-run",
@@ -5397,8 +5343,8 @@
         "subcategory": "workflow-runs",
         "verb": "post",
         "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
-        "additional-permissions": true,
-        "access": "read"
+        "additional-permissions": false,
+        "access": "write"
       },
       {
         "category": "deployments",

src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json

@@ -2126,12 +2126,6 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/copilot/metrics"
     },
-    {
-      "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-      "subcategory": "copilot-usage",
-      "verb": "get",
-      "requestPath": "/orgs/{org}/copilot/usage"
-    },
     {
       "slug": "get-copilot-seat-assignment-details-for-a-user",
       "subcategory": "copilot-user-management",
@@ -2143,12 +2137,6 @@
       "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",
-      "verb": "get",
-      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage"
     }
   ],
   "dependabot": [

src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json

@@ -592,17 +592,6 @@
         "server-to-server": true,
         "additional-permissions": true
       },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/copilot/usage",
-        "access": "read",
-        "user-to-server": true,
-        "server-to-server": true,
-        "additional-permissions": true
-      },
       {
         "category": "orgs",
         "slug": "list-app-installations-for-an-organization",
@@ -834,17 +823,6 @@
         "server-to-server": true,
         "additional-permissions": true
       },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-a-team",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage",
-        "access": "read",
-        "user-to-server": true,
-        "server-to-server": true,
-        "additional-permissions": true
-      },
       {
         "category": "orgs",
         "slug": "enable-or-disable-a-security-feature-for-an-organization",
@@ -1117,17 +1095,6 @@
         "server-to-server": true,
         "additional-permissions": true
       },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/copilot/usage",
-        "access": "read",
-        "user-to-server": true,
-        "server-to-server": true,
-        "additional-permissions": true
-      },
       {
         "category": "copilot",
         "slug": "get-copilot-seat-assignment-details-for-a-user",
@@ -1149,17 +1116,6 @@
         "user-to-server": true,
         "server-to-server": true,
         "additional-permissions": true
-      },
-      {
-        "category": "copilot",
-        "slug": "get-a-summary-of-copilot-usage-for-a-team",
-        "subcategory": "copilot-usage",
-        "verb": "get",
-        "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage",
-        "access": "read",
-        "user-to-server": true,
-        "server-to-server": true,
-        "additional-permissions": true
       }
     ]
   },
@@ -3397,17 +3353,6 @@
         "server-to-server": true,
         "additional-permissions": false
       },
-      {
-        "category": "actions",
-        "slug": "review-pending-deployments-for-a-workflow-run",
-        "subcategory": "workflow-runs",
-        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
-        "access": "read",
-        "user-to-server": true,
-        "server-to-server": true,
-        "additional-permissions": true
-      },
       {
         "category": "actions",
         "slug": "re-run-a-workflow",
@@ -4933,17 +4878,6 @@
     "title": "Checks",
     "displayTitle": "Repository permissions for \"Checks\"",
     "permissions": [
-      {
-        "category": "actions",
-        "slug": "review-pending-deployments-for-a-workflow-run",
-        "subcategory": "workflow-runs",
-        "verb": "post",
-        "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
-        "access": "read",
-        "user-to-server": true,
-        "server-to-server": true,
-        "additional-permissions": true
-      },
       {
         "category": "checks",
         "slug": "create-a-check-run",
@@ -6556,10 +6490,10 @@
         "subcategory": "workflow-runs",
         "verb": "post",
         "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments",
-        "access": "read",
+        "access": "write",
         "user-to-server": true,
         "server-to-server": true,
-        "additional-permissions": true
+        "additional-permissions": false
       },
       {
         "category": "deployments",

src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json

@@ -1860,12 +1860,6 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/copilot/metrics"
     },
-    {
-      "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-      "subcategory": "copilot-usage",
-      "verb": "get",
-      "requestPath": "/orgs/{org}/copilot/usage"
-    },
     {
       "slug": "get-copilot-seat-assignment-details-for-a-user",
       "subcategory": "copilot-user-management",
@@ -1877,12 +1871,6 @@
       "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",
-      "verb": "get",
-      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage"
     }
   ],
   "dependabot": [

src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json

@@ -2126,12 +2126,6 @@
       "verb": "get",
       "requestPath": "/orgs/{org}/copilot/metrics"
     },
-    {
-      "slug": "get-a-summary-of-copilot-usage-for-organization-members",
-      "subcategory": "copilot-usage",
-      "verb": "get",
-      "requestPath": "/orgs/{org}/copilot/usage"
-    },
     {
       "slug": "get-copilot-seat-assignment-details-for-a-user",
       "subcategory": "copilot-user-management",
@@ -2143,12 +2137,6 @@
       "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",
-      "verb": "get",
-      "requestPath": "/orgs/{org}/team/{team_slug}/copilot/usage"
     }
   ],
   "dependabot": [