Skip to content

Commit 7af4429

Browse files
docs-botsabrowning1rsese
authored
Update OpenAPI Description (#58735)
Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com>
1 parent d176fe2 commit 7af4429

38 files changed

Lines changed: 18015 additions & 21073 deletions

‎content/rest/projects-classic/cards.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ intro: >-
88
Use the REST API to create and manage cards on a {% data
99
variables.projects.projects_v1_board %}.
1010
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
11-
ghec: '*'
1211
ghes: <=3.16
1312
topics:
1413
- API

‎content/rest/projects-classic/collaborators.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: 'REST API endpoints for {% data variables.product.prodname_project_v1_caps %} collaborators'
2+
title: >-
3+
REST API endpoints for {% data variables.product.prodname_project_v1_caps %}
4+
collaborators
35
shortTitle: Collaborators
46
allowTitleToDifferFromFilename: true
57
intro: >-
68
Use the REST API to manage collaborators on a {% data
79
variables.projects.projects_v1_board %}.
810
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
9-
fpt: '*'
10-
ghec: '*'
11-
ghes: '*'
11+
ghes: <=3.16
1212
topics:
1313
- API
1414
autogenerated: rest

‎content/rest/projects-classic/columns.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: 'REST API endpoints for {% data variables.product.prodname_project_v1_caps %} columns'
2+
title: >-
3+
REST API endpoints for {% data variables.product.prodname_project_v1_caps %}
4+
columns
35
shortTitle: Columns
46
allowTitleToDifferFromFilename: true
57
intro: >-
68
Use the REST API to create and manage columns on a {% data
79
variables.projects.projects_v1_board %}.
810
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
9-
fpt: '*'
10-
ghec: '*'
11-
ghes: '*'
11+
ghes: <=3.16
1212
topics:
1313
- API
1414
autogenerated: rest

‎src/fixtures/fixtures/rest-redirects.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -460,10 +460,10 @@
460460
"/v3/orgs/outside_collaborators": "/en/rest/orgs/outside-collaborators",
461461
"/v3/orgs/pre_receive_hooks": "/en/enterprise-server/rest/enterprise-admin/org-pre-receive-hooks",
462462
"/v3/orgs/teams": "/en/rest/teams/teams",
463-
"/v3/projects/cards": "/en/enterprise-cloud@latest/rest/projects-classic/cards",
464-
"/v3/projects/collaborators": "/en/rest/projects-classic/collaborators",
465-
"/v3/projects/columns": "/en/rest/projects-classic/columns",
466-
"/v3/projects": "/en/rest/projects-classic",
463+
"/v3/projects/cards": "/en/enterprise-server@3.16/rest/projects-classic/cards",
464+
"/v3/projects/collaborators": "/en/enterprise-server@3.16/rest/projects-classic/collaborators",
465+
"/v3/projects/columns": "/en/enterprise-server@3.16/rest/projects-classic/columns",
466+
"/v3/projects": "/en/enterprise-server@3.16/rest/projects-classic",
467467
"/v3/pulls/comments": "/en/rest/pulls/comments",
468468
"/v3/pulls": "/en/rest/pulls",
469469
"/v3/pulls/review_requests": "/en/rest/pulls/review-requests",

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,42 @@
9090
"title": "Administration",
9191
"displayTitle": "Organization permissions for \"Administration\"",
9292
"permissions": [
93+
{
94+
"category": "actions",
95+
"slug": "get-github-actions-cache-retention-limit-for-an-organization",
96+
"subcategory": "cache",
97+
"verb": "get",
98+
"requestPath": "/organizations/{org}/actions/cache/retention-limit",
99+
"additional-permissions": false,
100+
"access": "read"
101+
},
102+
{
103+
"category": "actions",
104+
"slug": "set-github-actions-cache-retention-limit-for-an-organization",
105+
"subcategory": "cache",
106+
"verb": "put",
107+
"requestPath": "/organizations/{org}/actions/cache/retention-limit",
108+
"additional-permissions": false,
109+
"access": "write"
110+
},
111+
{
112+
"category": "actions",
113+
"slug": "get-github-actions-cache-storage-limit-for-an-organization",
114+
"subcategory": "cache",
115+
"verb": "get",
116+
"requestPath": "/organizations/{org}/actions/cache/storage-limit",
117+
"additional-permissions": false,
118+
"access": "read"
119+
},
120+
{
121+
"category": "actions",
122+
"slug": "set-github-actions-cache-storage-limit-for-an-organization",
123+
"subcategory": "cache",
124+
"verb": "put",
125+
"requestPath": "/organizations/{org}/actions/cache/storage-limit",
126+
"additional-permissions": false,
127+
"access": "write"
128+
},
93129
{
94130
"category": "dependabot",
95131
"slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
@@ -2280,6 +2316,15 @@
22802316
"additional-permissions": false,
22812317
"access": "read"
22822318
},
2319+
{
2320+
"category": "projects",
2321+
"slug": "add-a-field-to-an-organization-owned-project",
2322+
"subcategory": "fields",
2323+
"verb": "post",
2324+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
2325+
"additional-permissions": false,
2326+
"access": "write"
2327+
},
22832328
{
22842329
"category": "projects",
22852330
"slug": "get-project-field-for-organization",
@@ -3582,6 +3627,42 @@
35823627
"additional-permissions": false,
35833628
"access": "write"
35843629
},
3630+
{
3631+
"category": "actions",
3632+
"slug": "get-github-actions-cache-retention-limit-for-a-repository",
3633+
"subcategory": "cache",
3634+
"verb": "get",
3635+
"requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit",
3636+
"additional-permissions": false,
3637+
"access": "read"
3638+
},
3639+
{
3640+
"category": "actions",
3641+
"slug": "set-github-actions-cache-retention-limit-for-a-repository",
3642+
"subcategory": "cache",
3643+
"verb": "put",
3644+
"requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit",
3645+
"additional-permissions": false,
3646+
"access": "write"
3647+
},
3648+
{
3649+
"category": "actions",
3650+
"slug": "get-github-actions-cache-storage-limit-for-a-repository",
3651+
"subcategory": "cache",
3652+
"verb": "get",
3653+
"requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit",
3654+
"additional-permissions": false,
3655+
"access": "read"
3656+
},
3657+
{
3658+
"category": "actions",
3659+
"slug": "set-github-actions-cache-storage-limit-for-a-repository",
3660+
"subcategory": "cache",
3661+
"verb": "put",
3662+
"requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit",
3663+
"additional-permissions": false,
3664+
"access": "write"
3665+
},
35853666
{
35863667
"category": "actions",
35873668
"slug": "get-github-actions-permissions-for-a-repository",

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

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,53 @@
11
{
22
"actions": [
3+
{
4+
"slug": "get-github-actions-cache-retention-limit-for-an-enterprise",
5+
"subcategory": "cache",
6+
"verb": "get",
7+
"requestPath": "/enterprises/{enterprise}/actions/cache/retention-limit"
8+
},
9+
{
10+
"slug": "set-github-actions-cache-retention-limit-for-an-enterprise",
11+
"subcategory": "cache",
12+
"verb": "put",
13+
"requestPath": "/enterprises/{enterprise}/actions/cache/retention-limit"
14+
},
15+
{
16+
"slug": "get-github-actions-cache-storage-limit-for-an-enterprise",
17+
"subcategory": "cache",
18+
"verb": "get",
19+
"requestPath": "/enterprises/{enterprise}/actions/cache/storage-limit"
20+
},
21+
{
22+
"slug": "set-github-actions-cache-storage-limit-for-an-enterprise",
23+
"subcategory": "cache",
24+
"verb": "put",
25+
"requestPath": "/enterprises/{enterprise}/actions/cache/storage-limit"
26+
},
27+
{
28+
"slug": "get-github-actions-cache-retention-limit-for-an-organization",
29+
"subcategory": "cache",
30+
"verb": "get",
31+
"requestPath": "/organizations/{org}/actions/cache/retention-limit"
32+
},
33+
{
34+
"slug": "set-github-actions-cache-retention-limit-for-an-organization",
35+
"subcategory": "cache",
36+
"verb": "put",
37+
"requestPath": "/organizations/{org}/actions/cache/retention-limit"
38+
},
39+
{
40+
"slug": "get-github-actions-cache-storage-limit-for-an-organization",
41+
"subcategory": "cache",
42+
"verb": "get",
43+
"requestPath": "/organizations/{org}/actions/cache/storage-limit"
44+
},
45+
{
46+
"slug": "set-github-actions-cache-storage-limit-for-an-organization",
47+
"subcategory": "cache",
48+
"verb": "put",
49+
"requestPath": "/organizations/{org}/actions/cache/storage-limit"
50+
},
351
{
452
"slug": "get-github-actions-cache-usage-for-an-organization",
553
"subcategory": "cache",
@@ -540,6 +588,30 @@
540588
"verb": "get",
541589
"requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}"
542590
},
591+
{
592+
"slug": "get-github-actions-cache-retention-limit-for-a-repository",
593+
"subcategory": "cache",
594+
"verb": "get",
595+
"requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit"
596+
},
597+
{
598+
"slug": "set-github-actions-cache-retention-limit-for-a-repository",
599+
"subcategory": "cache",
600+
"verb": "put",
601+
"requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit"
602+
},
603+
{
604+
"slug": "get-github-actions-cache-storage-limit-for-a-repository",
605+
"subcategory": "cache",
606+
"verb": "get",
607+
"requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit"
608+
},
609+
{
610+
"slug": "set-github-actions-cache-storage-limit-for-a-repository",
611+
"subcategory": "cache",
612+
"verb": "put",
613+
"requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit"
614+
},
543615
{
544616
"slug": "get-github-actions-cache-usage-for-a-repository",
545617
"subcategory": "cache",
@@ -3784,6 +3856,12 @@
37843856
"verb": "get",
37853857
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
37863858
},
3859+
{
3860+
"slug": "add-a-field-to-an-organization-owned-project",
3861+
"subcategory": "fields",
3862+
"verb": "post",
3863+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields"
3864+
},
37873865
{
37883866
"slug": "get-project-field-for-organization",
37893867
"subcategory": "fields",

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

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,50 @@
108108
"title": "Administration",
109109
"displayTitle": "Organization permissions for \"Administration\"",
110110
"permissions": [
111+
{
112+
"category": "actions",
113+
"slug": "get-github-actions-cache-retention-limit-for-an-organization",
114+
"subcategory": "cache",
115+
"verb": "get",
116+
"requestPath": "/organizations/{org}/actions/cache/retention-limit",
117+
"access": "read",
118+
"user-to-server": true,
119+
"server-to-server": true,
120+
"additional-permissions": false
121+
},
122+
{
123+
"category": "actions",
124+
"slug": "set-github-actions-cache-retention-limit-for-an-organization",
125+
"subcategory": "cache",
126+
"verb": "put",
127+
"requestPath": "/organizations/{org}/actions/cache/retention-limit",
128+
"access": "write",
129+
"user-to-server": true,
130+
"server-to-server": true,
131+
"additional-permissions": false
132+
},
133+
{
134+
"category": "actions",
135+
"slug": "get-github-actions-cache-storage-limit-for-an-organization",
136+
"subcategory": "cache",
137+
"verb": "get",
138+
"requestPath": "/organizations/{org}/actions/cache/storage-limit",
139+
"access": "read",
140+
"user-to-server": true,
141+
"server-to-server": true,
142+
"additional-permissions": false
143+
},
144+
{
145+
"category": "actions",
146+
"slug": "set-github-actions-cache-storage-limit-for-an-organization",
147+
"subcategory": "cache",
148+
"verb": "put",
149+
"requestPath": "/organizations/{org}/actions/cache/storage-limit",
150+
"access": "write",
151+
"user-to-server": true,
152+
"server-to-server": true,
153+
"additional-permissions": false
154+
},
111155
{
112156
"category": "dependabot",
113157
"slug": "lists-the-repositories-dependabot-can-access-in-an-organization",
@@ -2862,6 +2906,17 @@
28622906
"server-to-server": true,
28632907
"additional-permissions": false
28642908
},
2909+
{
2910+
"category": "projects",
2911+
"slug": "add-a-field-to-an-organization-owned-project",
2912+
"subcategory": "fields",
2913+
"verb": "post",
2914+
"requestPath": "/orgs/{org}/projectsV2/{project_number}/fields",
2915+
"access": "write",
2916+
"user-to-server": true,
2917+
"server-to-server": true,
2918+
"additional-permissions": false
2919+
},
28652920
{
28662921
"category": "projects",
28672922
"slug": "get-project-field-for-organization",
@@ -4444,6 +4499,50 @@
44444499
"server-to-server": true,
44454500
"additional-permissions": false
44464501
},
4502+
{
4503+
"category": "actions",
4504+
"slug": "get-github-actions-cache-retention-limit-for-a-repository",
4505+
"subcategory": "cache",
4506+
"verb": "get",
4507+
"requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit",
4508+
"access": "read",
4509+
"user-to-server": true,
4510+
"server-to-server": true,
4511+
"additional-permissions": false
4512+
},
4513+
{
4514+
"category": "actions",
4515+
"slug": "set-github-actions-cache-retention-limit-for-a-repository",
4516+
"subcategory": "cache",
4517+
"verb": "put",
4518+
"requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit",
4519+
"access": "write",
4520+
"user-to-server": true,
4521+
"server-to-server": true,
4522+
"additional-permissions": false
4523+
},
4524+
{
4525+
"category": "actions",
4526+
"slug": "get-github-actions-cache-storage-limit-for-a-repository",
4527+
"subcategory": "cache",
4528+
"verb": "get",
4529+
"requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit",
4530+
"access": "read",
4531+
"user-to-server": true,
4532+
"server-to-server": true,
4533+
"additional-permissions": false
4534+
},
4535+
{
4536+
"category": "actions",
4537+
"slug": "set-github-actions-cache-storage-limit-for-a-repository",
4538+
"subcategory": "cache",
4539+
"verb": "put",
4540+
"requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit",
4541+
"access": "write",
4542+
"user-to-server": true,
4543+
"server-to-server": true,
4544+
"additional-permissions": false
4545+
},
44474546
{
44484547
"category": "actions",
44494548
"slug": "get-github-actions-permissions-for-a-repository",

0 commit comments

Comments
 (0)