Skip to content

Commit 570e20a

Browse files
docs-botsubatoi
andauthored
Update OpenAPI Description (#58338)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent 85dadf0 commit 570e20a

File tree

19 files changed

+2916
-13673
lines changed

19 files changed

+2916
-13673
lines changed

content/rest/projects-classic/projects.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
2-
title: 'REST API endpoints for {% data variables.product.prodname_projects_v1_caps %}'
2+
title: REST API endpoints for {% data variables.product.prodname_projects_v1_caps %}
33
shortTitle: Boards
44
allowTitleToDifferFromFilename: true
55
intro: >-
66
Use the REST API to create and manage {% data
77
variables.projects.projects_v1_boards %} in a repository.
88
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
9-
fpt: '*'
10-
ghec: '*'
11-
ghes: '*'
9+
ghes: <=3.16
1210
topics:
1311
- API
1412
autogenerated: rest

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

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,42 @@
117117
"additional-permissions": false,
118118
"access": "write"
119119
},
120+
{
121+
"category": "billing",
122+
"slug": "get-all-budgets-for-an-organization",
123+
"subcategory": "enhanced-billing",
124+
"verb": "get",
125+
"requestPath": "/organizations/{org}/settings/billing/budgets",
126+
"additional-permissions": false,
127+
"access": "read"
128+
},
129+
{
130+
"category": "billing",
131+
"slug": "get-a-budget-by-id-for-an-organization",
132+
"subcategory": "enhanced-billing",
133+
"verb": "get",
134+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
135+
"additional-permissions": false,
136+
"access": "read"
137+
},
138+
{
139+
"category": "billing",
140+
"slug": "update-a-budget-for-an-organization",
141+
"subcategory": "enhanced-billing",
142+
"verb": "patch",
143+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
144+
"additional-permissions": false,
145+
"access": "write"
146+
},
147+
{
148+
"category": "billing",
149+
"slug": "delete-a-budget-for-an-organization",
150+
"subcategory": "enhanced-billing",
151+
"verb": "delete",
152+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
153+
"additional-permissions": false,
154+
"access": "write"
155+
},
120156
{
121157
"category": "billing",
122158
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -137,7 +173,7 @@
137173
},
138174
{
139175
"category": "billing",
140-
"slug": "get-billing-usage-summary-report-for-an-organization",
176+
"slug": "get-billing-usage-summary-for-an-organization",
141177
"subcategory": "enhanced-billing",
142178
"verb": "get",
143179
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -8708,7 +8744,7 @@
87088744
},
87098745
{
87108746
"category": "billing",
8711-
"slug": "get-billing-usage-summary-report-for-a-user",
8747+
"slug": "get-billing-usage-summary-for-a-user",
87128748
"subcategory": "enhanced-billing",
87138749
"verb": "get",
87148750
"requestPath": "/users/{username}/settings/billing/usage/summary",

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

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1108,6 +1108,30 @@
11081108
}
11091109
],
11101110
"billing": [
1111+
{
1112+
"slug": "get-all-budgets-for-an-organization",
1113+
"subcategory": "enhanced-billing",
1114+
"verb": "get",
1115+
"requestPath": "/organizations/{org}/settings/billing/budgets"
1116+
},
1117+
{
1118+
"slug": "get-a-budget-by-id-for-an-organization",
1119+
"subcategory": "enhanced-billing",
1120+
"verb": "get",
1121+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1122+
},
1123+
{
1124+
"slug": "update-a-budget-for-an-organization",
1125+
"subcategory": "enhanced-billing",
1126+
"verb": "patch",
1127+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1128+
},
1129+
{
1130+
"slug": "delete-a-budget-for-an-organization",
1131+
"subcategory": "enhanced-billing",
1132+
"verb": "delete",
1133+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1134+
},
11111135
{
11121136
"slug": "get-billing-premium-request-usage-report-for-an-organization",
11131137
"subcategory": "enhanced-billing",
@@ -1121,7 +1145,7 @@
11211145
"requestPath": "/organizations/{org}/settings/billing/usage"
11221146
},
11231147
{
1124-
"slug": "get-billing-usage-summary-report-for-an-organization",
1148+
"slug": "get-billing-usage-summary-for-an-organization",
11251149
"subcategory": "enhanced-billing",
11261150
"verb": "get",
11271151
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1175,7 +1199,7 @@
11751199
"requestPath": "/users/{username}/settings/billing/usage"
11761200
},
11771201
{
1178-
"slug": "get-billing-usage-summary-report-for-a-user",
1202+
"slug": "get-billing-usage-summary-for-a-user",
11791203
"subcategory": "enhanced-billing",
11801204
"verb": "get",
11811205
"requestPath": "/users/{username}/settings/billing/usage/summary"

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

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,50 @@
141141
"server-to-server": true,
142142
"additional-permissions": false
143143
},
144+
{
145+
"category": "billing",
146+
"slug": "get-all-budgets-for-an-organization",
147+
"subcategory": "enhanced-billing",
148+
"verb": "get",
149+
"requestPath": "/organizations/{org}/settings/billing/budgets",
150+
"access": "read",
151+
"user-to-server": true,
152+
"server-to-server": true,
153+
"additional-permissions": false
154+
},
155+
{
156+
"category": "billing",
157+
"slug": "get-a-budget-by-id-for-an-organization",
158+
"subcategory": "enhanced-billing",
159+
"verb": "get",
160+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
161+
"access": "read",
162+
"user-to-server": true,
163+
"server-to-server": true,
164+
"additional-permissions": false
165+
},
166+
{
167+
"category": "billing",
168+
"slug": "update-a-budget-for-an-organization",
169+
"subcategory": "enhanced-billing",
170+
"verb": "patch",
171+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
172+
"access": "write",
173+
"user-to-server": true,
174+
"server-to-server": true,
175+
"additional-permissions": false
176+
},
177+
{
178+
"category": "billing",
179+
"slug": "delete-a-budget-for-an-organization",
180+
"subcategory": "enhanced-billing",
181+
"verb": "delete",
182+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
183+
"access": "write",
184+
"user-to-server": true,
185+
"server-to-server": true,
186+
"additional-permissions": false
187+
},
144188
{
145189
"category": "billing",
146190
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -165,7 +209,7 @@
165209
},
166210
{
167211
"category": "billing",
168-
"slug": "get-billing-usage-summary-report-for-an-organization",
212+
"slug": "get-billing-usage-summary-for-an-organization",
169213
"subcategory": "enhanced-billing",
170214
"verb": "get",
171215
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -10942,7 +10986,7 @@
1094210986
},
1094310987
{
1094410988
"category": "billing",
10945-
"slug": "get-billing-usage-summary-report-for-a-user",
10989+
"slug": "get-billing-usage-summary-for-a-user",
1094610990
"subcategory": "enhanced-billing",
1094710991
"verb": "get",
1094810992
"requestPath": "/users/{username}/settings/billing/usage/summary",

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

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1146,6 +1146,30 @@
11461146
}
11471147
],
11481148
"billing": [
1149+
{
1150+
"slug": "get-all-budgets-for-an-organization",
1151+
"subcategory": "enhanced-billing",
1152+
"verb": "get",
1153+
"requestPath": "/organizations/{org}/settings/billing/budgets"
1154+
},
1155+
{
1156+
"slug": "get-a-budget-by-id-for-an-organization",
1157+
"subcategory": "enhanced-billing",
1158+
"verb": "get",
1159+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1160+
},
1161+
{
1162+
"slug": "update-a-budget-for-an-organization",
1163+
"subcategory": "enhanced-billing",
1164+
"verb": "patch",
1165+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1166+
},
1167+
{
1168+
"slug": "delete-a-budget-for-an-organization",
1169+
"subcategory": "enhanced-billing",
1170+
"verb": "delete",
1171+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1172+
},
11491173
{
11501174
"slug": "get-billing-premium-request-usage-report-for-an-organization",
11511175
"subcategory": "enhanced-billing",
@@ -1159,7 +1183,7 @@
11591183
"requestPath": "/organizations/{org}/settings/billing/usage"
11601184
},
11611185
{
1162-
"slug": "get-billing-usage-summary-report-for-an-organization",
1186+
"slug": "get-billing-usage-summary-for-an-organization",
11631187
"subcategory": "enhanced-billing",
11641188
"verb": "get",
11651189
"requestPath": "/organizations/{org}/settings/billing/usage/summary"

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

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,6 +1188,30 @@
11881188
}
11891189
],
11901190
"billing": [
1191+
{
1192+
"slug": "get-all-budgets-for-an-organization",
1193+
"subcategory": "enhanced-billing",
1194+
"verb": "get",
1195+
"requestPath": "/organizations/{org}/settings/billing/budgets"
1196+
},
1197+
{
1198+
"slug": "get-a-budget-by-id-for-an-organization",
1199+
"subcategory": "enhanced-billing",
1200+
"verb": "get",
1201+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1202+
},
1203+
{
1204+
"slug": "update-a-budget-for-an-organization",
1205+
"subcategory": "enhanced-billing",
1206+
"verb": "patch",
1207+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1208+
},
1209+
{
1210+
"slug": "delete-a-budget-for-an-organization",
1211+
"subcategory": "enhanced-billing",
1212+
"verb": "delete",
1213+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1214+
},
11911215
{
11921216
"slug": "get-billing-premium-request-usage-report-for-an-organization",
11931217
"subcategory": "enhanced-billing",
@@ -1201,7 +1225,7 @@
12011225
"requestPath": "/organizations/{org}/settings/billing/usage"
12021226
},
12031227
{
1204-
"slug": "get-billing-usage-summary-report-for-an-organization",
1228+
"slug": "get-billing-usage-summary-for-an-organization",
12051229
"subcategory": "enhanced-billing",
12061230
"verb": "get",
12071231
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1255,7 +1279,7 @@
12551279
"requestPath": "/users/{username}/settings/billing/usage"
12561280
},
12571281
{
1258-
"slug": "get-billing-usage-summary-report-for-a-user",
1282+
"slug": "get-billing-usage-summary-for-a-user",
12591283
"subcategory": "enhanced-billing",
12601284
"verb": "get",
12611285
"requestPath": "/users/{username}/settings/billing/usage/summary"

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

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,42 @@
195195
"additional-permissions": false,
196196
"access": "write"
197197
},
198+
{
199+
"category": "billing",
200+
"slug": "get-all-budgets-for-an-organization",
201+
"subcategory": "enhanced-billing",
202+
"verb": "get",
203+
"requestPath": "/organizations/{org}/settings/billing/budgets",
204+
"additional-permissions": false,
205+
"access": "read"
206+
},
207+
{
208+
"category": "billing",
209+
"slug": "get-a-budget-by-id-for-an-organization",
210+
"subcategory": "enhanced-billing",
211+
"verb": "get",
212+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
213+
"additional-permissions": false,
214+
"access": "read"
215+
},
216+
{
217+
"category": "billing",
218+
"slug": "update-a-budget-for-an-organization",
219+
"subcategory": "enhanced-billing",
220+
"verb": "patch",
221+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
222+
"additional-permissions": false,
223+
"access": "write"
224+
},
225+
{
226+
"category": "billing",
227+
"slug": "delete-a-budget-for-an-organization",
228+
"subcategory": "enhanced-billing",
229+
"verb": "delete",
230+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}",
231+
"additional-permissions": false,
232+
"access": "write"
233+
},
198234
{
199235
"category": "billing",
200236
"slug": "get-billing-premium-request-usage-report-for-an-organization",
@@ -215,7 +251,7 @@
215251
},
216252
{
217253
"category": "billing",
218-
"slug": "get-billing-usage-summary-report-for-an-organization",
254+
"slug": "get-billing-usage-summary-for-an-organization",
219255
"subcategory": "enhanced-billing",
220256
"verb": "get",
221257
"requestPath": "/organizations/{org}/settings/billing/usage/summary",
@@ -9575,7 +9611,7 @@
95759611
},
95769612
{
95779613
"category": "billing",
9578-
"slug": "get-billing-usage-summary-report-for-a-user",
9614+
"slug": "get-billing-usage-summary-for-a-user",
95799615
"subcategory": "enhanced-billing",
95809616
"verb": "get",
95819617
"requestPath": "/users/{username}/settings/billing/usage/summary",

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

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1128,6 +1128,30 @@
11281128
}
11291129
],
11301130
"billing": [
1131+
{
1132+
"slug": "get-all-budgets-for-an-organization",
1133+
"subcategory": "enhanced-billing",
1134+
"verb": "get",
1135+
"requestPath": "/organizations/{org}/settings/billing/budgets"
1136+
},
1137+
{
1138+
"slug": "get-a-budget-by-id-for-an-organization",
1139+
"subcategory": "enhanced-billing",
1140+
"verb": "get",
1141+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1142+
},
1143+
{
1144+
"slug": "update-a-budget-for-an-organization",
1145+
"subcategory": "enhanced-billing",
1146+
"verb": "patch",
1147+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1148+
},
1149+
{
1150+
"slug": "delete-a-budget-for-an-organization",
1151+
"subcategory": "enhanced-billing",
1152+
"verb": "delete",
1153+
"requestPath": "/organizations/{org}/settings/billing/budgets/{budget_id}"
1154+
},
11311155
{
11321156
"slug": "get-billing-premium-request-usage-report-for-an-organization",
11331157
"subcategory": "enhanced-billing",
@@ -1141,7 +1165,7 @@
11411165
"requestPath": "/organizations/{org}/settings/billing/usage"
11421166
},
11431167
{
1144-
"slug": "get-billing-usage-summary-report-for-an-organization",
1168+
"slug": "get-billing-usage-summary-for-an-organization",
11451169
"subcategory": "enhanced-billing",
11461170
"verb": "get",
11471171
"requestPath": "/organizations/{org}/settings/billing/usage/summary"
@@ -1201,7 +1225,7 @@
12011225
"requestPath": "/users/{username}/settings/billing/usage"
12021226
},
12031227
{
1204-
"slug": "get-billing-usage-summary-report-for-a-user",
1228+
"slug": "get-billing-usage-summary-for-a-user",
12051229
"subcategory": "enhanced-billing",
12061230
"verb": "get",
12071231
"requestPath": "/users/{username}/settings/billing/usage/summary"

0 commit comments

Comments
 (0)