Skip to content

Commit cac8a1d

Browse files
docs-botskedwards88
docs-bot
and
skedwards88
authored
Update OpenAPI Description (#49309)
Co-authored-by: Sarah Edwards <skedwards88@github.com>
1 parent b2612df commit cac8a1d

File tree

23 files changed

+370
-533
lines changed

23 files changed

+370
-533
lines changed

‎content/rest/copilot/copilot-business.md renamed to ‎content/rest/copilot/copilot-user-management.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Copilot business
3-
shortTitle: Copilot business
4-
intro: 'Use the REST API to manage the {% data variables.product.prodname_copilot_for_business %} subscription for your organization.'
2+
title: Copilot user management
3+
shortTitle: Copilot user management
4+
intro: 'Use the REST API to manage the {% data variables.product.prodname_copilot_for_business %} or {% data variables.product.prodname_copilot_enterprise %} subscription for your organization.'
55
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
66
fpt: '*'
77
ghec: '*'
@@ -11,6 +11,7 @@ autogenerated: rest
1111
allowTitleToDifferFromFilename: true
1212
redirect_from:
1313
- /rest/copilot/copilot-for-business
14+
- /rest/copilot/copilot-business
1415
---
1516

1617
{% note %}

‎content/rest/copilot/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ topics:
99
autogenerated: rest
1010
allowTitleToDifferFromFilename: true
1111
children:
12-
- /copilot-business
12+
- /copilot-user-management
1313
versions:
1414
fpt: '*'
1515
ghec: '*'

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

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -503,44 +503,62 @@
503503
"permissions": [
504504
{
505505
"category": "copilot",
506-
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
507-
"subcategory": "copilot-business",
506+
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
507+
"subcategory": "copilot-user-management",
508508
"verb": "get",
509509
"requestPath": "/orgs/{org}/copilot/billing",
510510
"additional-permissions": false,
511511
"access": "write"
512512
},
513513
{
514514
"category": "copilot",
515-
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
516-
"subcategory": "copilot-business",
515+
"slug": "list-all-copilot-seat-assignments-for-an-organization",
516+
"subcategory": "copilot-user-management",
517517
"verb": "get",
518518
"requestPath": "/orgs/{org}/copilot/billing/seats",
519519
"additional-permissions": false,
520520
"access": "write"
521521
},
522522
{
523523
"category": "copilot",
524-
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
525-
"subcategory": "copilot-business",
524+
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
525+
"subcategory": "copilot-user-management",
526+
"verb": "post",
527+
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
528+
"additional-permissions": false,
529+
"access": "write"
530+
},
531+
{
532+
"category": "copilot",
533+
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
534+
"subcategory": "copilot-user-management",
526535
"verb": "delete",
527536
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
528537
"additional-permissions": false,
529538
"access": "write"
530539
},
531540
{
532541
"category": "copilot",
533-
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
534-
"subcategory": "copilot-business",
542+
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
543+
"subcategory": "copilot-user-management",
544+
"verb": "post",
545+
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
546+
"additional-permissions": false,
547+
"access": "write"
548+
},
549+
{
550+
"category": "copilot",
551+
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
552+
"subcategory": "copilot-user-management",
535553
"verb": "delete",
536554
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
537555
"additional-permissions": false,
538556
"access": "write"
539557
},
540558
{
541559
"category": "copilot",
542-
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
543-
"subcategory": "copilot-business",
560+
"slug": "get-copilot-seat-assignment-details-for-a-user",
561+
"subcategory": "copilot-user-management",
544562
"verb": "get",
545563
"requestPath": "/orgs/{org}/members/{username}/copilot",
546564
"additional-permissions": false,

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

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1831,32 +1831,44 @@
18311831
],
18321832
"copilot": [
18331833
{
1834-
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
1835-
"subcategory": "copilot-business",
1834+
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
1835+
"subcategory": "copilot-user-management",
18361836
"verb": "get",
18371837
"requestPath": "/orgs/{org}/copilot/billing"
18381838
},
18391839
{
1840-
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
1841-
"subcategory": "copilot-business",
1840+
"slug": "list-all-copilot-seat-assignments-for-an-organization",
1841+
"subcategory": "copilot-user-management",
18421842
"verb": "get",
18431843
"requestPath": "/orgs/{org}/copilot/billing/seats"
18441844
},
18451845
{
1846-
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
1847-
"subcategory": "copilot-business",
1846+
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
1847+
"subcategory": "copilot-user-management",
1848+
"verb": "post",
1849+
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
1850+
},
1851+
{
1852+
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
1853+
"subcategory": "copilot-user-management",
18481854
"verb": "delete",
18491855
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
18501856
},
18511857
{
1852-
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
1853-
"subcategory": "copilot-business",
1858+
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
1859+
"subcategory": "copilot-user-management",
1860+
"verb": "post",
1861+
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
1862+
},
1863+
{
1864+
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
1865+
"subcategory": "copilot-user-management",
18541866
"verb": "delete",
18551867
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
18561868
},
18571869
{
1858-
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
1859-
"subcategory": "copilot-business",
1870+
"slug": "get-copilot-seat-assignment-details-for-a-user",
1871+
"subcategory": "copilot-user-management",
18601872
"verb": "get",
18611873
"requestPath": "/orgs/{org}/members/{username}/copilot"
18621874
}

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

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -607,8 +607,8 @@
607607
"permissions": [
608608
{
609609
"category": "copilot",
610-
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
611-
"subcategory": "copilot-business",
610+
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
611+
"subcategory": "copilot-user-management",
612612
"verb": "get",
613613
"requestPath": "/orgs/{org}/copilot/billing",
614614
"access": "write",
@@ -618,8 +618,8 @@
618618
},
619619
{
620620
"category": "copilot",
621-
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
622-
"subcategory": "copilot-business",
621+
"slug": "list-all-copilot-seat-assignments-for-an-organization",
622+
"subcategory": "copilot-user-management",
623623
"verb": "get",
624624
"requestPath": "/orgs/{org}/copilot/billing/seats",
625625
"access": "write",
@@ -629,8 +629,19 @@
629629
},
630630
{
631631
"category": "copilot",
632-
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
633-
"subcategory": "copilot-business",
632+
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
633+
"subcategory": "copilot-user-management",
634+
"verb": "post",
635+
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
636+
"access": "write",
637+
"user-to-server": true,
638+
"server-to-server": true,
639+
"additional-permissions": false
640+
},
641+
{
642+
"category": "copilot",
643+
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
644+
"subcategory": "copilot-user-management",
634645
"verb": "delete",
635646
"requestPath": "/orgs/{org}/copilot/billing/selected_teams",
636647
"access": "write",
@@ -640,8 +651,19 @@
640651
},
641652
{
642653
"category": "copilot",
643-
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
644-
"subcategory": "copilot-business",
654+
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
655+
"subcategory": "copilot-user-management",
656+
"verb": "post",
657+
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
658+
"access": "write",
659+
"user-to-server": true,
660+
"server-to-server": true,
661+
"additional-permissions": false
662+
},
663+
{
664+
"category": "copilot",
665+
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
666+
"subcategory": "copilot-user-management",
645667
"verb": "delete",
646668
"requestPath": "/orgs/{org}/copilot/billing/selected_users",
647669
"access": "write",
@@ -651,8 +673,8 @@
651673
},
652674
{
653675
"category": "copilot",
654-
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
655-
"subcategory": "copilot-business",
676+
"slug": "get-copilot-seat-assignment-details-for-a-user",
677+
"subcategory": "copilot-user-management",
656678
"verb": "get",
657679
"requestPath": "/orgs/{org}/members/{username}/copilot",
658680
"access": "write",

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

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1559,32 +1559,44 @@
15591559
],
15601560
"copilot": [
15611561
{
1562-
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
1563-
"subcategory": "copilot-business",
1562+
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
1563+
"subcategory": "copilot-user-management",
15641564
"verb": "get",
15651565
"requestPath": "/orgs/{org}/copilot/billing"
15661566
},
15671567
{
1568-
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
1569-
"subcategory": "copilot-business",
1568+
"slug": "list-all-copilot-seat-assignments-for-an-organization",
1569+
"subcategory": "copilot-user-management",
15701570
"verb": "get",
15711571
"requestPath": "/orgs/{org}/copilot/billing/seats"
15721572
},
15731573
{
1574-
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
1575-
"subcategory": "copilot-business",
1574+
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
1575+
"subcategory": "copilot-user-management",
1576+
"verb": "post",
1577+
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
1578+
},
1579+
{
1580+
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
1581+
"subcategory": "copilot-user-management",
15761582
"verb": "delete",
15771583
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
15781584
},
15791585
{
1580-
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
1581-
"subcategory": "copilot-business",
1586+
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
1587+
"subcategory": "copilot-user-management",
1588+
"verb": "post",
1589+
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
1590+
},
1591+
{
1592+
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
1593+
"subcategory": "copilot-user-management",
15821594
"verb": "delete",
15831595
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
15841596
},
15851597
{
1586-
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
1587-
"subcategory": "copilot-business",
1598+
"slug": "get-copilot-seat-assignment-details-for-a-user",
1599+
"subcategory": "copilot-user-management",
15881600
"verb": "get",
15891601
"requestPath": "/orgs/{org}/members/{username}/copilot"
15901602
}

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

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1831,32 +1831,44 @@
18311831
],
18321832
"copilot": [
18331833
{
1834-
"slug": "get-copilot-business-seat-information-and-settings-for-an-organization",
1835-
"subcategory": "copilot-business",
1834+
"slug": "get-copilot-seat-information-and-settings-for-an-organization",
1835+
"subcategory": "copilot-user-management",
18361836
"verb": "get",
18371837
"requestPath": "/orgs/{org}/copilot/billing"
18381838
},
18391839
{
1840-
"slug": "list-all-copilot-business-seat-assignments-for-an-organization",
1841-
"subcategory": "copilot-business",
1840+
"slug": "list-all-copilot-seat-assignments-for-an-organization",
1841+
"subcategory": "copilot-user-management",
18421842
"verb": "get",
18431843
"requestPath": "/orgs/{org}/copilot/billing/seats"
18441844
},
18451845
{
1846-
"slug": "remove-teams-from-the-copilot-business-subscription-for-an-organization",
1847-
"subcategory": "copilot-business",
1846+
"slug": "add-teams-to-the-copilot-subscription-for-an-organization",
1847+
"subcategory": "copilot-user-management",
1848+
"verb": "post",
1849+
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
1850+
},
1851+
{
1852+
"slug": "remove-teams-from-the-copilot-subscription-for-an-organization",
1853+
"subcategory": "copilot-user-management",
18481854
"verb": "delete",
18491855
"requestPath": "/orgs/{org}/copilot/billing/selected_teams"
18501856
},
18511857
{
1852-
"slug": "remove-users-from-the-copilot-business-subscription-for-an-organization",
1853-
"subcategory": "copilot-business",
1858+
"slug": "add-users-to-the-copilot-subscription-for-an-organization",
1859+
"subcategory": "copilot-user-management",
1860+
"verb": "post",
1861+
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
1862+
},
1863+
{
1864+
"slug": "remove-users-from-the-copilot-subscription-for-an-organization",
1865+
"subcategory": "copilot-user-management",
18541866
"verb": "delete",
18551867
"requestPath": "/orgs/{org}/copilot/billing/selected_users"
18561868
},
18571869
{
1858-
"slug": "get-copilot-business-seat-assignment-details-for-a-user",
1859-
"subcategory": "copilot-business",
1870+
"slug": "get-copilot-seat-assignment-details-for-a-user",
1871+
"subcategory": "copilot-user-management",
18601872
"verb": "get",
18611873
"requestPath": "/orgs/{org}/members/{username}/copilot"
18621874
}

0 commit comments

Comments
 (0)