Skip to content

Commit 31b3746

Browse files
Update OpenAPI 3.1 Descriptions
1 parent 2b6e93c commit 31b3746

24 files changed

+3384
-0
lines changed

descriptions-next/api.github.com/api.github.com.2022-11-28.json

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60254,6 +60254,94 @@
6025460254
}
6025560255
}
6025660256
},
60257+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
60258+
"put": {
60259+
"summary": "Archive a pull request",
60260+
"description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.",
60261+
"tags": [
60262+
"pulls"
60263+
],
60264+
"operationId": "pulls/archive",
60265+
"externalDocs": {
60266+
"description": "API method documentation",
60267+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
60268+
},
60269+
"parameters": [
60270+
{
60271+
"$ref": "#/components/parameters/owner"
60272+
},
60273+
{
60274+
"$ref": "#/components/parameters/repo"
60275+
},
60276+
{
60277+
"$ref": "#/components/parameters/pull-number"
60278+
}
60279+
],
60280+
"responses": {
60281+
"204": {
60282+
"description": "Response"
60283+
},
60284+
"403": {
60285+
"$ref": "#/components/responses/forbidden"
60286+
},
60287+
"404": {
60288+
"$ref": "#/components/responses/not_found"
60289+
},
60290+
"422": {
60291+
"$ref": "#/components/responses/validation_failed"
60292+
}
60293+
},
60294+
"x-github": {
60295+
"githubCloudOnly": false,
60296+
"enabledForGitHubApps": true,
60297+
"category": "pulls",
60298+
"subcategory": "pulls"
60299+
}
60300+
},
60301+
"delete": {
60302+
"summary": "Unarchive a pull request",
60303+
"description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.",
60304+
"tags": [
60305+
"pulls"
60306+
],
60307+
"operationId": "pulls/unarchive",
60308+
"externalDocs": {
60309+
"description": "API method documentation",
60310+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
60311+
},
60312+
"parameters": [
60313+
{
60314+
"$ref": "#/components/parameters/owner"
60315+
},
60316+
{
60317+
"$ref": "#/components/parameters/repo"
60318+
},
60319+
{
60320+
"$ref": "#/components/parameters/pull-number"
60321+
}
60322+
],
60323+
"responses": {
60324+
"204": {
60325+
"description": "Response"
60326+
},
60327+
"403": {
60328+
"$ref": "#/components/responses/forbidden"
60329+
},
60330+
"404": {
60331+
"$ref": "#/components/responses/not_found"
60332+
},
60333+
"422": {
60334+
"$ref": "#/components/responses/validation_failed"
60335+
}
60336+
},
60337+
"x-github": {
60338+
"githubCloudOnly": false,
60339+
"enabledForGitHubApps": true,
60340+
"category": "pulls",
60341+
"subcategory": "pulls"
60342+
}
60343+
}
60344+
},
6025760345
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
6025860346
"post": {
6025960347
"summary": "Create a codespace from a pull request",

descriptions-next/api.github.com/api.github.com.2022-11-28.yaml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43797,6 +43797,67 @@ paths:
4379743797
enabledForGitHubApps: true
4379843798
category: pulls
4379943799
subcategory: pulls
43800+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
43801+
put:
43802+
summary: Archive a pull request
43803+
description: |-
43804+
Archives a pull request. Closes, locks, and marks the pull request as archived.
43805+
Only repository admins can archive pull requests.
43806+
Archived pull requests are hidden from non-admin users.
43807+
tags:
43808+
- pulls
43809+
operationId: pulls/archive
43810+
externalDocs:
43811+
description: API method documentation
43812+
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
43813+
parameters:
43814+
- "$ref": "#/components/parameters/owner"
43815+
- "$ref": "#/components/parameters/repo"
43816+
- "$ref": "#/components/parameters/pull-number"
43817+
responses:
43818+
'204':
43819+
description: Response
43820+
'403':
43821+
"$ref": "#/components/responses/forbidden"
43822+
'404':
43823+
"$ref": "#/components/responses/not_found"
43824+
'422':
43825+
"$ref": "#/components/responses/validation_failed"
43826+
x-github:
43827+
githubCloudOnly: false
43828+
enabledForGitHubApps: true
43829+
category: pulls
43830+
subcategory: pulls
43831+
delete:
43832+
summary: Unarchive a pull request
43833+
description: |-
43834+
Unarchives a pull request. Removes the archived flag from the pull request.
43835+
Does not automatically reopen or unlock the pull request.
43836+
Only repository admins can unarchive pull requests.
43837+
tags:
43838+
- pulls
43839+
operationId: pulls/unarchive
43840+
externalDocs:
43841+
description: API method documentation
43842+
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
43843+
parameters:
43844+
- "$ref": "#/components/parameters/owner"
43845+
- "$ref": "#/components/parameters/repo"
43846+
- "$ref": "#/components/parameters/pull-number"
43847+
responses:
43848+
'204':
43849+
description: Response
43850+
'403':
43851+
"$ref": "#/components/responses/forbidden"
43852+
'404':
43853+
"$ref": "#/components/responses/not_found"
43854+
'422':
43855+
"$ref": "#/components/responses/validation_failed"
43856+
x-github:
43857+
githubCloudOnly: false
43858+
enabledForGitHubApps: true
43859+
category: pulls
43860+
subcategory: pulls
4380043861
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
4380143862
post:
4380243863
summary: Create a codespace from a pull request

descriptions-next/api.github.com/api.github.com.2026-03-10.json

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60165,6 +60165,94 @@
6016560165
}
6016660166
}
6016760167
},
60168+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
60169+
"put": {
60170+
"summary": "Archive a pull request",
60171+
"description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.",
60172+
"tags": [
60173+
"pulls"
60174+
],
60175+
"operationId": "pulls/archive",
60176+
"externalDocs": {
60177+
"description": "API method documentation",
60178+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
60179+
},
60180+
"parameters": [
60181+
{
60182+
"$ref": "#/components/parameters/owner"
60183+
},
60184+
{
60185+
"$ref": "#/components/parameters/repo"
60186+
},
60187+
{
60188+
"$ref": "#/components/parameters/pull-number"
60189+
}
60190+
],
60191+
"responses": {
60192+
"204": {
60193+
"description": "Response"
60194+
},
60195+
"403": {
60196+
"$ref": "#/components/responses/forbidden"
60197+
},
60198+
"404": {
60199+
"$ref": "#/components/responses/not_found"
60200+
},
60201+
"422": {
60202+
"$ref": "#/components/responses/validation_failed"
60203+
}
60204+
},
60205+
"x-github": {
60206+
"githubCloudOnly": false,
60207+
"enabledForGitHubApps": true,
60208+
"category": "pulls",
60209+
"subcategory": "pulls"
60210+
}
60211+
},
60212+
"delete": {
60213+
"summary": "Unarchive a pull request",
60214+
"description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.",
60215+
"tags": [
60216+
"pulls"
60217+
],
60218+
"operationId": "pulls/unarchive",
60219+
"externalDocs": {
60220+
"description": "API method documentation",
60221+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
60222+
},
60223+
"parameters": [
60224+
{
60225+
"$ref": "#/components/parameters/owner"
60226+
},
60227+
{
60228+
"$ref": "#/components/parameters/repo"
60229+
},
60230+
{
60231+
"$ref": "#/components/parameters/pull-number"
60232+
}
60233+
],
60234+
"responses": {
60235+
"204": {
60236+
"description": "Response"
60237+
},
60238+
"403": {
60239+
"$ref": "#/components/responses/forbidden"
60240+
},
60241+
"404": {
60242+
"$ref": "#/components/responses/not_found"
60243+
},
60244+
"422": {
60245+
"$ref": "#/components/responses/validation_failed"
60246+
}
60247+
},
60248+
"x-github": {
60249+
"githubCloudOnly": false,
60250+
"enabledForGitHubApps": true,
60251+
"category": "pulls",
60252+
"subcategory": "pulls"
60253+
}
60254+
}
60255+
},
6016860256
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
6016960257
"post": {
6017060258
"summary": "Create a codespace from a pull request",

descriptions-next/api.github.com/api.github.com.2026-03-10.yaml

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43723,6 +43723,67 @@ paths:
4372343723
enabledForGitHubApps: true
4372443724
category: pulls
4372543725
subcategory: pulls
43726+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
43727+
put:
43728+
summary: Archive a pull request
43729+
description: |-
43730+
Archives a pull request. Closes, locks, and marks the pull request as archived.
43731+
Only repository admins can archive pull requests.
43732+
Archived pull requests are hidden from non-admin users.
43733+
tags:
43734+
- pulls
43735+
operationId: pulls/archive
43736+
externalDocs:
43737+
description: API method documentation
43738+
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
43739+
parameters:
43740+
- "$ref": "#/components/parameters/owner"
43741+
- "$ref": "#/components/parameters/repo"
43742+
- "$ref": "#/components/parameters/pull-number"
43743+
responses:
43744+
'204':
43745+
description: Response
43746+
'403':
43747+
"$ref": "#/components/responses/forbidden"
43748+
'404':
43749+
"$ref": "#/components/responses/not_found"
43750+
'422':
43751+
"$ref": "#/components/responses/validation_failed"
43752+
x-github:
43753+
githubCloudOnly: false
43754+
enabledForGitHubApps: true
43755+
category: pulls
43756+
subcategory: pulls
43757+
delete:
43758+
summary: Unarchive a pull request
43759+
description: |-
43760+
Unarchives a pull request. Removes the archived flag from the pull request.
43761+
Does not automatically reopen or unlock the pull request.
43762+
Only repository admins can unarchive pull requests.
43763+
tags:
43764+
- pulls
43765+
operationId: pulls/unarchive
43766+
externalDocs:
43767+
description: API method documentation
43768+
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
43769+
parameters:
43770+
- "$ref": "#/components/parameters/owner"
43771+
- "$ref": "#/components/parameters/repo"
43772+
- "$ref": "#/components/parameters/pull-number"
43773+
responses:
43774+
'204':
43775+
description: Response
43776+
'403':
43777+
"$ref": "#/components/responses/forbidden"
43778+
'404':
43779+
"$ref": "#/components/responses/not_found"
43780+
'422':
43781+
"$ref": "#/components/responses/validation_failed"
43782+
x-github:
43783+
githubCloudOnly: false
43784+
enabledForGitHubApps: true
43785+
category: pulls
43786+
subcategory: pulls
4372643787
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
4372743788
post:
4372843789
summary: Create a codespace from a pull request

0 commit comments

Comments
 (0)