Skip to content

Commit 6142b84

Browse files
docs-botmchammer01
docs-bot
and
mchammer01
authored
Update OpenAPI Description (#60488)
Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
1 parent 836fb8f commit 6142b84

File tree

100 files changed

+6142
-262
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+6142
-262
lines changed

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
---
22
title: REST API endpoints for Copilot usage metrics
33
shortTitle: Copilot usage metrics
4-
intro: Use the REST API to view {% data variables.product.prodname_copilot_short %} usage metrics.
4+
intro: >-
5+
Use the REST API to view {% data variables.product.prodname_copilot_short %}
6+
usage metrics.
57
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
8+
fpt: '*'
69
ghec: '*'
710
autogenerated: rest
811
allowTitleToDifferFromFilename: true

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

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2096,6 +2096,48 @@
20962096
}
20972097
]
20982098
},
2099+
"organization_copilot_metrics": {
2100+
"title": "Organization Copilot metrics",
2101+
"displayTitle": "Organization permissions for \"Organization Copilot metrics\"",
2102+
"permissions": [
2103+
{
2104+
"category": "copilot",
2105+
"slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
2106+
"subcategory": "copilot-usage-metrics",
2107+
"verb": "get",
2108+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day",
2109+
"additional-permissions": false,
2110+
"access": "read"
2111+
},
2112+
{
2113+
"category": "copilot",
2114+
"slug": "get-copilot-organization-usage-metrics",
2115+
"subcategory": "copilot-usage-metrics",
2116+
"verb": "get",
2117+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest",
2118+
"additional-permissions": false,
2119+
"access": "read"
2120+
},
2121+
{
2122+
"category": "copilot",
2123+
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
2124+
"subcategory": "copilot-usage-metrics",
2125+
"verb": "get",
2126+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day",
2127+
"additional-permissions": false,
2128+
"access": "read"
2129+
},
2130+
{
2131+
"category": "copilot",
2132+
"slug": "get-copilot-organization-users-usage-metrics",
2133+
"subcategory": "copilot-usage-metrics",
2134+
"verb": "get",
2135+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest",
2136+
"additional-permissions": false,
2137+
"access": "read"
2138+
}
2139+
]
2140+
},
20992141
"organization_codespaces_secrets": {
21002142
"title": "Organization codespaces secrets",
21012143
"displayTitle": "Organization permissions for \"Organization codespaces secrets\"",

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

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2222,6 +2222,30 @@
22222222
"verb": "get",
22232223
"requestPath": "/orgs/{org}/copilot/metrics"
22242224
},
2225+
{
2226+
"slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
2227+
"subcategory": "copilot-usage-metrics",
2228+
"verb": "get",
2229+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day"
2230+
},
2231+
{
2232+
"slug": "get-copilot-organization-usage-metrics",
2233+
"subcategory": "copilot-usage-metrics",
2234+
"verb": "get",
2235+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
2236+
},
2237+
{
2238+
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
2239+
"subcategory": "copilot-usage-metrics",
2240+
"verb": "get",
2241+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day"
2242+
},
2243+
{
2244+
"slug": "get-copilot-organization-users-usage-metrics",
2245+
"subcategory": "copilot-usage-metrics",
2246+
"verb": "get",
2247+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest"
2248+
},
22252249
{
22262250
"slug": "get-copilot-seat-assignment-details-for-a-user",
22272251
"subcategory": "copilot-user-management",

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

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,54 @@
11
{
2+
"enterprise_copilot_metrics": {
3+
"title": "Enterprise Copilot metrics",
4+
"displayTitle": "Enterprise permissions for \"Enterprise Copilot metrics\"",
5+
"permissions": [
6+
{
7+
"category": "copilot",
8+
"slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day",
9+
"subcategory": "copilot-usage-metrics",
10+
"verb": "get",
11+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day",
12+
"access": "read",
13+
"user-to-server": true,
14+
"server-to-server": true,
15+
"additional-permissions": false
16+
},
17+
{
18+
"category": "copilot",
19+
"slug": "get-copilot-enterprise-usage-metrics",
20+
"subcategory": "copilot-usage-metrics",
21+
"verb": "get",
22+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest",
23+
"access": "read",
24+
"user-to-server": true,
25+
"server-to-server": true,
26+
"additional-permissions": false
27+
},
28+
{
29+
"category": "copilot",
30+
"slug": "get-copilot-users-usage-metrics-for-a-specific-day",
31+
"subcategory": "copilot-usage-metrics",
32+
"verb": "get",
33+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day",
34+
"access": "read",
35+
"user-to-server": true,
36+
"server-to-server": true,
37+
"additional-permissions": false
38+
},
39+
{
40+
"category": "copilot",
41+
"slug": "get-copilot-users-usage-metrics",
42+
"subcategory": "copilot-usage-metrics",
43+
"verb": "get",
44+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest",
45+
"access": "read",
46+
"user-to-server": true,
47+
"server-to-server": true,
48+
"additional-permissions": false
49+
}
50+
]
51+
},
252
"enterprise_teams": {
353
"title": "Enterprise teams",
454
"displayTitle": "Enterprise permissions for \"Enterprise teams\"",
@@ -2735,6 +2785,56 @@
27352785
}
27362786
]
27372787
},
2788+
"organization_copilot_metrics": {
2789+
"title": "Organization Copilot metrics",
2790+
"displayTitle": "Organization permissions for \"Organization Copilot metrics\"",
2791+
"permissions": [
2792+
{
2793+
"category": "copilot",
2794+
"slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
2795+
"subcategory": "copilot-usage-metrics",
2796+
"verb": "get",
2797+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day",
2798+
"access": "read",
2799+
"user-to-server": true,
2800+
"server-to-server": true,
2801+
"additional-permissions": false
2802+
},
2803+
{
2804+
"category": "copilot",
2805+
"slug": "get-copilot-organization-usage-metrics",
2806+
"subcategory": "copilot-usage-metrics",
2807+
"verb": "get",
2808+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest",
2809+
"access": "read",
2810+
"user-to-server": true,
2811+
"server-to-server": true,
2812+
"additional-permissions": false
2813+
},
2814+
{
2815+
"category": "copilot",
2816+
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
2817+
"subcategory": "copilot-usage-metrics",
2818+
"verb": "get",
2819+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day",
2820+
"access": "read",
2821+
"user-to-server": true,
2822+
"server-to-server": true,
2823+
"additional-permissions": false
2824+
},
2825+
{
2826+
"category": "copilot",
2827+
"slug": "get-copilot-organization-users-usage-metrics",
2828+
"subcategory": "copilot-usage-metrics",
2829+
"verb": "get",
2830+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest",
2831+
"access": "read",
2832+
"user-to-server": true,
2833+
"server-to-server": true,
2834+
"additional-permissions": false
2835+
}
2836+
]
2837+
},
27382838
"organization_codespaces_secrets": {
27392839
"title": "Organization codespaces secrets",
27402840
"displayTitle": "Organization permissions for \"Organization codespaces secrets\"",

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2120,6 +2120,30 @@
21202120
}
21212121
],
21222122
"copilot": [
2123+
{
2124+
"slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day",
2125+
"subcategory": "copilot-usage-metrics",
2126+
"verb": "get",
2127+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day"
2128+
},
2129+
{
2130+
"slug": "get-copilot-enterprise-usage-metrics",
2131+
"subcategory": "copilot-usage-metrics",
2132+
"verb": "get",
2133+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest"
2134+
},
2135+
{
2136+
"slug": "get-copilot-users-usage-metrics-for-a-specific-day",
2137+
"subcategory": "copilot-usage-metrics",
2138+
"verb": "get",
2139+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day"
2140+
},
2141+
{
2142+
"slug": "get-copilot-users-usage-metrics",
2143+
"subcategory": "copilot-usage-metrics",
2144+
"verb": "get",
2145+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest"
2146+
},
21232147
{
21242148
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
21252149
"subcategory": "copilot-user-management",
@@ -2210,6 +2234,30 @@
22102234
"verb": "get",
22112235
"requestPath": "/orgs/{org}/copilot/metrics"
22122236
},
2237+
{
2238+
"slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
2239+
"subcategory": "copilot-usage-metrics",
2240+
"verb": "get",
2241+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day"
2242+
},
2243+
{
2244+
"slug": "get-copilot-organization-usage-metrics",
2245+
"subcategory": "copilot-usage-metrics",
2246+
"verb": "get",
2247+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
2248+
},
2249+
{
2250+
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
2251+
"subcategory": "copilot-usage-metrics",
2252+
"verb": "get",
2253+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day"
2254+
},
2255+
{
2256+
"slug": "get-copilot-organization-users-usage-metrics",
2257+
"subcategory": "copilot-usage-metrics",
2258+
"verb": "get",
2259+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest"
2260+
},
22132261
{
22142262
"slug": "get-copilot-seat-assignment-details-for-a-user",
22152263
"subcategory": "copilot-user-management",

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2386,6 +2386,30 @@
23862386
}
23872387
],
23882388
"copilot": [
2389+
{
2390+
"slug": "get-copilot-enterprise-usage-metrics-for-a-specific-day",
2391+
"subcategory": "copilot-usage-metrics",
2392+
"verb": "get",
2393+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-1-day"
2394+
},
2395+
{
2396+
"slug": "get-copilot-enterprise-usage-metrics",
2397+
"subcategory": "copilot-usage-metrics",
2398+
"verb": "get",
2399+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest"
2400+
},
2401+
{
2402+
"slug": "get-copilot-users-usage-metrics-for-a-specific-day",
2403+
"subcategory": "copilot-usage-metrics",
2404+
"verb": "get",
2405+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day"
2406+
},
2407+
{
2408+
"slug": "get-copilot-users-usage-metrics",
2409+
"subcategory": "copilot-usage-metrics",
2410+
"verb": "get",
2411+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest"
2412+
},
23892413
{
23902414
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
23912415
"subcategory": "copilot-user-management",
@@ -2476,6 +2500,30 @@
24762500
"verb": "get",
24772501
"requestPath": "/orgs/{org}/copilot/metrics"
24782502
},
2503+
{
2504+
"slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
2505+
"subcategory": "copilot-usage-metrics",
2506+
"verb": "get",
2507+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day"
2508+
},
2509+
{
2510+
"slug": "get-copilot-organization-usage-metrics",
2511+
"subcategory": "copilot-usage-metrics",
2512+
"verb": "get",
2513+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
2514+
},
2515+
{
2516+
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
2517+
"subcategory": "copilot-usage-metrics",
2518+
"verb": "get",
2519+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day"
2520+
},
2521+
{
2522+
"slug": "get-copilot-organization-users-usage-metrics",
2523+
"subcategory": "copilot-usage-metrics",
2524+
"verb": "get",
2525+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest"
2526+
},
24792527
{
24802528
"slug": "get-copilot-seat-assignment-details-for-a-user",
24812529
"subcategory": "copilot-user-management",

‎src/github-apps/data/fpt-2026-03-10/fine-grained-pat-permissions.json‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2096,6 +2096,48 @@
20962096
}
20972097
]
20982098
},
2099+
"organization_copilot_metrics": {
2100+
"title": "Organization Copilot metrics",
2101+
"displayTitle": "Organization permissions for \"Organization Copilot metrics\"",
2102+
"permissions": [
2103+
{
2104+
"category": "copilot",
2105+
"slug": "get-copilot-organization-usage-metrics-for-a-specific-day",
2106+
"subcategory": "copilot-usage-metrics",
2107+
"verb": "get",
2108+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-1-day",
2109+
"additional-permissions": false,
2110+
"access": "read"
2111+
},
2112+
{
2113+
"category": "copilot",
2114+
"slug": "get-copilot-organization-usage-metrics",
2115+
"subcategory": "copilot-usage-metrics",
2116+
"verb": "get",
2117+
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest",
2118+
"additional-permissions": false,
2119+
"access": "read"
2120+
},
2121+
{
2122+
"category": "copilot",
2123+
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
2124+
"subcategory": "copilot-usage-metrics",
2125+
"verb": "get",
2126+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-1-day",
2127+
"additional-permissions": false,
2128+
"access": "read"
2129+
},
2130+
{
2131+
"category": "copilot",
2132+
"slug": "get-copilot-organization-users-usage-metrics",
2133+
"subcategory": "copilot-usage-metrics",
2134+
"verb": "get",
2135+
"requestPath": "/orgs/{org}/copilot/metrics/reports/users-28-day/latest",
2136+
"additional-permissions": false,
2137+
"access": "read"
2138+
}
2139+
]
2140+
},
20992141
"organization_codespaces_secrets": {
21002142
"title": "Organization codespaces secrets",
21012143
"displayTitle": "Organization permissions for \"Organization codespaces secrets\"",

0 commit comments

Comments
 (0)