Skip to content

Commit a5ae7e2

Browse files
docs-botpjquirkhubwriter
authored
Update OpenAPI Description (#54022)
Co-authored-by: PJ Quirk <[email protected]> Co-authored-by: hubwriter <[email protected]>
1 parent eda0eed commit a5ae7e2

File tree

26 files changed

+3011
-427
lines changed

26 files changed

+3011
-427
lines changed

‎content/rest/enterprise-admin/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ children:
2424
- /license
2525
- /manage-ghes
2626
- /management-console
27+
- /network-configurations
2728
- /org-pre-receive-hooks
2829
- /orgs
2930
- /pre-receive-environments

‎content/rest/enterprise-admin/network-configurations.md‎

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

‎content/rest/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ children:
8686
- /search
8787
- /secret-scanning
8888
- /security-advisories
89+
- /settings
8990
- /teams
9091
- /users
9192
autogenerated: rest

‎content/rest/settings/index.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: settings
3+
topics:
4+
- API
5+
autogenerated: rest
6+
allowTitleToDifferFromFilename: true
7+
children:
8+
- /network-configurations
9+
versions:
10+
fpt: '*'
11+
ghec: '*'
12+
---
13+

‎content/rest/settings/network-configurations.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 network configurations
3+
shortTitle: Network configurations
4+
intro: Use the REST API to interact with network configurations.
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 -->

‎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
@@ -1244,6 +1244,66 @@
12441244
}
12451245
]
12461246
},
1247+
"organization_network_configurations": {
1248+
"title": "Network configurations",
1249+
"displayTitle": "Organization permissions for \"Network configurations\"",
1250+
"permissions": [
1251+
{
1252+
"category": "settings",
1253+
"slug": "list-hosted-compute-network-configurations-for-an-organization",
1254+
"subcategory": "network-configurations",
1255+
"verb": "get",
1256+
"requestPath": "/orgs/{org}/settings/network-configurations",
1257+
"additional-permissions": false,
1258+
"access": "read"
1259+
},
1260+
{
1261+
"category": "settings",
1262+
"slug": "create-a-hosted-compute-network-configuration-for-an-organization",
1263+
"subcategory": "network-configurations",
1264+
"verb": "post",
1265+
"requestPath": "/orgs/{org}/settings/network-configurations",
1266+
"additional-permissions": false,
1267+
"access": "write"
1268+
},
1269+
{
1270+
"category": "settings",
1271+
"slug": "get-a-hosted-compute-network-configuration-for-an-organization",
1272+
"subcategory": "network-configurations",
1273+
"verb": "get",
1274+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}",
1275+
"additional-permissions": false,
1276+
"access": "read"
1277+
},
1278+
{
1279+
"category": "settings",
1280+
"slug": "update-a-hosted-compute-network-configuration-for-an-organization",
1281+
"subcategory": "network-configurations",
1282+
"verb": "patch",
1283+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}",
1284+
"additional-permissions": false,
1285+
"access": "write"
1286+
},
1287+
{
1288+
"category": "settings",
1289+
"slug": "delete-a-hosted-compute-network-configuration-from-an-organization",
1290+
"subcategory": "network-configurations",
1291+
"verb": "delete",
1292+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}",
1293+
"additional-permissions": false,
1294+
"access": "write"
1295+
},
1296+
{
1297+
"category": "settings",
1298+
"slug": "get-a-hosted-compute-network-settings-resource-for-an-organization",
1299+
"subcategory": "network-configurations",
1300+
"verb": "get",
1301+
"requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}",
1302+
"additional-permissions": false,
1303+
"access": "read"
1304+
}
1305+
]
1306+
},
12471307
"organization_codespaces_secrets": {
12481308
"title": "Organization codespaces secrets",
12491309
"displayTitle": "Organization permissions for \"Organization codespaces secrets\"",

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4967,6 +4967,44 @@
49674967
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks"
49684968
}
49694969
],
4970+
"settings": [
4971+
{
4972+
"slug": "list-hosted-compute-network-configurations-for-an-organization",
4973+
"subcategory": "network-configurations",
4974+
"verb": "get",
4975+
"requestPath": "/orgs/{org}/settings/network-configurations"
4976+
},
4977+
{
4978+
"slug": "create-a-hosted-compute-network-configuration-for-an-organization",
4979+
"subcategory": "network-configurations",
4980+
"verb": "post",
4981+
"requestPath": "/orgs/{org}/settings/network-configurations"
4982+
},
4983+
{
4984+
"slug": "get-a-hosted-compute-network-configuration-for-an-organization",
4985+
"subcategory": "network-configurations",
4986+
"verb": "get",
4987+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4988+
},
4989+
{
4990+
"slug": "update-a-hosted-compute-network-configuration-for-an-organization",
4991+
"subcategory": "network-configurations",
4992+
"verb": "patch",
4993+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4994+
},
4995+
{
4996+
"slug": "delete-a-hosted-compute-network-configuration-from-an-organization",
4997+
"subcategory": "network-configurations",
4998+
"verb": "delete",
4999+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
5000+
},
5001+
{
5002+
"slug": "get-a-hosted-compute-network-settings-resource-for-an-organization",
5003+
"subcategory": "network-configurations",
5004+
"verb": "get",
5005+
"requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}"
5006+
}
5007+
],
49705008
"teams": [
49715009
{
49725010
"slug": "list-teams",

‎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
@@ -1510,6 +1510,78 @@
15101510
}
15111511
]
15121512
},
1513+
"organization_network_configurations": {
1514+
"title": "Network configurations",
1515+
"displayTitle": "Organization permissions for \"Network configurations\"",
1516+
"permissions": [
1517+
{
1518+
"category": "settings",
1519+
"slug": "list-hosted-compute-network-configurations-for-an-organization",
1520+
"subcategory": "network-configurations",
1521+
"verb": "get",
1522+
"requestPath": "/orgs/{org}/settings/network-configurations",
1523+
"access": "read",
1524+
"user-to-server": true,
1525+
"server-to-server": true,
1526+
"additional-permissions": false
1527+
},
1528+
{
1529+
"category": "settings",
1530+
"slug": "create-a-hosted-compute-network-configuration-for-an-organization",
1531+
"subcategory": "network-configurations",
1532+
"verb": "post",
1533+
"requestPath": "/orgs/{org}/settings/network-configurations",
1534+
"access": "write",
1535+
"user-to-server": true,
1536+
"server-to-server": true,
1537+
"additional-permissions": false
1538+
},
1539+
{
1540+
"category": "settings",
1541+
"slug": "get-a-hosted-compute-network-configuration-for-an-organization",
1542+
"subcategory": "network-configurations",
1543+
"verb": "get",
1544+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}",
1545+
"access": "read",
1546+
"user-to-server": true,
1547+
"server-to-server": true,
1548+
"additional-permissions": false
1549+
},
1550+
{
1551+
"category": "settings",
1552+
"slug": "update-a-hosted-compute-network-configuration-for-an-organization",
1553+
"subcategory": "network-configurations",
1554+
"verb": "patch",
1555+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}",
1556+
"access": "write",
1557+
"user-to-server": true,
1558+
"server-to-server": true,
1559+
"additional-permissions": false
1560+
},
1561+
{
1562+
"category": "settings",
1563+
"slug": "delete-a-hosted-compute-network-configuration-from-an-organization",
1564+
"subcategory": "network-configurations",
1565+
"verb": "delete",
1566+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}",
1567+
"access": "write",
1568+
"user-to-server": true,
1569+
"server-to-server": true,
1570+
"additional-permissions": false
1571+
},
1572+
{
1573+
"category": "settings",
1574+
"slug": "get-a-hosted-compute-network-settings-resource-for-an-organization",
1575+
"subcategory": "network-configurations",
1576+
"verb": "get",
1577+
"requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}",
1578+
"access": "read",
1579+
"user-to-server": true,
1580+
"server-to-server": true,
1581+
"additional-permissions": false
1582+
}
1583+
]
1584+
},
15131585
"organization_codespaces_secrets": {
15141586
"title": "Organization codespaces secrets",
15151587
"displayTitle": "Organization permissions for \"Organization codespaces secrets\"",

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4475,6 +4475,44 @@
44754475
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks"
44764476
}
44774477
],
4478+
"settings": [
4479+
{
4480+
"slug": "list-hosted-compute-network-configurations-for-an-organization",
4481+
"subcategory": "network-configurations",
4482+
"verb": "get",
4483+
"requestPath": "/orgs/{org}/settings/network-configurations"
4484+
},
4485+
{
4486+
"slug": "create-a-hosted-compute-network-configuration-for-an-organization",
4487+
"subcategory": "network-configurations",
4488+
"verb": "post",
4489+
"requestPath": "/orgs/{org}/settings/network-configurations"
4490+
},
4491+
{
4492+
"slug": "get-a-hosted-compute-network-configuration-for-an-organization",
4493+
"subcategory": "network-configurations",
4494+
"verb": "get",
4495+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4496+
},
4497+
{
4498+
"slug": "update-a-hosted-compute-network-configuration-for-an-organization",
4499+
"subcategory": "network-configurations",
4500+
"verb": "patch",
4501+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4502+
},
4503+
{
4504+
"slug": "delete-a-hosted-compute-network-configuration-from-an-organization",
4505+
"subcategory": "network-configurations",
4506+
"verb": "delete",
4507+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4508+
},
4509+
{
4510+
"slug": "get-a-hosted-compute-network-settings-resource-for-an-organization",
4511+
"subcategory": "network-configurations",
4512+
"verb": "get",
4513+
"requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}"
4514+
}
4515+
],
44784516
"teams": [
44794517
{
44804518
"slug": "list-teams",

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

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4967,6 +4967,44 @@
49674967
"requestPath": "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks"
49684968
}
49694969
],
4970+
"settings": [
4971+
{
4972+
"slug": "list-hosted-compute-network-configurations-for-an-organization",
4973+
"subcategory": "network-configurations",
4974+
"verb": "get",
4975+
"requestPath": "/orgs/{org}/settings/network-configurations"
4976+
},
4977+
{
4978+
"slug": "create-a-hosted-compute-network-configuration-for-an-organization",
4979+
"subcategory": "network-configurations",
4980+
"verb": "post",
4981+
"requestPath": "/orgs/{org}/settings/network-configurations"
4982+
},
4983+
{
4984+
"slug": "get-a-hosted-compute-network-configuration-for-an-organization",
4985+
"subcategory": "network-configurations",
4986+
"verb": "get",
4987+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4988+
},
4989+
{
4990+
"slug": "update-a-hosted-compute-network-configuration-for-an-organization",
4991+
"subcategory": "network-configurations",
4992+
"verb": "patch",
4993+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
4994+
},
4995+
{
4996+
"slug": "delete-a-hosted-compute-network-configuration-from-an-organization",
4997+
"subcategory": "network-configurations",
4998+
"verb": "delete",
4999+
"requestPath": "/orgs/{org}/settings/network-configurations/{network_configuration_id}"
5000+
},
5001+
{
5002+
"slug": "get-a-hosted-compute-network-settings-resource-for-an-organization",
5003+
"subcategory": "network-configurations",
5004+
"verb": "get",
5005+
"requestPath": "/orgs/{org}/settings/network-settings/{network_settings_id}"
5006+
}
5007+
],
49705008
"teams": [
49715009
{
49725010
"slug": "list-teams",

0 commit comments

Comments
 (0)