Skip to content

Update OpenAPI 3.0 Descriptions #6296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-openapi-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update OpenAPI 3.0 Descriptions #6296

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 88 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59967,6 +59967,94 @@
}
}
},
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
"put": {
"summary": "Archive a pull request",
"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.",
"tags": [
"pulls"
],
"operationId": "pulls/archive",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"$ref": "#/components/parameters/pull-number"
}
],
"responses": {
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
},
"422": {
"$ref": "#/components/responses/validation_failed"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pulls",
"subcategory": "pulls"
}
},
"delete": {
"summary": "Unarchive a pull request",
"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.",
"tags": [
"pulls"
],
"operationId": "pulls/unarchive",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"$ref": "#/components/parameters/pull-number"
}
],
"responses": {
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
},
"422": {
"$ref": "#/components/responses/validation_failed"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pulls",
"subcategory": "pulls"
}
}
},
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
"post": {
"summary": "Create a codespace from a pull request",
Expand Down
61 changes: 61 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43651,6 +43651,67 @@ paths:
enabledForGitHubApps: true
category: pulls
subcategory: pulls
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
put:
summary: Archive a pull request
description: |-
Archives a pull request. Closes, locks, and marks the pull request as archived.
Only repository admins can archive pull requests.
Archived pull requests are hidden from non-admin users.
tags:
- pulls
operationId: pulls/archive
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/pull-number"
responses:
'204':
description: Response
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'422':
"$ref": "#/components/responses/validation_failed"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: pulls
delete:
summary: Unarchive a pull request
description: |-
Unarchives a pull request. Removes the archived flag from the pull request.
Does not automatically reopen or unlock the pull request.
Only repository admins can unarchive pull requests.
tags:
- pulls
operationId: pulls/unarchive
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/pull-number"
responses:
'204':
description: Response
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'422':
"$ref": "#/components/responses/validation_failed"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: pulls
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
post:
summary: Create a codespace from a pull request
Expand Down
88 changes: 88 additions & 0 deletions descriptions/api.github.com/api.github.com.2026-03-10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59884,6 +59884,94 @@
}
}
},
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
"put": {
"summary": "Archive a pull request",
"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.",
"tags": [
"pulls"
],
"operationId": "pulls/archive",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"$ref": "#/components/parameters/pull-number"
}
],
"responses": {
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
},
"422": {
"$ref": "#/components/responses/validation_failed"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pulls",
"subcategory": "pulls"
}
},
"delete": {
"summary": "Unarchive a pull request",
"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.",
"tags": [
"pulls"
],
"operationId": "pulls/unarchive",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"$ref": "#/components/parameters/pull-number"
}
],
"responses": {
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
"404": {
"$ref": "#/components/responses/not_found"
},
"422": {
"$ref": "#/components/responses/validation_failed"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"category": "pulls",
"subcategory": "pulls"
}
}
},
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
"post": {
"summary": "Create a codespace from a pull request",
Expand Down
61 changes: 61 additions & 0 deletions descriptions/api.github.com/api.github.com.2026-03-10.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43580,6 +43580,67 @@ paths:
enabledForGitHubApps: true
category: pulls
subcategory: pulls
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
put:
summary: Archive a pull request
description: |-
Archives a pull request. Closes, locks, and marks the pull request as archived.
Only repository admins can archive pull requests.
Archived pull requests are hidden from non-admin users.
tags:
- pulls
operationId: pulls/archive
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/pull-number"
responses:
'204':
description: Response
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'422':
"$ref": "#/components/responses/validation_failed"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: pulls
delete:
summary: Unarchive a pull request
description: |-
Unarchives a pull request. Removes the archived flag from the pull request.
Does not automatically reopen or unlock the pull request.
Only repository admins can unarchive pull requests.
tags:
- pulls
operationId: pulls/unarchive
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- "$ref": "#/components/parameters/pull-number"
responses:
'204':
description: Response
'403':
"$ref": "#/components/responses/forbidden"
'404':
"$ref": "#/components/responses/not_found"
'422':
"$ref": "#/components/responses/validation_failed"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: pulls
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
post:
summary: Create a codespace from a pull request
Expand Down
Loading
Loading