Skip to content

Commit 0a0806c

Browse files
docs-botsunbrye
docs-bot
and
sunbrye
authored
Update OpenAPI Description (#52910)
Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
1 parent 4f1b56e commit 0a0806c

File tree

22 files changed

+4989
-10
lines changed

22 files changed

+4989
-10
lines changed

‎content/rest/copilot/copilot-metrics.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: REST API endpoints for Copilot metrics
3+
shortTitle: Copilot metrics
4+
intro: Use the REST API to view Copilot metrics.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
topics:
9+
- API
10+
autogenerated: rest
11+
allowTitleToDifferFromFilename: true
12+
---
13+
14+
<!-- Content after this section is automatically generated -->

‎content/rest/copilot/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ topics:
1010
autogenerated: rest
1111
allowTitleToDifferFromFilename: true
1212
children:
13+
- /copilot-metrics
1314
- /copilot-usage
1415
- /copilot-user-management
1516
versions:

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -291,6 +291,15 @@
291291
"additional-permissions": true,
292292
"access": "write"
293293
},
294+
{
295+
"category": "copilot",
296+
"slug": "get-copilot-metrics-for-an-organization",
297+
"subcategory": "copilot-metrics",
298+
"verb": "get",
299+
"requestPath": "/orgs/{org}/copilot/metrics",
300+
"additional-permissions": true,
301+
"access": "read"
302+
},
294303
{
295304
"category": "copilot",
296305
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -462,6 +471,15 @@
462471
"additional-permissions": false,
463472
"access": "read"
464473
},
474+
{
475+
"category": "copilot",
476+
"slug": "get-copilot-metrics-for-a-team",
477+
"subcategory": "copilot-metrics",
478+
"verb": "get",
479+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
480+
"additional-permissions": true,
481+
"access": "read"
482+
},
465483
{
466484
"category": "copilot",
467485
"slug": "get-a-summary-of-copilot-usage-for-a-team",
@@ -690,6 +708,15 @@
690708
"additional-permissions": true,
691709
"access": "write"
692710
},
711+
{
712+
"category": "copilot",
713+
"slug": "get-copilot-metrics-for-an-organization",
714+
"subcategory": "copilot-metrics",
715+
"verb": "get",
716+
"requestPath": "/orgs/{org}/copilot/metrics",
717+
"additional-permissions": true,
718+
"access": "read"
719+
},
693720
{
694721
"category": "copilot",
695722
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -708,6 +735,15 @@
708735
"additional-permissions": true,
709736
"access": "read"
710737
},
738+
{
739+
"category": "copilot",
740+
"slug": "get-copilot-metrics-for-a-team",
741+
"subcategory": "copilot-metrics",
742+
"verb": "get",
743+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
744+
"additional-permissions": true,
745+
"access": "read"
746+
},
711747
{
712748
"category": "copilot",
713749
"slug": "get-a-summary-of-copilot-usage-for-a-team",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2030,6 +2030,12 @@
20302030
"verb": "delete",
20312031
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
20322032
},
2033+
{
2034+
"slug": "get-copilot-metrics-for-an-organization",
2035+
"subcategory": "copilot-metrics",
2036+
"verb": "get",
2037+
"requestPath": "/orgs/{org}/copilot/metrics"
2038+
},
20332039
{
20342040
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
20352041
"subcategory": "copilot-usage",
@@ -2042,6 +2048,12 @@
20422048
"verb": "get",
20432049
"requestPath": "/orgs/{org}/members/{username}/copilot"
20442050
},
2051+
{
2052+
"slug": "get-copilot-metrics-for-a-team",
2053+
"subcategory": "copilot-metrics",
2054+
"verb": "get",
2055+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
2056+
},
20452057
{
20462058
"slug": "get-a-summary-of-copilot-usage-for-a-team",
20472059
"subcategory": "copilot-usage",

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,17 @@
1414
"server-to-server": false,
1515
"additional-permissions": false
1616
},
17+
{
18+
"category": "copilot",
19+
"slug": "get-copilot-metrics-for-an-enterprise",
20+
"subcategory": "copilot-metrics",
21+
"verb": "get",
22+
"requestPath": "/enterprises/{enterprise}/copilot/metrics",
23+
"access": "read",
24+
"user-to-server": false,
25+
"server-to-server": false,
26+
"additional-permissions": false
27+
},
1728
{
1829
"category": "copilot",
1930
"slug": "get-a-summary-of-copilot-usage-for-enterprise-members",
@@ -25,6 +36,17 @@
2536
"server-to-server": false,
2637
"additional-permissions": false
2738
},
39+
{
40+
"category": "copilot",
41+
"slug": "get-copilot-metrics-for-an-enterprise-team",
42+
"subcategory": "copilot-metrics",
43+
"verb": "get",
44+
"requestPath": "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics",
45+
"access": "read",
46+
"user-to-server": false,
47+
"server-to-server": false,
48+
"additional-permissions": false
49+
},
2850
{
2951
"category": "copilot",
3052
"slug": "get-a-summary-of-copilot-usage-for-an-enterprise-team",
@@ -394,6 +416,17 @@
394416
"server-to-server": true,
395417
"additional-permissions": true
396418
},
419+
{
420+
"category": "copilot",
421+
"slug": "get-copilot-metrics-for-an-organization",
422+
"subcategory": "copilot-metrics",
423+
"verb": "get",
424+
"requestPath": "/orgs/{org}/copilot/metrics",
425+
"access": "read",
426+
"user-to-server": true,
427+
"server-to-server": true,
428+
"additional-permissions": true
429+
},
397430
{
398431
"category": "copilot",
399432
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -603,6 +636,17 @@
603636
"server-to-server": true,
604637
"additional-permissions": false
605638
},
639+
{
640+
"category": "copilot",
641+
"slug": "get-copilot-metrics-for-a-team",
642+
"subcategory": "copilot-metrics",
643+
"verb": "get",
644+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
645+
"access": "read",
646+
"user-to-server": true,
647+
"server-to-server": true,
648+
"additional-permissions": true
649+
},
606650
{
607651
"category": "copilot",
608652
"slug": "get-a-summary-of-copilot-usage-for-a-team",
@@ -875,6 +919,17 @@
875919
"server-to-server": true,
876920
"additional-permissions": true
877921
},
922+
{
923+
"category": "copilot",
924+
"slug": "get-copilot-metrics-for-an-organization",
925+
"subcategory": "copilot-metrics",
926+
"verb": "get",
927+
"requestPath": "/orgs/{org}/copilot/metrics",
928+
"access": "read",
929+
"user-to-server": true,
930+
"server-to-server": true,
931+
"additional-permissions": true
932+
},
878933
{
879934
"category": "copilot",
880935
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -897,6 +952,17 @@
897952
"server-to-server": true,
898953
"additional-permissions": true
899954
},
955+
{
956+
"category": "copilot",
957+
"slug": "get-copilot-metrics-for-a-team",
958+
"subcategory": "copilot-metrics",
959+
"verb": "get",
960+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
961+
"access": "read",
962+
"user-to-server": true,
963+
"server-to-server": true,
964+
"additional-permissions": true
965+
},
900966
{
901967
"category": "copilot",
902968
"slug": "get-a-summary-of-copilot-usage-for-a-team",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1758,6 +1758,12 @@
17581758
"verb": "delete",
17591759
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
17601760
},
1761+
{
1762+
"slug": "get-copilot-metrics-for-an-organization",
1763+
"subcategory": "copilot-metrics",
1764+
"verb": "get",
1765+
"requestPath": "/orgs/{org}/copilot/metrics"
1766+
},
17611767
{
17621768
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
17631769
"subcategory": "copilot-usage",
@@ -1770,6 +1776,12 @@
17701776
"verb": "get",
17711777
"requestPath": "/orgs/{org}/members/{username}/copilot"
17721778
},
1779+
{
1780+
"slug": "get-copilot-metrics-for-a-team",
1781+
"subcategory": "copilot-metrics",
1782+
"verb": "get",
1783+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
1784+
},
17731785
{
17741786
"slug": "get-a-summary-of-copilot-usage-for-a-team",
17751787
"subcategory": "copilot-usage",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2030,6 +2030,12 @@
20302030
"verb": "delete",
20312031
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
20322032
},
2033+
{
2034+
"slug": "get-copilot-metrics-for-an-organization",
2035+
"subcategory": "copilot-metrics",
2036+
"verb": "get",
2037+
"requestPath": "/orgs/{org}/copilot/metrics"
2038+
},
20332039
{
20342040
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
20352041
"subcategory": "copilot-usage",
@@ -2042,6 +2048,12 @@
20422048
"verb": "get",
20432049
"requestPath": "/orgs/{org}/members/{username}/copilot"
20442050
},
2051+
{
2052+
"slug": "get-copilot-metrics-for-a-team",
2053+
"subcategory": "copilot-metrics",
2054+
"verb": "get",
2055+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
2056+
},
20452057
{
20462058
"slug": "get-a-summary-of-copilot-usage-for-a-team",
20472059
"subcategory": "copilot-usage",

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -522,6 +522,15 @@
522522
"additional-permissions": true,
523523
"access": "write"
524524
},
525+
{
526+
"category": "copilot",
527+
"slug": "get-copilot-metrics-for-an-organization",
528+
"subcategory": "copilot-metrics",
529+
"verb": "get",
530+
"requestPath": "/orgs/{org}/copilot/metrics",
531+
"additional-permissions": true,
532+
"access": "read"
533+
},
525534
{
526535
"category": "copilot",
527536
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -765,6 +774,15 @@
765774
"additional-permissions": false,
766775
"access": "read"
767776
},
777+
{
778+
"category": "copilot",
779+
"slug": "get-copilot-metrics-for-a-team",
780+
"subcategory": "copilot-metrics",
781+
"verb": "get",
782+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
783+
"additional-permissions": true,
784+
"access": "read"
785+
},
768786
{
769787
"category": "copilot",
770788
"slug": "get-a-summary-of-copilot-usage-for-a-team",
@@ -1143,6 +1161,15 @@
11431161
"additional-permissions": true,
11441162
"access": "write"
11451163
},
1164+
{
1165+
"category": "copilot",
1166+
"slug": "get-copilot-metrics-for-an-organization",
1167+
"subcategory": "copilot-metrics",
1168+
"verb": "get",
1169+
"requestPath": "/orgs/{org}/copilot/metrics",
1170+
"additional-permissions": true,
1171+
"access": "read"
1172+
},
11461173
{
11471174
"category": "copilot",
11481175
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
@@ -1161,6 +1188,15 @@
11611188
"additional-permissions": true,
11621189
"access": "read"
11631190
},
1191+
{
1192+
"category": "copilot",
1193+
"slug": "get-copilot-metrics-for-a-team",
1194+
"subcategory": "copilot-metrics",
1195+
"verb": "get",
1196+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics",
1197+
"additional-permissions": true,
1198+
"access": "read"
1199+
},
11641200
{
11651201
"category": "copilot",
11661202
"slug": "get-a-summary-of-copilot-usage-for-a-team",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2068,6 +2068,12 @@
20682068
"verb": "delete",
20692069
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
20702070
},
2071+
{
2072+
"slug": "get-copilot-metrics-for-an-organization",
2073+
"subcategory": "copilot-metrics",
2074+
"verb": "get",
2075+
"requestPath": "/orgs/{org}/copilot/metrics"
2076+
},
20712077
{
20722078
"slug": "get-a-summary-of-copilot-usage-for-organization-members",
20732079
"subcategory": "copilot-usage",
@@ -2080,6 +2086,12 @@
20802086
"verb": "get",
20812087
"requestPath": "/orgs/{org}/members/{username}/copilot"
20822088
},
2089+
{
2090+
"slug": "get-copilot-metrics-for-a-team",
2091+
"subcategory": "copilot-metrics",
2092+
"verb": "get",
2093+
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
2094+
},
20832095
{
20842096
"slug": "get-a-summary-of-copilot-usage-for-a-team",
20852097
"subcategory": "copilot-usage",

0 commit comments

Comments
 (0)