Skip to content

Commit 9a9cdbb

Browse files
docs-botsaritai
andauthored
Update OpenAPI Description (#53798)
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
1 parent 2e6a3d0 commit 9a9cdbb

24 files changed

Lines changed: 2742 additions & 381 deletions

File tree

content/rest/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ children:
7575
- /orgs
7676
- /packages
7777
- /pages
78+
- /private-registries
7879
- /projects
7980
- /pulls
8081
- /rate-limit
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Private registries
3+
topics:
4+
- API
5+
autogenerated: rest
6+
allowTitleToDifferFromFilename: true
7+
children:
8+
- /organization-configurations
9+
versions:
10+
fpt: '*'
11+
ghec: '*'
12+
---
13+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Organization configurations
3+
shortTitle: Organization configurations
4+
intro: Use the REST API to manage private registry configurations for organizations.
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+
> [!NOTE]
15+
> The ability to use the REST API to manage private registries is currently in {% data variables.release-phases.public_preview %} and subject to change.
16+
17+
<!-- 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
@@ -1403,6 +1403,66 @@
14031403
}
14041404
]
14051405
},
1406+
"organization_private_registries": {
1407+
"title": "Organization private registries",
1408+
"displayTitle": "Organization permissions for \"Organization private registries\"",
1409+
"permissions": [
1410+
{
1411+
"category": "private-registries",
1412+
"slug": "list-private-registries-for-an-organization",
1413+
"subcategory": "organization-configurations",
1414+
"verb": "get",
1415+
"requestPath": "/orgs/{org}/private-registries",
1416+
"additional-permissions": false,
1417+
"access": "read"
1418+
},
1419+
{
1420+
"category": "private-registries",
1421+
"slug": "create-a-private-registry-for-an-organization",
1422+
"subcategory": "organization-configurations",
1423+
"verb": "post",
1424+
"requestPath": "/orgs/{org}/private-registries",
1425+
"additional-permissions": false,
1426+
"access": "write"
1427+
},
1428+
{
1429+
"category": "private-registries",
1430+
"slug": "get-private-registries-public-key-for-an-organization",
1431+
"subcategory": "organization-configurations",
1432+
"verb": "get",
1433+
"requestPath": "/orgs/{org}/private-registries/public-key",
1434+
"additional-permissions": false,
1435+
"access": "read"
1436+
},
1437+
{
1438+
"category": "private-registries",
1439+
"slug": "get-a-private-registry-for-an-organization",
1440+
"subcategory": "organization-configurations",
1441+
"verb": "get",
1442+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1443+
"additional-permissions": false,
1444+
"access": "read"
1445+
},
1446+
{
1447+
"category": "private-registries",
1448+
"slug": "update-a-private-registry-for-an-organization",
1449+
"subcategory": "organization-configurations",
1450+
"verb": "patch",
1451+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1452+
"additional-permissions": false,
1453+
"access": "write"
1454+
},
1455+
{
1456+
"category": "private-registries",
1457+
"slug": "delete-a-private-registry-for-an-organization",
1458+
"subcategory": "organization-configurations",
1459+
"verb": "delete",
1460+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1461+
"additional-permissions": false,
1462+
"access": "write"
1463+
}
1464+
]
1465+
},
14061466
"organization_personal_access_token_requests": {
14071467
"title": "Personal access token requests",
14081468
"displayTitle": "Organization permissions for \"Personal access token requests\"",

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
@@ -3819,6 +3819,44 @@
38193819
"requestPath": "/repos/{owner}/{repo}/pages/health"
38203820
}
38213821
],
3822+
"private-registries": [
3823+
{
3824+
"slug": "list-private-registries-for-an-organization",
3825+
"subcategory": "organization-configurations",
3826+
"verb": "get",
3827+
"requestPath": "/orgs/{org}/private-registries"
3828+
},
3829+
{
3830+
"slug": "create-a-private-registry-for-an-organization",
3831+
"subcategory": "organization-configurations",
3832+
"verb": "post",
3833+
"requestPath": "/orgs/{org}/private-registries"
3834+
},
3835+
{
3836+
"slug": "get-private-registries-public-key-for-an-organization",
3837+
"subcategory": "organization-configurations",
3838+
"verb": "get",
3839+
"requestPath": "/orgs/{org}/private-registries/public-key"
3840+
},
3841+
{
3842+
"slug": "get-a-private-registry-for-an-organization",
3843+
"subcategory": "organization-configurations",
3844+
"verb": "get",
3845+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3846+
},
3847+
{
3848+
"slug": "update-a-private-registry-for-an-organization",
3849+
"subcategory": "organization-configurations",
3850+
"verb": "patch",
3851+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3852+
},
3853+
{
3854+
"slug": "delete-a-private-registry-for-an-organization",
3855+
"subcategory": "organization-configurations",
3856+
"verb": "delete",
3857+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3858+
}
3859+
],
38223860
"projects": [
38233861
{
38243862
"slug": "list-organization-projects",

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
@@ -1699,6 +1699,78 @@
16991699
}
17001700
]
17011701
},
1702+
"organization_private_registries": {
1703+
"title": "Organization private registries",
1704+
"displayTitle": "Organization permissions for \"Organization private registries\"",
1705+
"permissions": [
1706+
{
1707+
"category": "private-registries",
1708+
"slug": "list-private-registries-for-an-organization",
1709+
"subcategory": "organization-configurations",
1710+
"verb": "get",
1711+
"requestPath": "/orgs/{org}/private-registries",
1712+
"access": "read",
1713+
"user-to-server": true,
1714+
"server-to-server": true,
1715+
"additional-permissions": false
1716+
},
1717+
{
1718+
"category": "private-registries",
1719+
"slug": "create-a-private-registry-for-an-organization",
1720+
"subcategory": "organization-configurations",
1721+
"verb": "post",
1722+
"requestPath": "/orgs/{org}/private-registries",
1723+
"access": "write",
1724+
"user-to-server": true,
1725+
"server-to-server": true,
1726+
"additional-permissions": false
1727+
},
1728+
{
1729+
"category": "private-registries",
1730+
"slug": "get-private-registries-public-key-for-an-organization",
1731+
"subcategory": "organization-configurations",
1732+
"verb": "get",
1733+
"requestPath": "/orgs/{org}/private-registries/public-key",
1734+
"access": "read",
1735+
"user-to-server": true,
1736+
"server-to-server": true,
1737+
"additional-permissions": false
1738+
},
1739+
{
1740+
"category": "private-registries",
1741+
"slug": "get-a-private-registry-for-an-organization",
1742+
"subcategory": "organization-configurations",
1743+
"verb": "get",
1744+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1745+
"access": "read",
1746+
"user-to-server": true,
1747+
"server-to-server": true,
1748+
"additional-permissions": false
1749+
},
1750+
{
1751+
"category": "private-registries",
1752+
"slug": "update-a-private-registry-for-an-organization",
1753+
"subcategory": "organization-configurations",
1754+
"verb": "patch",
1755+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1756+
"access": "write",
1757+
"user-to-server": true,
1758+
"server-to-server": true,
1759+
"additional-permissions": false
1760+
},
1761+
{
1762+
"category": "private-registries",
1763+
"slug": "delete-a-private-registry-for-an-organization",
1764+
"subcategory": "organization-configurations",
1765+
"verb": "delete",
1766+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1767+
"access": "write",
1768+
"user-to-server": true,
1769+
"server-to-server": true,
1770+
"additional-permissions": false
1771+
}
1772+
]
1773+
},
17021774
"organization_personal_access_token_requests": {
17031775
"title": "Personal access token requests",
17041776
"displayTitle": "Organization permissions for \"Personal access token requests\"",

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
@@ -3351,6 +3351,44 @@
33513351
"requestPath": "/repos/{owner}/{repo}/pages/health"
33523352
}
33533353
],
3354+
"private-registries": [
3355+
{
3356+
"slug": "list-private-registries-for-an-organization",
3357+
"subcategory": "organization-configurations",
3358+
"verb": "get",
3359+
"requestPath": "/orgs/{org}/private-registries"
3360+
},
3361+
{
3362+
"slug": "create-a-private-registry-for-an-organization",
3363+
"subcategory": "organization-configurations",
3364+
"verb": "post",
3365+
"requestPath": "/orgs/{org}/private-registries"
3366+
},
3367+
{
3368+
"slug": "get-private-registries-public-key-for-an-organization",
3369+
"subcategory": "organization-configurations",
3370+
"verb": "get",
3371+
"requestPath": "/orgs/{org}/private-registries/public-key"
3372+
},
3373+
{
3374+
"slug": "get-a-private-registry-for-an-organization",
3375+
"subcategory": "organization-configurations",
3376+
"verb": "get",
3377+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3378+
},
3379+
{
3380+
"slug": "update-a-private-registry-for-an-organization",
3381+
"subcategory": "organization-configurations",
3382+
"verb": "patch",
3383+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3384+
},
3385+
{
3386+
"slug": "delete-a-private-registry-for-an-organization",
3387+
"subcategory": "organization-configurations",
3388+
"verb": "delete",
3389+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3390+
}
3391+
],
33543392
"projects": [
33553393
{
33563394
"slug": "list-organization-projects",

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
@@ -3819,6 +3819,44 @@
38193819
"requestPath": "/repos/{owner}/{repo}/pages/health"
38203820
}
38213821
],
3822+
"private-registries": [
3823+
{
3824+
"slug": "list-private-registries-for-an-organization",
3825+
"subcategory": "organization-configurations",
3826+
"verb": "get",
3827+
"requestPath": "/orgs/{org}/private-registries"
3828+
},
3829+
{
3830+
"slug": "create-a-private-registry-for-an-organization",
3831+
"subcategory": "organization-configurations",
3832+
"verb": "post",
3833+
"requestPath": "/orgs/{org}/private-registries"
3834+
},
3835+
{
3836+
"slug": "get-private-registries-public-key-for-an-organization",
3837+
"subcategory": "organization-configurations",
3838+
"verb": "get",
3839+
"requestPath": "/orgs/{org}/private-registries/public-key"
3840+
},
3841+
{
3842+
"slug": "get-a-private-registry-for-an-organization",
3843+
"subcategory": "organization-configurations",
3844+
"verb": "get",
3845+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3846+
},
3847+
{
3848+
"slug": "update-a-private-registry-for-an-organization",
3849+
"subcategory": "organization-configurations",
3850+
"verb": "patch",
3851+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3852+
},
3853+
{
3854+
"slug": "delete-a-private-registry-for-an-organization",
3855+
"subcategory": "organization-configurations",
3856+
"verb": "delete",
3857+
"requestPath": "/orgs/{org}/private-registries/{secret_name}"
3858+
}
3859+
],
38223860
"projects": [
38233861
{
38243862
"slug": "list-organization-projects",

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

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1853,6 +1853,66 @@
18531853
}
18541854
]
18551855
},
1856+
"organization_private_registries": {
1857+
"title": "Organization private registries",
1858+
"displayTitle": "Organization permissions for \"Organization private registries\"",
1859+
"permissions": [
1860+
{
1861+
"category": "private-registries",
1862+
"slug": "list-private-registries-for-an-organization",
1863+
"subcategory": "organization-configurations",
1864+
"verb": "get",
1865+
"requestPath": "/orgs/{org}/private-registries",
1866+
"additional-permissions": false,
1867+
"access": "read"
1868+
},
1869+
{
1870+
"category": "private-registries",
1871+
"slug": "create-a-private-registry-for-an-organization",
1872+
"subcategory": "organization-configurations",
1873+
"verb": "post",
1874+
"requestPath": "/orgs/{org}/private-registries",
1875+
"additional-permissions": false,
1876+
"access": "write"
1877+
},
1878+
{
1879+
"category": "private-registries",
1880+
"slug": "get-private-registries-public-key-for-an-organization",
1881+
"subcategory": "organization-configurations",
1882+
"verb": "get",
1883+
"requestPath": "/orgs/{org}/private-registries/public-key",
1884+
"additional-permissions": false,
1885+
"access": "read"
1886+
},
1887+
{
1888+
"category": "private-registries",
1889+
"slug": "get-a-private-registry-for-an-organization",
1890+
"subcategory": "organization-configurations",
1891+
"verb": "get",
1892+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1893+
"additional-permissions": false,
1894+
"access": "read"
1895+
},
1896+
{
1897+
"category": "private-registries",
1898+
"slug": "update-a-private-registry-for-an-organization",
1899+
"subcategory": "organization-configurations",
1900+
"verb": "patch",
1901+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1902+
"additional-permissions": false,
1903+
"access": "write"
1904+
},
1905+
{
1906+
"category": "private-registries",
1907+
"slug": "delete-a-private-registry-for-an-organization",
1908+
"subcategory": "organization-configurations",
1909+
"verb": "delete",
1910+
"requestPath": "/orgs/{org}/private-registries/{secret_name}",
1911+
"additional-permissions": false,
1912+
"access": "write"
1913+
}
1914+
]
1915+
},
18561916
"organization_personal_access_token_requests": {
18571917
"title": "Personal access token requests",
18581918
"displayTitle": "Organization permissions for \"Personal access token requests\"",

0 commit comments

Comments
 (0)