Skip to content

Commit 4840cbd

Browse files
docs-botsunbryeCopilot
authored
Update OpenAPI Description (#61269)
Co-authored-by: sunbrye <sunbrye@github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com>
1 parent 7d3baf7 commit 4840cbd

167 files changed

Lines changed: 23526 additions & 21154 deletions

File tree

Some content is hidden

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

‎content/rest/copilot/copilot-cloud-agent-management.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: REST API endpoints for Copilot cloud agent repository management
3+
shortTitle: Cloud agent repository management
4+
intro: 'Use the REST API to manage repository-level settings for {% data variables.copilot.copilot_cloud_agent %}.'
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
autogenerated: rest
9+
allowTitleToDifferFromFilename: true
10+
---
11+
12+
<!-- 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
@@ -7,6 +7,7 @@ intro: >-
77
autogenerated: rest
88
allowTitleToDifferFromFilename: true
99
children:
10+
- /copilot-cloud-agent-management
1011
- /copilot-coding-agent-management
1112
- /copilot-content-exclusion-management
1213
- /copilot-custom-agents

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

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2424,6 +2424,15 @@
24242424
"additional-permissions": false,
24252425
"access": "read"
24262426
},
2427+
{
2428+
"category": "copilot",
2429+
"slug": "get-copilot-organization-user-teams-report-for-a-specific-day",
2430+
"subcategory": "copilot-usage-metrics",
2431+
"verb": "get",
2432+
"requestPath": "/orgs/{org}/copilot/metrics/reports/user-teams-1-day",
2433+
"additional-permissions": false,
2434+
"access": "read"
2435+
},
24272436
{
24282437
"category": "copilot",
24292438
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
@@ -6402,7 +6411,16 @@
64026411
"subcategory": "releases",
64036412
"verb": "patch",
64046413
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
6405-
"additional-permissions": false,
6414+
"additional-permissions": true,
6415+
"access": "write"
6416+
},
6417+
{
6418+
"category": "releases",
6419+
"slug": "update-a-release",
6420+
"subcategory": "releases",
6421+
"verb": "patch",
6422+
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
6423+
"additional-permissions": true,
64066424
"access": "write"
64076425
},
64086426
{
@@ -6461,6 +6479,21 @@
64616479
}
64626480
]
64636481
},
6482+
"copilot_agent_settings": {
6483+
"title": "Copilot agent settings",
6484+
"displayTitle": "Repository permissions for \"Copilot agent settings\"",
6485+
"permissions": [
6486+
{
6487+
"category": "copilot",
6488+
"slug": "get-copilot-cloud-agent-configuration-for-a-repository",
6489+
"subcategory": "copilot-cloud-agent-management",
6490+
"verb": "get",
6491+
"requestPath": "/repos/{owner}/{repo}/copilot/cloud-agent/configuration",
6492+
"additional-permissions": false,
6493+
"access": "read"
6494+
}
6495+
]
6496+
},
64646497
"repository_custom_properties": {
64656498
"title": "Custom properties",
64666499
"displayTitle": "Repository permissions for \"Custom properties\"",
@@ -8115,24 +8148,6 @@
81158148
"additional-permissions": false,
81168149
"access": "write"
81178150
},
8118-
{
8119-
"category": "pulls",
8120-
"slug": "archive-a-pull-request",
8121-
"subcategory": "pulls",
8122-
"verb": "put",
8123-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive",
8124-
"additional-permissions": false,
8125-
"access": "write"
8126-
},
8127-
{
8128-
"category": "pulls",
8129-
"slug": "unarchive-a-pull-request",
8130-
"subcategory": "pulls",
8131-
"verb": "delete",
8132-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive",
8133-
"additional-permissions": false,
8134-
"access": "write"
8135-
},
81368151
{
81378152
"category": "pulls",
81388153
"slug": "list-review-comments-on-a-pull-request",
@@ -8717,6 +8732,15 @@
87178732
"requestPath": "/repos/{owner}/{repo}/releases",
87188733
"additional-permissions": true,
87198734
"access": "write"
8735+
},
8736+
{
8737+
"category": "releases",
8738+
"slug": "update-a-release",
8739+
"subcategory": "releases",
8740+
"verb": "patch",
8741+
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
8742+
"additional-permissions": true,
8743+
"access": "write"
87208744
}
87218745
]
87228746
},

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

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2434,6 +2434,12 @@
24342434
"verb": "get",
24352435
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
24362436
},
2437+
{
2438+
"slug": "get-copilot-organization-user-teams-report-for-a-specific-day",
2439+
"subcategory": "copilot-usage-metrics",
2440+
"verb": "get",
2441+
"requestPath": "/orgs/{org}/copilot/metrics/reports/user-teams-1-day"
2442+
},
24372443
{
24382444
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
24392445
"subcategory": "copilot-usage-metrics",
@@ -2457,6 +2463,12 @@
24572463
"subcategory": "copilot-metrics",
24582464
"verb": "get",
24592465
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
2466+
},
2467+
{
2468+
"slug": "get-copilot-cloud-agent-configuration-for-a-repository",
2469+
"subcategory": "copilot-cloud-agent-management",
2470+
"verb": "get",
2471+
"requestPath": "/repos/{owner}/{repo}/copilot/cloud-agent/configuration"
24602472
}
24612473
],
24622474
"copilot-spaces": [
@@ -4390,18 +4402,6 @@
43904402
"verb": "patch",
43914403
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}"
43924404
},
4393-
{
4394-
"slug": "archive-a-pull-request",
4395-
"subcategory": "pulls",
4396-
"verb": "put",
4397-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive"
4398-
},
4399-
{
4400-
"slug": "unarchive-a-pull-request",
4401-
"subcategory": "pulls",
4402-
"verb": "delete",
4403-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive"
4404-
},
44054405
{
44064406
"slug": "list-review-comments-on-a-pull-request",
44074407
"subcategory": "comments",

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

Lines changed: 62 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@
2525
"server-to-server": true,
2626
"additional-permissions": false
2727
},
28+
{
29+
"category": "copilot",
30+
"slug": "get-copilot-enterprise-user-teams-report-for-a-specific-day",
31+
"subcategory": "copilot-usage-metrics",
32+
"verb": "get",
33+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day",
34+
"access": "read",
35+
"user-to-server": true,
36+
"server-to-server": true,
37+
"additional-permissions": false
38+
},
2839
{
2940
"category": "copilot",
3041
"slug": "get-copilot-users-usage-metrics-for-a-specific-day",
@@ -3181,6 +3192,17 @@
31813192
"server-to-server": true,
31823193
"additional-permissions": false
31833194
},
3195+
{
3196+
"category": "copilot",
3197+
"slug": "get-copilot-organization-user-teams-report-for-a-specific-day",
3198+
"subcategory": "copilot-usage-metrics",
3199+
"verb": "get",
3200+
"requestPath": "/orgs/{org}/copilot/metrics/reports/user-teams-1-day",
3201+
"access": "read",
3202+
"user-to-server": true,
3203+
"server-to-server": true,
3204+
"additional-permissions": false
3205+
},
31843206
{
31853207
"category": "copilot",
31863208
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
@@ -8274,7 +8296,18 @@
82748296
"access": "write",
82758297
"user-to-server": true,
82768298
"server-to-server": true,
8277-
"additional-permissions": false
8299+
"additional-permissions": true
8300+
},
8301+
{
8302+
"category": "releases",
8303+
"slug": "update-a-release",
8304+
"subcategory": "releases",
8305+
"verb": "patch",
8306+
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
8307+
"access": "write",
8308+
"user-to-server": true,
8309+
"server-to-server": true,
8310+
"additional-permissions": true
82788311
},
82798312
{
82808313
"category": "releases",
@@ -8344,6 +8377,23 @@
83448377
}
83458378
]
83468379
},
8380+
"copilot_agent_settings": {
8381+
"title": "Copilot agent settings",
8382+
"displayTitle": "Repository permissions for \"Copilot agent settings\"",
8383+
"permissions": [
8384+
{
8385+
"category": "copilot",
8386+
"slug": "get-copilot-cloud-agent-configuration-for-a-repository",
8387+
"subcategory": "copilot-cloud-agent-management",
8388+
"verb": "get",
8389+
"requestPath": "/repos/{owner}/{repo}/copilot/cloud-agent/configuration",
8390+
"access": "read",
8391+
"user-to-server": true,
8392+
"server-to-server": true,
8393+
"additional-permissions": false
8394+
}
8395+
]
8396+
},
83478397
"repository_custom_properties": {
83488398
"title": "Custom properties",
83498399
"displayTitle": "Repository permissions for \"Custom properties\"",
@@ -10376,28 +10426,6 @@
1037610426
"server-to-server": true,
1037710427
"additional-permissions": false
1037810428
},
10379-
{
10380-
"category": "pulls",
10381-
"slug": "archive-a-pull-request",
10382-
"subcategory": "pulls",
10383-
"verb": "put",
10384-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive",
10385-
"access": "write",
10386-
"user-to-server": true,
10387-
"server-to-server": true,
10388-
"additional-permissions": false
10389-
},
10390-
{
10391-
"category": "pulls",
10392-
"slug": "unarchive-a-pull-request",
10393-
"subcategory": "pulls",
10394-
"verb": "delete",
10395-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive",
10396-
"access": "write",
10397-
"user-to-server": true,
10398-
"server-to-server": true,
10399-
"additional-permissions": false
10400-
},
1040110429
{
1040210430
"category": "pulls",
1040310431
"slug": "list-review-comments-on-a-pull-request",
@@ -11104,6 +11132,17 @@
1110411132
"user-to-server": true,
1110511133
"server-to-server": true,
1110611134
"additional-permissions": true
11135+
},
11136+
{
11137+
"category": "releases",
11138+
"slug": "update-a-release",
11139+
"subcategory": "releases",
11140+
"verb": "patch",
11141+
"requestPath": "/repos/{owner}/{repo}/releases/{release_id}",
11142+
"access": "write",
11143+
"user-to-server": true,
11144+
"server-to-server": true,
11145+
"additional-permissions": true
1110711146
}
1110811147
]
1110911148
},

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

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2332,6 +2332,12 @@
23322332
"verb": "get",
23332333
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/enterprise-28-day/latest"
23342334
},
2335+
{
2336+
"slug": "get-copilot-enterprise-user-teams-report-for-a-specific-day",
2337+
"subcategory": "copilot-usage-metrics",
2338+
"verb": "get",
2339+
"requestPath": "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day"
2340+
},
23352341
{
23362342
"slug": "get-copilot-users-usage-metrics-for-a-specific-day",
23372343
"subcategory": "copilot-usage-metrics",
@@ -2446,6 +2452,12 @@
24462452
"verb": "get",
24472453
"requestPath": "/orgs/{org}/copilot/metrics/reports/organization-28-day/latest"
24482454
},
2455+
{
2456+
"slug": "get-copilot-organization-user-teams-report-for-a-specific-day",
2457+
"subcategory": "copilot-usage-metrics",
2458+
"verb": "get",
2459+
"requestPath": "/orgs/{org}/copilot/metrics/reports/user-teams-1-day"
2460+
},
24492461
{
24502462
"slug": "get-copilot-organization-users-usage-metrics-for-a-specific-day",
24512463
"subcategory": "copilot-usage-metrics",
@@ -2469,6 +2481,12 @@
24692481
"subcategory": "copilot-metrics",
24702482
"verb": "get",
24712483
"requestPath": "/orgs/{org}/team/{team_slug}/copilot/metrics"
2484+
},
2485+
{
2486+
"slug": "get-copilot-cloud-agent-configuration-for-a-repository",
2487+
"subcategory": "copilot-cloud-agent-management",
2488+
"verb": "get",
2489+
"requestPath": "/repos/{owner}/{repo}/copilot/cloud-agent/configuration"
24722490
}
24732491
],
24742492
"copilot-spaces": [
@@ -4666,18 +4684,6 @@
46664684
"verb": "patch",
46674685
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}"
46684686
},
4669-
{
4670-
"slug": "archive-a-pull-request",
4671-
"subcategory": "pulls",
4672-
"verb": "put",
4673-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive"
4674-
},
4675-
{
4676-
"slug": "unarchive-a-pull-request",
4677-
"subcategory": "pulls",
4678-
"verb": "delete",
4679-
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/archive"
4680-
},
46814687
{
46824688
"slug": "list-review-comments-on-a-pull-request",
46834689
"subcategory": "comments",

0 commit comments

Comments
 (0)