Skip to content

Commit 9972ef4

Browse files
docs-bottimrogerssubatoi
authored
Update OpenAPI Description (#60321)
Co-authored-by: Tim Rogers <me@timrogers.co.uk> Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent ed7ae8d commit 9972ef4

36 files changed

+10496
-355
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: REST API endpoints for Copilot coding agent management
3+
shortTitle: Copilot coding agent management
4+
intro: Use the REST API to manage settings for {% data variables.copilot.copilot_coding_agent %}.
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 -->
15+
16+

content/rest/copilot/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ intro: >-
77
autogenerated: rest
88
allowTitleToDifferFromFilename: true
99
children:
10+
- /copilot-coding-agent-management
1011
- /copilot-content-exclusion-management
1112
- /copilot-custom-agents
1213
- /copilot-metrics

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,6 +1076,66 @@
10761076
}
10771077
]
10781078
},
1079+
"organization_copilot_agent_settings": {
1080+
"title": "Copilot agent settings",
1081+
"displayTitle": "Organization permissions for \"Copilot agent settings\"",
1082+
"permissions": [
1083+
{
1084+
"category": "copilot",
1085+
"slug": "get-copilot-coding-agent-permissions-for-an-organization",
1086+
"subcategory": "copilot-coding-agent-management",
1087+
"verb": "get",
1088+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions",
1089+
"additional-permissions": false,
1090+
"access": "read"
1091+
},
1092+
{
1093+
"category": "copilot",
1094+
"slug": "set-copilot-coding-agent-permissions-for-an-organization",
1095+
"subcategory": "copilot-coding-agent-management",
1096+
"verb": "put",
1097+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions",
1098+
"additional-permissions": false,
1099+
"access": "write"
1100+
},
1101+
{
1102+
"category": "copilot",
1103+
"slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization",
1104+
"subcategory": "copilot-coding-agent-management",
1105+
"verb": "get",
1106+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories",
1107+
"additional-permissions": false,
1108+
"access": "read"
1109+
},
1110+
{
1111+
"category": "copilot",
1112+
"slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization",
1113+
"subcategory": "copilot-coding-agent-management",
1114+
"verb": "put",
1115+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories",
1116+
"additional-permissions": false,
1117+
"access": "write"
1118+
},
1119+
{
1120+
"category": "copilot",
1121+
"slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization",
1122+
"subcategory": "copilot-coding-agent-management",
1123+
"verb": "put",
1124+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}",
1125+
"additional-permissions": true,
1126+
"access": "write"
1127+
},
1128+
{
1129+
"category": "copilot",
1130+
"slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization",
1131+
"subcategory": "copilot-coding-agent-management",
1132+
"verb": "delete",
1133+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}",
1134+
"additional-permissions": true,
1135+
"access": "write"
1136+
}
1137+
]
1138+
},
10791139
"org_copilot_content_exclusion": {
10801140
"title": "Copilot content exclusion",
10811141
"displayTitle": "Organization permissions for \"Copilot content exclusion\"",

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2168,6 +2168,42 @@
21682168
"verb": "delete",
21692169
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
21702170
},
2171+
{
2172+
"slug": "get-copilot-coding-agent-permissions-for-an-organization",
2173+
"subcategory": "copilot-coding-agent-management",
2174+
"verb": "get",
2175+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions"
2176+
},
2177+
{
2178+
"slug": "set-copilot-coding-agent-permissions-for-an-organization",
2179+
"subcategory": "copilot-coding-agent-management",
2180+
"verb": "put",
2181+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions"
2182+
},
2183+
{
2184+
"slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization",
2185+
"subcategory": "copilot-coding-agent-management",
2186+
"verb": "get",
2187+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories"
2188+
},
2189+
{
2190+
"slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization",
2191+
"subcategory": "copilot-coding-agent-management",
2192+
"verb": "put",
2193+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories"
2194+
},
2195+
{
2196+
"slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization",
2197+
"subcategory": "copilot-coding-agent-management",
2198+
"verb": "put",
2199+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"
2200+
},
2201+
{
2202+
"slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization",
2203+
"subcategory": "copilot-coding-agent-management",
2204+
"verb": "delete",
2205+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"
2206+
},
21712207
{
21722208
"slug": "get-copilot-content-exclusion-rules-for-an-organization",
21732209
"subcategory": "copilot-content-exclusion-management",

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

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1503,6 +1503,78 @@
15031503
}
15041504
]
15051505
},
1506+
"organization_copilot_agent_settings": {
1507+
"title": "Copilot agent settings",
1508+
"displayTitle": "Organization permissions for \"Copilot agent settings\"",
1509+
"permissions": [
1510+
{
1511+
"category": "copilot",
1512+
"slug": "get-copilot-coding-agent-permissions-for-an-organization",
1513+
"subcategory": "copilot-coding-agent-management",
1514+
"verb": "get",
1515+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions",
1516+
"access": "read",
1517+
"user-to-server": true,
1518+
"server-to-server": true,
1519+
"additional-permissions": false
1520+
},
1521+
{
1522+
"category": "copilot",
1523+
"slug": "set-copilot-coding-agent-permissions-for-an-organization",
1524+
"subcategory": "copilot-coding-agent-management",
1525+
"verb": "put",
1526+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions",
1527+
"access": "write",
1528+
"user-to-server": true,
1529+
"server-to-server": true,
1530+
"additional-permissions": false
1531+
},
1532+
{
1533+
"category": "copilot",
1534+
"slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization",
1535+
"subcategory": "copilot-coding-agent-management",
1536+
"verb": "get",
1537+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories",
1538+
"access": "read",
1539+
"user-to-server": true,
1540+
"server-to-server": true,
1541+
"additional-permissions": false
1542+
},
1543+
{
1544+
"category": "copilot",
1545+
"slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization",
1546+
"subcategory": "copilot-coding-agent-management",
1547+
"verb": "put",
1548+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories",
1549+
"access": "write",
1550+
"user-to-server": true,
1551+
"server-to-server": true,
1552+
"additional-permissions": false
1553+
},
1554+
{
1555+
"category": "copilot",
1556+
"slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization",
1557+
"subcategory": "copilot-coding-agent-management",
1558+
"verb": "put",
1559+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}",
1560+
"access": "write",
1561+
"user-to-server": true,
1562+
"server-to-server": true,
1563+
"additional-permissions": true
1564+
},
1565+
{
1566+
"category": "copilot",
1567+
"slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization",
1568+
"subcategory": "copilot-coding-agent-management",
1569+
"verb": "delete",
1570+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}",
1571+
"access": "write",
1572+
"user-to-server": true,
1573+
"server-to-server": true,
1574+
"additional-permissions": true
1575+
}
1576+
]
1577+
},
15061578
"org_copilot_content_exclusion": {
15071579
"title": "Copilot content exclusion",
15081580
"displayTitle": "Organization permissions for \"Copilot content exclusion\"",

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2156,6 +2156,42 @@
21562156
"verb": "delete",
21572157
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
21582158
},
2159+
{
2160+
"slug": "get-copilot-coding-agent-permissions-for-an-organization",
2161+
"subcategory": "copilot-coding-agent-management",
2162+
"verb": "get",
2163+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions"
2164+
},
2165+
{
2166+
"slug": "set-copilot-coding-agent-permissions-for-an-organization",
2167+
"subcategory": "copilot-coding-agent-management",
2168+
"verb": "put",
2169+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions"
2170+
},
2171+
{
2172+
"slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization",
2173+
"subcategory": "copilot-coding-agent-management",
2174+
"verb": "get",
2175+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories"
2176+
},
2177+
{
2178+
"slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization",
2179+
"subcategory": "copilot-coding-agent-management",
2180+
"verb": "put",
2181+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories"
2182+
},
2183+
{
2184+
"slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization",
2185+
"subcategory": "copilot-coding-agent-management",
2186+
"verb": "put",
2187+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"
2188+
},
2189+
{
2190+
"slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization",
2191+
"subcategory": "copilot-coding-agent-management",
2192+
"verb": "delete",
2193+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"
2194+
},
21592195
{
21602196
"slug": "get-copilot-content-exclusion-rules-for-an-organization",
21612197
"subcategory": "copilot-content-exclusion-management",

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2422,6 +2422,42 @@
24222422
"verb": "delete",
24232423
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
24242424
},
2425+
{
2426+
"slug": "get-copilot-coding-agent-permissions-for-an-organization",
2427+
"subcategory": "copilot-coding-agent-management",
2428+
"verb": "get",
2429+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions"
2430+
},
2431+
{
2432+
"slug": "set-copilot-coding-agent-permissions-for-an-organization",
2433+
"subcategory": "copilot-coding-agent-management",
2434+
"verb": "put",
2435+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions"
2436+
},
2437+
{
2438+
"slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization",
2439+
"subcategory": "copilot-coding-agent-management",
2440+
"verb": "get",
2441+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories"
2442+
},
2443+
{
2444+
"slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization",
2445+
"subcategory": "copilot-coding-agent-management",
2446+
"verb": "put",
2447+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories"
2448+
},
2449+
{
2450+
"slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization",
2451+
"subcategory": "copilot-coding-agent-management",
2452+
"verb": "put",
2453+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"
2454+
},
2455+
{
2456+
"slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization",
2457+
"subcategory": "copilot-coding-agent-management",
2458+
"verb": "delete",
2459+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}"
2460+
},
24252461
{
24262462
"slug": "get-copilot-content-exclusion-rules-for-an-organization",
24272463
"subcategory": "copilot-content-exclusion-management",

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,6 +1076,66 @@
10761076
}
10771077
]
10781078
},
1079+
"organization_copilot_agent_settings": {
1080+
"title": "Copilot agent settings",
1081+
"displayTitle": "Organization permissions for \"Copilot agent settings\"",
1082+
"permissions": [
1083+
{
1084+
"category": "copilot",
1085+
"slug": "get-copilot-coding-agent-permissions-for-an-organization",
1086+
"subcategory": "copilot-coding-agent-management",
1087+
"verb": "get",
1088+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions",
1089+
"additional-permissions": false,
1090+
"access": "read"
1091+
},
1092+
{
1093+
"category": "copilot",
1094+
"slug": "set-copilot-coding-agent-permissions-for-an-organization",
1095+
"subcategory": "copilot-coding-agent-management",
1096+
"verb": "put",
1097+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions",
1098+
"additional-permissions": false,
1099+
"access": "write"
1100+
},
1101+
{
1102+
"category": "copilot",
1103+
"slug": "list-repositories-enabled-for-copilot-coding-agent-in-an-organization",
1104+
"subcategory": "copilot-coding-agent-management",
1105+
"verb": "get",
1106+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories",
1107+
"additional-permissions": false,
1108+
"access": "read"
1109+
},
1110+
{
1111+
"category": "copilot",
1112+
"slug": "set-selected-repositories-for-copilot-coding-agent-in-an-organization",
1113+
"subcategory": "copilot-coding-agent-management",
1114+
"verb": "put",
1115+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories",
1116+
"additional-permissions": false,
1117+
"access": "write"
1118+
},
1119+
{
1120+
"category": "copilot",
1121+
"slug": "enable-a-repository-for-copilot-coding-agent-in-an-organization",
1122+
"subcategory": "copilot-coding-agent-management",
1123+
"verb": "put",
1124+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}",
1125+
"additional-permissions": true,
1126+
"access": "write"
1127+
},
1128+
{
1129+
"category": "copilot",
1130+
"slug": "disable-a-repository-for-copilot-coding-agent-in-an-organization",
1131+
"subcategory": "copilot-coding-agent-management",
1132+
"verb": "delete",
1133+
"requestPath": "/orgs/{org}/copilot/coding-agent/permissions/repositories/{repository_id}",
1134+
"additional-permissions": true,
1135+
"access": "write"
1136+
}
1137+
]
1138+
},
10791139
"org_copilot_content_exclusion": {
10801140
"title": "Copilot content exclusion",
10811141
"displayTitle": "Organization permissions for \"Copilot content exclusion\"",

0 commit comments

Comments
 (0)