Skip to content

Commit da45ec3

Browse files
docs-botvasugamdhasaritai
authored
Update OpenAPI Description (#56923)
Co-authored-by: Vasu Gamdha <[email protected]> Co-authored-by: Sarita Iyer <[email protected]>
1 parent 51e0fe1 commit da45ec3

File tree

29 files changed

+62940
-14514
lines changed

29 files changed

+62940
-14514
lines changed

‎content/rest/issues/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ children:
1919
- /comments
2020
- /events
2121
- /issues
22+
- /issue-dependencies
2223
- /labels
2324
- /milestones
2425
- /sub-issues

‎content/rest/issues/issue-dependencies.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 issue dependencies
3+
shortTitle: Issue dependencies
4+
intro: Use the REST API to view, add, and remove issue dependencies.
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 -->

‎content/rest/secret-scanning/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ topics:
1212
children:
1313
- /alert-dismissal-requests
1414
- /delegated-bypass
15+
- /push-protection
1516
- /secret-scanning
1617
autogenerated: rest
1718
---

‎content/rest/secret-scanning/push-protection.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 secret scanning push protection
3+
shortTitle: Push protection
4+
intro: Use the REST API to manage secret scanning push protection.
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: 216 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,114 @@
9090
"title": "Administration",
9191
"displayTitle": "Organization permissions for \"Administration\"",
9292
"permissions": [
93+
{
94+
"category": "actions",
95+
"slug": "get-artifact-and-log-retention-settings-for-an-organization",
96+
"subcategory": "permissions",
97+
"verb": "get",
98+
"requestPath": "/organizations/{org}/actions/permissions/artifact-and-log-retention",
99+
"additional-permissions": false,
100+
"access": "read"
101+
},
102+
{
103+
"category": "actions",
104+
"slug": "set-artifact-and-log-retention-settings-for-an-organization",
105+
"subcategory": "permissions",
106+
"verb": "put",
107+
"requestPath": "/organizations/{org}/actions/permissions/artifact-and-log-retention",
108+
"additional-permissions": false,
109+
"access": "write"
110+
},
111+
{
112+
"category": "actions",
113+
"slug": "get-fork-pr-contributor-approval-permissions-for-an-organization",
114+
"subcategory": "permissions",
115+
"verb": "get",
116+
"requestPath": "/organizations/{org}/actions/permissions/fork-pr-contributor-approval",
117+
"additional-permissions": false,
118+
"access": "read"
119+
},
120+
{
121+
"category": "actions",
122+
"slug": "set-fork-pr-contributor-approval-permissions-for-an-organization",
123+
"subcategory": "permissions",
124+
"verb": "put",
125+
"requestPath": "/organizations/{org}/actions/permissions/fork-pr-contributor-approval",
126+
"additional-permissions": false,
127+
"access": "write"
128+
},
129+
{
130+
"category": "actions",
131+
"slug": "get-private-repo-fork-pr-workflow-settings-for-an-organization",
132+
"subcategory": "permissions",
133+
"verb": "get",
134+
"requestPath": "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos",
135+
"additional-permissions": false,
136+
"access": "read"
137+
},
138+
{
139+
"category": "actions",
140+
"slug": "set-private-repo-fork-pr-workflow-settings-for-an-organization",
141+
"subcategory": "permissions",
142+
"verb": "put",
143+
"requestPath": "/organizations/{org}/actions/permissions/fork-pr-workflows-private-repos",
144+
"additional-permissions": false,
145+
"access": "write"
146+
},
147+
{
148+
"category": "actions",
149+
"slug": "get-self-hosted-runners-settings-for-an-organization",
150+
"subcategory": "permissions",
151+
"verb": "get",
152+
"requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners",
153+
"additional-permissions": false,
154+
"access": "read"
155+
},
156+
{
157+
"category": "actions",
158+
"slug": "set-self-hosted-runners-settings-for-an-organization",
159+
"subcategory": "permissions",
160+
"verb": "put",
161+
"requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners",
162+
"additional-permissions": false,
163+
"access": "write"
164+
},
165+
{
166+
"category": "actions",
167+
"slug": "list-repositories-allowed-to-use-self-hosted-runners-in-an-organization",
168+
"subcategory": "permissions",
169+
"verb": "get",
170+
"requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories",
171+
"additional-permissions": false,
172+
"access": "read"
173+
},
174+
{
175+
"category": "actions",
176+
"slug": "set-repositories-allowed-to-use-self-hosted-runners-in-an-organization",
177+
"subcategory": "permissions",
178+
"verb": "put",
179+
"requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories",
180+
"additional-permissions": false,
181+
"access": "write"
182+
},
183+
{
184+
"category": "actions",
185+
"slug": "add-a-repository-to-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization",
186+
"subcategory": "permissions",
187+
"verb": "put",
188+
"requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}",
189+
"additional-permissions": true,
190+
"access": "write"
191+
},
192+
{
193+
"category": "actions",
194+
"slug": "remove-a-repository-from-the-list-of-repositories-allowed-to-use-self-hosted-runners-in-an-organization",
195+
"subcategory": "permissions",
196+
"verb": "delete",
197+
"requestPath": "/organizations/{org}/actions/permissions/self-hosted-runners/repositories/{repository_id}",
198+
"additional-permissions": true,
199+
"access": "write"
200+
},
93201
{
94202
"category": "dependabot",
95203
"slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
@@ -639,6 +747,24 @@
639747
"additional-permissions": false,
640748
"access": "write"
641749
},
750+
{
751+
"category": "secret-scanning",
752+
"slug": "list-organization-pattern-configurations",
753+
"subcategory": "push-protection",
754+
"verb": "get",
755+
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
756+
"additional-permissions": false,
757+
"access": "write"
758+
},
759+
{
760+
"category": "secret-scanning",
761+
"slug": "update-organization-pattern-configurations",
762+
"subcategory": "push-protection",
763+
"verb": "patch",
764+
"requestPath": "/orgs/{org}/secret-scanning/pattern-configurations",
765+
"additional-permissions": false,
766+
"access": "write"
767+
},
642768
{
643769
"category": "orgs",
644770
"slug": "list-security-manager-teams",
@@ -3480,6 +3606,60 @@
34803606
"additional-permissions": false,
34813607
"access": "write"
34823608
},
3609+
{
3610+
"category": "actions",
3611+
"slug": "get-artifact-and-log-retention-settings-for-a-repository",
3612+
"subcategory": "permissions",
3613+
"verb": "get",
3614+
"requestPath": "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention",
3615+
"additional-permissions": false,
3616+
"access": "read"
3617+
},
3618+
{
3619+
"category": "actions",
3620+
"slug": "set-artifact-and-log-retention-settings-for-a-repository",
3621+
"subcategory": "permissions",
3622+
"verb": "put",
3623+
"requestPath": "/repos/{owner}/{repo}/actions/permissions/artifact-and-log-retention",
3624+
"additional-permissions": false,
3625+
"access": "write"
3626+
},
3627+
{
3628+
"category": "actions",
3629+
"slug": "get-fork-pr-contributor-approval-permissions-for-a-repository",
3630+
"subcategory": "permissions",
3631+
"verb": "get",
3632+
"requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval",
3633+
"additional-permissions": false,
3634+
"access": "read"
3635+
},
3636+
{
3637+
"category": "actions",
3638+
"slug": "set-fork-pr-contributor-approval-permissions-for-a-repository",
3639+
"subcategory": "permissions",
3640+
"verb": "put",
3641+
"requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-contributor-approval",
3642+
"additional-permissions": false,
3643+
"access": "write"
3644+
},
3645+
{
3646+
"category": "actions",
3647+
"slug": "get-private-repo-fork-pr-workflow-settings-for-a-repository",
3648+
"subcategory": "permissions",
3649+
"verb": "get",
3650+
"requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos",
3651+
"additional-permissions": false,
3652+
"access": "read"
3653+
},
3654+
{
3655+
"category": "actions",
3656+
"slug": "set-private-repo-fork-pr-workflow-settings-for-a-repository",
3657+
"subcategory": "permissions",
3658+
"verb": "put",
3659+
"requestPath": "/repos/{owner}/{repo}/actions/permissions/fork-pr-workflows-private-repos",
3660+
"additional-permissions": false,
3661+
"access": "write"
3662+
},
34833663
{
34843664
"category": "actions",
34853665
"slug": "get-allowed-actions-and-reusable-workflows-for-a-repository",
@@ -6183,6 +6363,42 @@
61836363
"additional-permissions": true,
61846364
"access": "write"
61856365
},
6366+
{
6367+
"category": "issues",
6368+
"slug": "list-dependencies-an-issue-is-blocked-by",
6369+
"subcategory": "issue-dependencies",
6370+
"verb": "get",
6371+
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by",
6372+
"additional-permissions": false,
6373+
"access": "read"
6374+
},
6375+
{
6376+
"category": "issues",
6377+
"slug": "add-a-dependency-an-issue-is-blocked-by",
6378+
"subcategory": "issue-dependencies",
6379+
"verb": "post",
6380+
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by",
6381+
"additional-permissions": false,
6382+
"access": "write"
6383+
},
6384+
{
6385+
"category": "issues",
6386+
"slug": "remove-dependency-an-issue-is-blocked-by",
6387+
"subcategory": "issue-dependencies",
6388+
"verb": "delete",
6389+
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocked_by/{issue_id}",
6390+
"additional-permissions": false,
6391+
"access": "write"
6392+
},
6393+
{
6394+
"category": "issues",
6395+
"slug": "list-dependencies-an-issue-is-blocking",
6396+
"subcategory": "issue-dependencies",
6397+
"verb": "get",
6398+
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/dependencies/blocking",
6399+
"additional-permissions": false,
6400+
"access": "read"
6401+
},
61866402
{
61876403
"category": "issues",
61886404
"slug": "list-issue-events",

0 commit comments

Comments
 (0)