Skip to content

Commit 95c3dc7

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 2b6e93c commit 95c3dc7

24 files changed

+3312
-0
lines changed

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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59967,6 +59967,94 @@
5996759967
}
5996859968
}
5996959969
},
59970+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
59971+
"put": {
59972+
"summary": "Archive a pull request",
59973+
"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.",
59974+
"tags": [
59975+
"pulls"
59976+
],
59977+
"operationId": "pulls/archive",
59978+
"externalDocs": {
59979+
"description": "API method documentation",
59980+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
59981+
},
59982+
"parameters": [
59983+
{
59984+
"$ref": "#/components/parameters/owner"
59985+
},
59986+
{
59987+
"$ref": "#/components/parameters/repo"
59988+
},
59989+
{
59990+
"$ref": "#/components/parameters/pull-number"
59991+
}
59992+
],
59993+
"responses": {
59994+
"204": {
59995+
"description": "Response"
59996+
},
59997+
"403": {
59998+
"$ref": "#/components/responses/forbidden"
59999+
},
60000+
"404": {
60001+
"$ref": "#/components/responses/not_found"
60002+
},
60003+
"422": {
60004+
"$ref": "#/components/responses/validation_failed"
60005+
}
60006+
},
60007+
"x-github": {
60008+
"githubCloudOnly": false,
60009+
"enabledForGitHubApps": true,
60010+
"category": "pulls",
60011+
"subcategory": "pulls"
60012+
}
60013+
},
60014+
"delete": {
60015+
"summary": "Unarchive a pull request",
60016+
"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.",
60017+
"tags": [
60018+
"pulls"
60019+
],
60020+
"operationId": "pulls/unarchive",
60021+
"externalDocs": {
60022+
"description": "API method documentation",
60023+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
60024+
},
60025+
"parameters": [
60026+
{
60027+
"$ref": "#/components/parameters/owner"
60028+
},
60029+
{
60030+
"$ref": "#/components/parameters/repo"
60031+
},
60032+
{
60033+
"$ref": "#/components/parameters/pull-number"
60034+
}
60035+
],
60036+
"responses": {
60037+
"204": {
60038+
"description": "Response"
60039+
},
60040+
"403": {
60041+
"$ref": "#/components/responses/forbidden"
60042+
},
60043+
"404": {
60044+
"$ref": "#/components/responses/not_found"
60045+
},
60046+
"422": {
60047+
"$ref": "#/components/responses/validation_failed"
60048+
}
60049+
},
60050+
"x-github": {
60051+
"githubCloudOnly": false,
60052+
"enabledForGitHubApps": true,
60053+
"category": "pulls",
60054+
"subcategory": "pulls"
60055+
}
60056+
}
60057+
},
5997060058
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
5997160059
"post": {
5997260060
"summary": "Create a codespace from a pull request",

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43651,6 +43651,67 @@ paths:
4365143651
enabledForGitHubApps: true
4365243652
category: pulls
4365343653
subcategory: pulls
43654+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
43655+
put:
43656+
summary: Archive a pull request
43657+
description: |-
43658+
Archives a pull request. Closes, locks, and marks the pull request as archived.
43659+
Only repository admins can archive pull requests.
43660+
Archived pull requests are hidden from non-admin users.
43661+
tags:
43662+
- pulls
43663+
operationId: pulls/archive
43664+
externalDocs:
43665+
description: API method documentation
43666+
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
43667+
parameters:
43668+
- "$ref": "#/components/parameters/owner"
43669+
- "$ref": "#/components/parameters/repo"
43670+
- "$ref": "#/components/parameters/pull-number"
43671+
responses:
43672+
'204':
43673+
description: Response
43674+
'403':
43675+
"$ref": "#/components/responses/forbidden"
43676+
'404':
43677+
"$ref": "#/components/responses/not_found"
43678+
'422':
43679+
"$ref": "#/components/responses/validation_failed"
43680+
x-github:
43681+
githubCloudOnly: false
43682+
enabledForGitHubApps: true
43683+
category: pulls
43684+
subcategory: pulls
43685+
delete:
43686+
summary: Unarchive a pull request
43687+
description: |-
43688+
Unarchives a pull request. Removes the archived flag from the pull request.
43689+
Does not automatically reopen or unlock the pull request.
43690+
Only repository admins can unarchive pull requests.
43691+
tags:
43692+
- pulls
43693+
operationId: pulls/unarchive
43694+
externalDocs:
43695+
description: API method documentation
43696+
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
43697+
parameters:
43698+
- "$ref": "#/components/parameters/owner"
43699+
- "$ref": "#/components/parameters/repo"
43700+
- "$ref": "#/components/parameters/pull-number"
43701+
responses:
43702+
'204':
43703+
description: Response
43704+
'403':
43705+
"$ref": "#/components/responses/forbidden"
43706+
'404':
43707+
"$ref": "#/components/responses/not_found"
43708+
'422':
43709+
"$ref": "#/components/responses/validation_failed"
43710+
x-github:
43711+
githubCloudOnly: false
43712+
enabledForGitHubApps: true
43713+
category: pulls
43714+
subcategory: pulls
4365443715
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
4365543716
post:
4365643717
summary: Create a codespace from a pull request

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

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59884,6 +59884,94 @@
5988459884
}
5988559885
}
5988659886
},
59887+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
59888+
"put": {
59889+
"summary": "Archive a pull request",
59890+
"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.",
59891+
"tags": [
59892+
"pulls"
59893+
],
59894+
"operationId": "pulls/archive",
59895+
"externalDocs": {
59896+
"description": "API method documentation",
59897+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
59898+
},
59899+
"parameters": [
59900+
{
59901+
"$ref": "#/components/parameters/owner"
59902+
},
59903+
{
59904+
"$ref": "#/components/parameters/repo"
59905+
},
59906+
{
59907+
"$ref": "#/components/parameters/pull-number"
59908+
}
59909+
],
59910+
"responses": {
59911+
"204": {
59912+
"description": "Response"
59913+
},
59914+
"403": {
59915+
"$ref": "#/components/responses/forbidden"
59916+
},
59917+
"404": {
59918+
"$ref": "#/components/responses/not_found"
59919+
},
59920+
"422": {
59921+
"$ref": "#/components/responses/validation_failed"
59922+
}
59923+
},
59924+
"x-github": {
59925+
"githubCloudOnly": false,
59926+
"enabledForGitHubApps": true,
59927+
"category": "pulls",
59928+
"subcategory": "pulls"
59929+
}
59930+
},
59931+
"delete": {
59932+
"summary": "Unarchive a pull request",
59933+
"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.",
59934+
"tags": [
59935+
"pulls"
59936+
],
59937+
"operationId": "pulls/unarchive",
59938+
"externalDocs": {
59939+
"description": "API method documentation",
59940+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
59941+
},
59942+
"parameters": [
59943+
{
59944+
"$ref": "#/components/parameters/owner"
59945+
},
59946+
{
59947+
"$ref": "#/components/parameters/repo"
59948+
},
59949+
{
59950+
"$ref": "#/components/parameters/pull-number"
59951+
}
59952+
],
59953+
"responses": {
59954+
"204": {
59955+
"description": "Response"
59956+
},
59957+
"403": {
59958+
"$ref": "#/components/responses/forbidden"
59959+
},
59960+
"404": {
59961+
"$ref": "#/components/responses/not_found"
59962+
},
59963+
"422": {
59964+
"$ref": "#/components/responses/validation_failed"
59965+
}
59966+
},
59967+
"x-github": {
59968+
"githubCloudOnly": false,
59969+
"enabledForGitHubApps": true,
59970+
"category": "pulls",
59971+
"subcategory": "pulls"
59972+
}
59973+
}
59974+
},
5988759975
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
5988859976
"post": {
5988959977
"summary": "Create a codespace from a pull request",

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43580,6 +43580,67 @@ paths:
4358043580
enabledForGitHubApps: true
4358143581
category: pulls
4358243582
subcategory: pulls
43583+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
43584+
put:
43585+
summary: Archive a pull request
43586+
description: |-
43587+
Archives a pull request. Closes, locks, and marks the pull request as archived.
43588+
Only repository admins can archive pull requests.
43589+
Archived pull requests are hidden from non-admin users.
43590+
tags:
43591+
- pulls
43592+
operationId: pulls/archive
43593+
externalDocs:
43594+
description: API method documentation
43595+
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
43596+
parameters:
43597+
- "$ref": "#/components/parameters/owner"
43598+
- "$ref": "#/components/parameters/repo"
43599+
- "$ref": "#/components/parameters/pull-number"
43600+
responses:
43601+
'204':
43602+
description: Response
43603+
'403':
43604+
"$ref": "#/components/responses/forbidden"
43605+
'404':
43606+
"$ref": "#/components/responses/not_found"
43607+
'422':
43608+
"$ref": "#/components/responses/validation_failed"
43609+
x-github:
43610+
githubCloudOnly: false
43611+
enabledForGitHubApps: true
43612+
category: pulls
43613+
subcategory: pulls
43614+
delete:
43615+
summary: Unarchive a pull request
43616+
description: |-
43617+
Unarchives a pull request. Removes the archived flag from the pull request.
43618+
Does not automatically reopen or unlock the pull request.
43619+
Only repository admins can unarchive pull requests.
43620+
tags:
43621+
- pulls
43622+
operationId: pulls/unarchive
43623+
externalDocs:
43624+
description: API method documentation
43625+
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
43626+
parameters:
43627+
- "$ref": "#/components/parameters/owner"
43628+
- "$ref": "#/components/parameters/repo"
43629+
- "$ref": "#/components/parameters/pull-number"
43630+
responses:
43631+
'204':
43632+
description: Response
43633+
'403':
43634+
"$ref": "#/components/responses/forbidden"
43635+
'404':
43636+
"$ref": "#/components/responses/not_found"
43637+
'422':
43638+
"$ref": "#/components/responses/validation_failed"
43639+
x-github:
43640+
githubCloudOnly: false
43641+
enabledForGitHubApps: true
43642+
category: pulls
43643+
subcategory: pulls
4358343644
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
4358443645
post:
4358543646
summary: Create a codespace from a pull request

0 commit comments

Comments
 (0)