Skip to content

Commit 70e258d

Browse files
Update OpenAPI Description (#55882)
Co-authored-by: Felicity Chapman <[email protected]>
1 parent 75d53ed commit 70e258d

File tree

29 files changed

+3697
-19449
lines changed

29 files changed

+3697
-19449
lines changed

content/rest/dependabot/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
2-
title: REST API endpoints for {% data variables.product.prodname_dependabot %}
2+
title: 'REST API endpoints for {% data variables.product.prodname_dependabot %}'
33
shortTitle: Dependabot
4-
intro: 'Use the REST API to interact with {% data variables.product.prodname_dependabot %} alerts and secrets for an organization or repository.'
4+
intro: >-
5+
Use the REST API to interact with {% data variables.product.prodname_dependabot_alerts %} and secrets for an organization or repository.
56
allowTitleToDifferFromFilename: true
67
versions:
78
fpt: '*'
@@ -11,6 +12,7 @@ topics:
1112
- API
1213
children:
1314
- /alerts
15+
- /repository-access
1416
- /secrets
1517
redirect_from:
1618
- /rest/reference/dependabot
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: 'REST API endpoints for {% data variables.product.prodname_dependabot %} repository access'
3+
shortTitle: Repository access
4+
intro: 'Use the REST API to manage which repositories {% data variables.product.prodname_dependabot %} can access within an organization.'
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+
## About {% data variables.product.prodname_dependabot %} repository access
15+
16+
You can list repositories that {% data variables.product.prodname_dependabot %} already has access to and set a default repository access level for {% data variables.product.prodname_dependabot %}.
17+
18+
<!-- Content after this section is automatically generated -->

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,24 @@
9090
"title": "Administration",
9191
"displayTitle": "Organization permissions for \"Administration\"",
9292
"permissions": [
93+
{
94+
"category": "dependabot",
95+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
96+
"subcategory": "repository-access",
97+
"verb": "get",
98+
"requestPath": "/organizations/{org}/dependabot/repository-access",
99+
"additional-permissions": false,
100+
"access": "read"
101+
},
102+
{
103+
"category": "dependabot",
104+
"slug": "set-the-default-repository-access-level-for-dependabot",
105+
"subcategory": "repository-access",
106+
"verb": "put",
107+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level",
108+
"additional-permissions": false,
109+
"access": "write"
110+
},
93111
{
94112
"category": "billing",
95113
"slug": "get-billing-usage-report-for-an-organization",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2186,6 +2186,18 @@
21862186
}
21872187
],
21882188
"dependabot": [
2189+
{
2190+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
2191+
"subcategory": "repository-access",
2192+
"verb": "get",
2193+
"requestPath": "/organizations/{org}/dependabot/repository-access"
2194+
},
2195+
{
2196+
"slug": "set-the-default-repository-access-level-for-dependabot",
2197+
"subcategory": "repository-access",
2198+
"verb": "put",
2199+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level"
2200+
},
21892201
{
21902202
"slug": "list-dependabot-alerts-for-an-organization",
21912203
"subcategory": "alerts",

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,28 @@
108108
"title": "Administration",
109109
"displayTitle": "Organization permissions for \"Administration\"",
110110
"permissions": [
111+
{
112+
"category": "dependabot",
113+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
114+
"subcategory": "repository-access",
115+
"verb": "get",
116+
"requestPath": "/organizations/{org}/dependabot/repository-access",
117+
"access": "read",
118+
"user-to-server": true,
119+
"server-to-server": true,
120+
"additional-permissions": false
121+
},
122+
{
123+
"category": "dependabot",
124+
"slug": "set-the-default-repository-access-level-for-dependabot",
125+
"subcategory": "repository-access",
126+
"verb": "put",
127+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level",
128+
"access": "write",
129+
"user-to-server": true,
130+
"server-to-server": true,
131+
"additional-permissions": false
132+
},
111133
{
112134
"category": "billing",
113135
"slug": "get-billing-usage-report-for-an-organization",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1914,6 +1914,18 @@
19141914
}
19151915
],
19161916
"dependabot": [
1917+
{
1918+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
1919+
"subcategory": "repository-access",
1920+
"verb": "get",
1921+
"requestPath": "/organizations/{org}/dependabot/repository-access"
1922+
},
1923+
{
1924+
"slug": "set-the-default-repository-access-level-for-dependabot",
1925+
"subcategory": "repository-access",
1926+
"verb": "put",
1927+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level"
1928+
},
19171929
{
19181930
"slug": "list-dependabot-alerts-for-an-organization",
19191931
"subcategory": "alerts",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2186,6 +2186,18 @@
21862186
}
21872187
],
21882188
"dependabot": [
2189+
{
2190+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
2191+
"subcategory": "repository-access",
2192+
"verb": "get",
2193+
"requestPath": "/organizations/{org}/dependabot/repository-access"
2194+
},
2195+
{
2196+
"slug": "set-the-default-repository-access-level-for-dependabot",
2197+
"subcategory": "repository-access",
2198+
"verb": "put",
2199+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level"
2200+
},
21892201
{
21902202
"slug": "list-dependabot-alerts-for-an-organization",
21912203
"subcategory": "alerts",

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -282,6 +282,24 @@
282282
"additional-permissions": true,
283283
"access": "read"
284284
},
285+
{
286+
"category": "dependabot",
287+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
288+
"subcategory": "repository-access",
289+
"verb": "get",
290+
"requestPath": "/organizations/{org}/dependabot/repository-access",
291+
"additional-permissions": false,
292+
"access": "read"
293+
},
294+
{
295+
"category": "dependabot",
296+
"slug": "set-the-default-repository-access-level-for-dependabot",
297+
"subcategory": "repository-access",
298+
"verb": "put",
299+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level",
300+
"additional-permissions": false,
301+
"access": "write"
302+
},
285303
{
286304
"category": "billing",
287305
"slug": "get-billing-usage-report-for-an-organization",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2224,6 +2224,18 @@
22242224
}
22252225
],
22262226
"dependabot": [
2227+
{
2228+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
2229+
"subcategory": "repository-access",
2230+
"verb": "get",
2231+
"requestPath": "/organizations/{org}/dependabot/repository-access"
2232+
},
2233+
{
2234+
"slug": "set-the-default-repository-access-level-for-dependabot",
2235+
"subcategory": "repository-access",
2236+
"verb": "put",
2237+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level"
2238+
},
22272239
{
22282240
"slug": "list-dependabot-alerts-for-an-organization",
22292241
"subcategory": "alerts",

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,28 @@
340340
"server-to-server": true,
341341
"additional-permissions": true
342342
},
343+
{
344+
"category": "dependabot",
345+
"slug": "lists-repositories-that-organization-admins-have-allowed-dependabot-to-access-when-updating-dependencies",
346+
"subcategory": "repository-access",
347+
"verb": "get",
348+
"requestPath": "/organizations/{org}/dependabot/repository-access",
349+
"access": "read",
350+
"user-to-server": true,
351+
"server-to-server": true,
352+
"additional-permissions": false
353+
},
354+
{
355+
"category": "dependabot",
356+
"slug": "set-the-default-repository-access-level-for-dependabot",
357+
"subcategory": "repository-access",
358+
"verb": "put",
359+
"requestPath": "/organizations/{org}/dependabot/repository-access/default-level",
360+
"access": "write",
361+
"user-to-server": true,
362+
"server-to-server": true,
363+
"additional-permissions": false
364+
},
343365
{
344366
"category": "billing",
345367
"slug": "get-billing-usage-report-for-an-organization",

0 commit comments

Comments
 (0)