Skip to content

Commit 3a48524

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent 2b6e93c commit 3a48524

24 files changed

Lines changed: 3798 additions & 0 deletions

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

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10218,6 +10218,15 @@
1021810218
"description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`",
1021910219
"type": "string"
1022010220
},
10221+
"image_source": {
10222+
"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`.",
10223+
"type": "string",
10224+
"enum": [
10225+
"github",
10226+
"partner",
10227+
"custom"
10228+
]
10229+
},
1022110230
"image_id": {
1022210231
"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`.",
1022310232
"type": "string"
@@ -10226,6 +10235,10 @@
1022610235
"description": "The version of the runner image to deploy. This is relevant only for runners using custom images.",
1022710236
"type": "string",
1022810237
"nullable": true
10238+
},
10239+
"image_gen": {
10240+
"description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.",
10241+
"type": "boolean"
1022910242
}
1023010243
}
1023110244
},
@@ -59967,6 +59980,94 @@
5996759980
}
5996859981
}
5996959982
},
59983+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
59984+
"put": {
59985+
"summary": "Archive a pull request",
59986+
"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.",
59987+
"tags": [
59988+
"pulls"
59989+
],
59990+
"operationId": "pulls/archive",
59991+
"externalDocs": {
59992+
"description": "API method documentation",
59993+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
59994+
},
59995+
"parameters": [
59996+
{
59997+
"$ref": "#/components/parameters/owner"
59998+
},
59999+
{
60000+
"$ref": "#/components/parameters/repo"
60001+
},
60002+
{
60003+
"$ref": "#/components/parameters/pull-number"
60004+
}
60005+
],
60006+
"responses": {
60007+
"204": {
60008+
"description": "Response"
60009+
},
60010+
"403": {
60011+
"$ref": "#/components/responses/forbidden"
60012+
},
60013+
"404": {
60014+
"$ref": "#/components/responses/not_found"
60015+
},
60016+
"422": {
60017+
"$ref": "#/components/responses/validation_failed"
60018+
}
60019+
},
60020+
"x-github": {
60021+
"githubCloudOnly": false,
60022+
"enabledForGitHubApps": true,
60023+
"category": "pulls",
60024+
"subcategory": "pulls"
60025+
}
60026+
},
60027+
"delete": {
60028+
"summary": "Unarchive a pull request",
60029+
"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.",
60030+
"tags": [
60031+
"pulls"
60032+
],
60033+
"operationId": "pulls/unarchive",
60034+
"externalDocs": {
60035+
"description": "API method documentation",
60036+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
60037+
},
60038+
"parameters": [
60039+
{
60040+
"$ref": "#/components/parameters/owner"
60041+
},
60042+
{
60043+
"$ref": "#/components/parameters/repo"
60044+
},
60045+
{
60046+
"$ref": "#/components/parameters/pull-number"
60047+
}
60048+
],
60049+
"responses": {
60050+
"204": {
60051+
"description": "Response"
60052+
},
60053+
"403": {
60054+
"$ref": "#/components/responses/forbidden"
60055+
},
60056+
"404": {
60057+
"$ref": "#/components/responses/not_found"
60058+
},
60059+
"422": {
60060+
"$ref": "#/components/responses/validation_failed"
60061+
}
60062+
},
60063+
"x-github": {
60064+
"githubCloudOnly": false,
60065+
"enabledForGitHubApps": true,
60066+
"category": "pulls",
60067+
"subcategory": "pulls"
60068+
}
60069+
}
60070+
},
5997060071
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
5997160072
"post": {
5997260073
"summary": "Create a codespace from a pull request",

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7332,6 +7332,15 @@ paths:
73327332
description: The machine size of the runner. To list available sizes,
73337333
use `GET actions/hosted-runners/machine-sizes`
73347334
type: string
7335+
image_source:
7336+
description: The source type of the runner image to use. Must match
7337+
the source of the image specified by `image_id`. Can be one of
7338+
`github`, `partner`, or `custom`.
7339+
type: string
7340+
enum:
7341+
- github
7342+
- partner
7343+
- custom
73357344
image_id:
73367345
description: The unique identifier of the runner image. To list
73377346
available images, use `GET /actions/hosted-runners/images/github-owned`,
@@ -7342,6 +7351,11 @@ paths:
73427351
relevant only for runners using custom images.
73437352
type: string
73447353
nullable: true
7354+
image_gen:
7355+
description: Whether to enable image generation for this runner
7356+
pool. When enabled, the runner pool is used to build and publish
7357+
custom runner images.
7358+
type: boolean
73457359
examples:
73467360
default:
73477361
value:
@@ -43651,6 +43665,67 @@ paths:
4365143665
enabledForGitHubApps: true
4365243666
category: pulls
4365343667
subcategory: pulls
43668+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
43669+
put:
43670+
summary: Archive a pull request
43671+
description: |-
43672+
Archives a pull request. Closes, locks, and marks the pull request as archived.
43673+
Only repository admins can archive pull requests.
43674+
Archived pull requests are hidden from non-admin users.
43675+
tags:
43676+
- pulls
43677+
operationId: pulls/archive
43678+
externalDocs:
43679+
description: API method documentation
43680+
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
43681+
parameters:
43682+
- "$ref": "#/components/parameters/owner"
43683+
- "$ref": "#/components/parameters/repo"
43684+
- "$ref": "#/components/parameters/pull-number"
43685+
responses:
43686+
'204':
43687+
description: Response
43688+
'403':
43689+
"$ref": "#/components/responses/forbidden"
43690+
'404':
43691+
"$ref": "#/components/responses/not_found"
43692+
'422':
43693+
"$ref": "#/components/responses/validation_failed"
43694+
x-github:
43695+
githubCloudOnly: false
43696+
enabledForGitHubApps: true
43697+
category: pulls
43698+
subcategory: pulls
43699+
delete:
43700+
summary: Unarchive a pull request
43701+
description: |-
43702+
Unarchives a pull request. Removes the archived flag from the pull request.
43703+
Does not automatically reopen or unlock the pull request.
43704+
Only repository admins can unarchive pull requests.
43705+
tags:
43706+
- pulls
43707+
operationId: pulls/unarchive
43708+
externalDocs:
43709+
description: API method documentation
43710+
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
43711+
parameters:
43712+
- "$ref": "#/components/parameters/owner"
43713+
- "$ref": "#/components/parameters/repo"
43714+
- "$ref": "#/components/parameters/pull-number"
43715+
responses:
43716+
'204':
43717+
description: Response
43718+
'403':
43719+
"$ref": "#/components/responses/forbidden"
43720+
'404':
43721+
"$ref": "#/components/responses/not_found"
43722+
'422':
43723+
"$ref": "#/components/responses/validation_failed"
43724+
x-github:
43725+
githubCloudOnly: false
43726+
enabledForGitHubApps: true
43727+
category: pulls
43728+
subcategory: pulls
4365443729
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
4365543730
post:
4365643731
summary: Create a codespace from a pull request

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

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10217,6 +10217,15 @@
1021710217
"description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`",
1021810218
"type": "string"
1021910219
},
10220+
"image_source": {
10221+
"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`.",
10222+
"type": "string",
10223+
"enum": [
10224+
"github",
10225+
"partner",
10226+
"custom"
10227+
]
10228+
},
1022010229
"image_id": {
1022110230
"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`.",
1022210231
"type": "string"
@@ -10225,6 +10234,10 @@
1022510234
"description": "The version of the runner image to deploy. This is relevant only for runners using custom images.",
1022610235
"type": "string",
1022710236
"nullable": true
10237+
},
10238+
"image_gen": {
10239+
"description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.",
10240+
"type": "boolean"
1022810241
}
1022910242
}
1023010243
},
@@ -59884,6 +59897,94 @@
5988459897
}
5988559898
}
5988659899
},
59900+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
59901+
"put": {
59902+
"summary": "Archive a pull request",
59903+
"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.",
59904+
"tags": [
59905+
"pulls"
59906+
],
59907+
"operationId": "pulls/archive",
59908+
"externalDocs": {
59909+
"description": "API method documentation",
59910+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
59911+
},
59912+
"parameters": [
59913+
{
59914+
"$ref": "#/components/parameters/owner"
59915+
},
59916+
{
59917+
"$ref": "#/components/parameters/repo"
59918+
},
59919+
{
59920+
"$ref": "#/components/parameters/pull-number"
59921+
}
59922+
],
59923+
"responses": {
59924+
"204": {
59925+
"description": "Response"
59926+
},
59927+
"403": {
59928+
"$ref": "#/components/responses/forbidden"
59929+
},
59930+
"404": {
59931+
"$ref": "#/components/responses/not_found"
59932+
},
59933+
"422": {
59934+
"$ref": "#/components/responses/validation_failed"
59935+
}
59936+
},
59937+
"x-github": {
59938+
"githubCloudOnly": false,
59939+
"enabledForGitHubApps": true,
59940+
"category": "pulls",
59941+
"subcategory": "pulls"
59942+
}
59943+
},
59944+
"delete": {
59945+
"summary": "Unarchive a pull request",
59946+
"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.",
59947+
"tags": [
59948+
"pulls"
59949+
],
59950+
"operationId": "pulls/unarchive",
59951+
"externalDocs": {
59952+
"description": "API method documentation",
59953+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
59954+
},
59955+
"parameters": [
59956+
{
59957+
"$ref": "#/components/parameters/owner"
59958+
},
59959+
{
59960+
"$ref": "#/components/parameters/repo"
59961+
},
59962+
{
59963+
"$ref": "#/components/parameters/pull-number"
59964+
}
59965+
],
59966+
"responses": {
59967+
"204": {
59968+
"description": "Response"
59969+
},
59970+
"403": {
59971+
"$ref": "#/components/responses/forbidden"
59972+
},
59973+
"404": {
59974+
"$ref": "#/components/responses/not_found"
59975+
},
59976+
"422": {
59977+
"$ref": "#/components/responses/validation_failed"
59978+
}
59979+
},
59980+
"x-github": {
59981+
"githubCloudOnly": false,
59982+
"enabledForGitHubApps": true,
59983+
"category": "pulls",
59984+
"subcategory": "pulls"
59985+
}
59986+
}
59987+
},
5988759988
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
5988859989
"post": {
5988959990
"summary": "Create a codespace from a pull request",

0 commit comments

Comments
 (0)