Skip to content

Update OpenAPI 3.0 Descriptions #6298

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

Closed
github-openapi-bot wants to merge 1 commit into from
Closed

Update OpenAPI 3.0 Descriptions #6298

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
101 changes: 101 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 @@ -10218,6 +10218,15 @@
"description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`",
"type": "string"
},
"image_source": {
"description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.",
"type": "string",
"enum": [
"github",
"partner",
"custom"
]
},
"image_id": {
"description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.",
"type": "string"
Expand All @@ -10226,6 +10235,10 @@
"description": "The version of the runner image to deploy. This is relevant only for runners using custom images.",
"type": "string",
"nullable": true
},
"image_gen": {
"description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.",
"type": "boolean"
}
}
},
Expand Down Expand Up @@ -59967,6 +59980,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
75 changes: 75 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 @@ -7332,6 +7332,15 @@ paths:
description: The machine size of the runner. To list available sizes,
use `GET actions/hosted-runners/machine-sizes`
type: string
image_source:
description: The source type of the runner image to use. Must match
the source of the image specified by `image_id`. Can be one of
`github`, `partner`, or `custom`.
type: string
enum:
- github
- partner
- custom
image_id:
description: The unique identifier of the runner image. To list
available images, use `GET /actions/hosted-runners/images/github-owned`,
Expand All @@ -7342,6 +7351,11 @@ paths:
relevant only for runners using custom images.
type: string
nullable: true
image_gen:
description: Whether to enable image generation for this runner
pool. When enabled, the runner pool is used to build and publish
custom runner images.
type: boolean
examples:
default:
value:
Expand Down Expand Up @@ -43651,6 +43665,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
101 changes: 101 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 @@ -10217,6 +10217,15 @@
"description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`",
"type": "string"
},
"image_source": {
"description": "The source type of the runner image to use. Must match the source of the image specified by `image_id`. Can be one of `github`, `partner`, or `custom`.",
"type": "string",
"enum": [
"github",
"partner",
"custom"
]
},
"image_id": {
"description": "The unique identifier of the runner image. To list available images, use `GET /actions/hosted-runners/images/github-owned`, `GET /actions/hosted-runners/images/partner`, or `GET /actions/hosted-runners/images/custom`.",
"type": "string"
Expand All @@ -10225,6 +10234,10 @@
"description": "The version of the runner image to deploy. This is relevant only for runners using custom images.",
"type": "string",
"nullable": true
},
"image_gen": {
"description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.",
"type": "boolean"
}
}
},
Expand Down Expand Up @@ -59884,6 +59897,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
Loading
Loading