Skip to content

Commit 638e05b

Browse files
authored
Sync REST API schema to 2026-03-10 + hardcode 2022-11-28 initial version (#60170)
1 parent 21cac4c commit 638e05b

File tree

76 files changed

+1844719
-432
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1844719
-432
lines changed

content/rest/issues/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ children:
1616
- /assignees
1717
- /comments
1818
- /events
19-
- /issues
2019
- /issue-dependencies
20+
- /issue-field-values
21+
- /issues
2122
- /labels
2223
- /milestones
2324
- /sub-issues
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: REST API endpoints for issue field values
3+
shortTitle: Issue field values
4+
intro: Use the REST API to view and manage issue field values for issues.
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
ghes: '*'
9+
topics:
10+
- API
11+
autogenerated: rest
12+
allowTitleToDifferFromFilename: true
13+
---
14+
15+
<!-- Content after this section is automatically generated -->

content/rest/orgs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ children:
2121
- /custom-properties
2222
- /custom-properties-for-orgs
2323
- /custom-roles
24+
- /issue-fields
2425
- /issue-types
2526
- /members
2627
- /network-configurations

content/rest/orgs/issue-fields.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 fields
3+
shortTitle: Issue fields
4+
intro: Use the REST API to create and manage issue fields for 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+
<!-- Content after this section is automatically generated -->

data/reusables/rest-api/breaking-changes-changelog.md

Lines changed: 1288 additions & 0 deletions
Large diffs are not rendered by default.

src/article-api/tests/rest-transformer.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ describe('REST transformer', () => {
123123
expect(res.statusCode).toBe(200)
124124

125125
// Check for API version header in curl example
126-
expect(res.body).toContain('-H "X-GitHub-Api-Version: 2022-11-28"')
126+
expect(res.body).toContain('-H "X-GitHub-Api-Version: 2026-03-10"')
127127
})
128128

129129
test('Code examples include specified API version', async () => {
@@ -233,7 +233,7 @@ describe('REST transformer', () => {
233233

234234
expect(res.statusCode).toBe(200)
235235
// Should include the default API version header
236-
expect(res.body).toContain('-H "X-GitHub-Api-Version: 2022-11-28"')
236+
expect(res.body).toContain('-H "X-GitHub-Api-Version: 2026-03-10"')
237237
})
238238

239239
test('Multiple operations on a page are all rendered', async () => {

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

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1328,6 +1328,48 @@
13281328
}
13291329
]
13301330
},
1331+
"issue_fields": {
1332+
"title": "Issue Fields",
1333+
"displayTitle": "Organization permissions for \"Issue Fields\"",
1334+
"permissions": [
1335+
{
1336+
"category": "orgs",
1337+
"slug": "list-issue-fields-for-an-organization",
1338+
"subcategory": "issue-fields",
1339+
"verb": "get",
1340+
"requestPath": "/orgs/{org}/issue-fields",
1341+
"additional-permissions": false,
1342+
"access": "read"
1343+
},
1344+
{
1345+
"category": "orgs",
1346+
"slug": "create-issue-field-for-an-organization",
1347+
"subcategory": "issue-fields",
1348+
"verb": "post",
1349+
"requestPath": "/orgs/{org}/issue-fields",
1350+
"additional-permissions": false,
1351+
"access": "write"
1352+
},
1353+
{
1354+
"category": "orgs",
1355+
"slug": "update-issue-field-for-an-organization",
1356+
"subcategory": "issue-fields",
1357+
"verb": "patch",
1358+
"requestPath": "/orgs/{org}/issue-fields/{issue_field_id}",
1359+
"additional-permissions": false,
1360+
"access": "write"
1361+
},
1362+
{
1363+
"category": "orgs",
1364+
"slug": "delete-issue-field-for-an-organization",
1365+
"subcategory": "issue-fields",
1366+
"verb": "delete",
1367+
"requestPath": "/orgs/{org}/issue-fields/{issue_field_id}",
1368+
"additional-permissions": false,
1369+
"access": "write"
1370+
}
1371+
]
1372+
},
13311373
"issue_types": {
13321374
"title": "Issue Types",
13331375
"displayTitle": "Organization permissions for \"Issue Types\"",
@@ -6348,6 +6390,15 @@
63486390
"additional-permissions": true,
63496391
"access": "read"
63506392
},
6393+
{
6394+
"category": "issues",
6395+
"slug": "list-issue-field-values-for-an-issue",
6396+
"subcategory": "issue-field-values",
6397+
"verb": "get",
6398+
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values",
6399+
"additional-permissions": false,
6400+
"access": "read"
6401+
},
63516402
{
63526403
"category": "issues",
63536404
"slug": "list-labels-for-an-issue",
@@ -6590,6 +6641,33 @@
65906641
"requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels",
65916642
"additional-permissions": true,
65926643
"access": "read"
6644+
},
6645+
{
6646+
"category": "issues",
6647+
"slug": "add-issue-field-values-to-an-issue",
6648+
"subcategory": "issue-field-values",
6649+
"verb": "post",
6650+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values",
6651+
"additional-permissions": true,
6652+
"access": "write"
6653+
},
6654+
{
6655+
"category": "issues",
6656+
"slug": "set-issue-field-values-for-an-issue",
6657+
"subcategory": "issue-field-values",
6658+
"verb": "put",
6659+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values",
6660+
"additional-permissions": true,
6661+
"access": "write"
6662+
},
6663+
{
6664+
"category": "issues",
6665+
"slug": "delete-an-issue-field-value-from-an-issue",
6666+
"subcategory": "issue-field-values",
6667+
"verb": "delete",
6668+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}",
6669+
"additional-permissions": true,
6670+
"access": "write"
65936671
}
65946672
]
65956673
},
@@ -7571,6 +7649,33 @@
75717649
"requestPath": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch",
75727650
"additional-permissions": false,
75737651
"access": "write"
7652+
},
7653+
{
7654+
"category": "issues",
7655+
"slug": "add-issue-field-values-to-an-issue",
7656+
"subcategory": "issue-field-values",
7657+
"verb": "post",
7658+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values",
7659+
"additional-permissions": true,
7660+
"access": "write"
7661+
},
7662+
{
7663+
"category": "issues",
7664+
"slug": "set-issue-field-values-for-an-issue",
7665+
"subcategory": "issue-field-values",
7666+
"verb": "put",
7667+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values",
7668+
"additional-permissions": true,
7669+
"access": "write"
7670+
},
7671+
{
7672+
"category": "issues",
7673+
"slug": "delete-an-issue-field-value-from-an-issue",
7674+
"subcategory": "issue-field-values",
7675+
"verb": "delete",
7676+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}",
7677+
"additional-permissions": true,
7678+
"access": "write"
75747679
}
75757680
]
75767681
},

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

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2820,6 +2820,12 @@
28202820
"verb": "get",
28212821
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/events"
28222822
},
2823+
{
2824+
"slug": "list-issue-field-values-for-an-issue",
2825+
"subcategory": "issue-field-values",
2826+
"verb": "get",
2827+
"requestPath": "/repos/{owner}/{repo}/issues/{issue_number}/issue-field-values"
2828+
},
28232829
{
28242830
"slug": "list-labels-for-an-issue",
28252831
"subcategory": "labels",
@@ -2963,6 +2969,24 @@
29632969
"subcategory": "labels",
29642970
"verb": "get",
29652971
"requestPath": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels"
2972+
},
2973+
{
2974+
"slug": "add-issue-field-values-to-an-issue",
2975+
"subcategory": "issue-field-values",
2976+
"verb": "post",
2977+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values"
2978+
},
2979+
{
2980+
"slug": "set-issue-field-values-for-an-issue",
2981+
"subcategory": "issue-field-values",
2982+
"verb": "put",
2983+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values"
2984+
},
2985+
{
2986+
"slug": "delete-an-issue-field-value-from-an-issue",
2987+
"subcategory": "issue-field-values",
2988+
"verb": "delete",
2989+
"requestPath": "/repositories/{repository_id}/issues/{issue_number}/issue-field-values/{issue_field_id}"
29662990
}
29672991
],
29682992
"licenses": [
@@ -3340,6 +3364,30 @@
33403364
"verb": "get",
33413365
"requestPath": "/orgs/{org}/invitations/{invitation_id}/teams"
33423366
},
3367+
{
3368+
"slug": "list-issue-fields-for-an-organization",
3369+
"subcategory": "issue-fields",
3370+
"verb": "get",
3371+
"requestPath": "/orgs/{org}/issue-fields"
3372+
},
3373+
{
3374+
"slug": "create-issue-field-for-an-organization",
3375+
"subcategory": "issue-fields",
3376+
"verb": "post",
3377+
"requestPath": "/orgs/{org}/issue-fields"
3378+
},
3379+
{
3380+
"slug": "update-issue-field-for-an-organization",
3381+
"subcategory": "issue-fields",
3382+
"verb": "patch",
3383+
"requestPath": "/orgs/{org}/issue-fields/{issue_field_id}"
3384+
},
3385+
{
3386+
"slug": "delete-issue-field-for-an-organization",
3387+
"subcategory": "issue-fields",
3388+
"verb": "delete",
3389+
"requestPath": "/orgs/{org}/issue-fields/{issue_field_id}"
3390+
},
33433391
{
33443392
"slug": "list-issue-types-for-an-organization",
33453393
"subcategory": "issue-types",

0 commit comments

Comments
 (0)