Skip to content

Commit 9523d13

Browse files
Update OpenAPI 3.1 Descriptions
1 parent 2b6e93c commit 9523d13

24 files changed

+3870
-0
lines changed

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

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10272,6 +10272,15 @@
1027210272
"description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`",
1027310273
"type": "string"
1027410274
},
10275+
"image_source": {
10276+
"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`.",
10277+
"type": "string",
10278+
"enum": [
10279+
"github",
10280+
"partner",
10281+
"custom"
10282+
]
10283+
},
1027510284
"image_id": {
1027610285
"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`.",
1027710286
"type": "string"
@@ -10282,6 +10291,10 @@
1028210291
"string",
1028310292
"null"
1028410293
]
10294+
},
10295+
"image_gen": {
10296+
"description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.",
10297+
"type": "boolean"
1028510298
}
1028610299
}
1028710300
},
@@ -60254,6 +60267,94 @@
6025460267
}
6025560268
}
6025660269
},
60270+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
60271+
"put": {
60272+
"summary": "Archive a pull request",
60273+
"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.",
60274+
"tags": [
60275+
"pulls"
60276+
],
60277+
"operationId": "pulls/archive",
60278+
"externalDocs": {
60279+
"description": "API method documentation",
60280+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
60281+
},
60282+
"parameters": [
60283+
{
60284+
"$ref": "#/components/parameters/owner"
60285+
},
60286+
{
60287+
"$ref": "#/components/parameters/repo"
60288+
},
60289+
{
60290+
"$ref": "#/components/parameters/pull-number"
60291+
}
60292+
],
60293+
"responses": {
60294+
"204": {
60295+
"description": "Response"
60296+
},
60297+
"403": {
60298+
"$ref": "#/components/responses/forbidden"
60299+
},
60300+
"404": {
60301+
"$ref": "#/components/responses/not_found"
60302+
},
60303+
"422": {
60304+
"$ref": "#/components/responses/validation_failed"
60305+
}
60306+
},
60307+
"x-github": {
60308+
"githubCloudOnly": false,
60309+
"enabledForGitHubApps": true,
60310+
"category": "pulls",
60311+
"subcategory": "pulls"
60312+
}
60313+
},
60314+
"delete": {
60315+
"summary": "Unarchive a pull request",
60316+
"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.",
60317+
"tags": [
60318+
"pulls"
60319+
],
60320+
"operationId": "pulls/unarchive",
60321+
"externalDocs": {
60322+
"description": "API method documentation",
60323+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
60324+
},
60325+
"parameters": [
60326+
{
60327+
"$ref": "#/components/parameters/owner"
60328+
},
60329+
{
60330+
"$ref": "#/components/parameters/repo"
60331+
},
60332+
{
60333+
"$ref": "#/components/parameters/pull-number"
60334+
}
60335+
],
60336+
"responses": {
60337+
"204": {
60338+
"description": "Response"
60339+
},
60340+
"403": {
60341+
"$ref": "#/components/responses/forbidden"
60342+
},
60343+
"404": {
60344+
"$ref": "#/components/responses/not_found"
60345+
},
60346+
"422": {
60347+
"$ref": "#/components/responses/validation_failed"
60348+
}
60349+
},
60350+
"x-github": {
60351+
"githubCloudOnly": false,
60352+
"enabledForGitHubApps": true,
60353+
"category": "pulls",
60354+
"subcategory": "pulls"
60355+
}
60356+
}
60357+
},
6025760358
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
6025860359
"post": {
6025960360
"summary": "Create a codespace from a pull request",

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

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7357,6 +7357,15 @@ paths:
73577357
description: The machine size of the runner. To list available sizes,
73587358
use `GET actions/hosted-runners/machine-sizes`
73597359
type: string
7360+
image_source:
7361+
description: The source type of the runner image to use. Must match
7362+
the source of the image specified by `image_id`. Can be one of
7363+
`github`, `partner`, or `custom`.
7364+
type: string
7365+
enum:
7366+
- github
7367+
- partner
7368+
- custom
73607369
image_id:
73617370
description: The unique identifier of the runner image. To list
73627371
available images, use `GET /actions/hosted-runners/images/github-owned`,
@@ -7368,6 +7377,11 @@ paths:
73687377
type:
73697378
- string
73707379
- 'null'
7380+
image_gen:
7381+
description: Whether to enable image generation for this runner
7382+
pool. When enabled, the runner pool is used to build and publish
7383+
custom runner images.
7384+
type: boolean
73717385
examples:
73727386
default:
73737387
value:
@@ -43797,6 +43811,67 @@ paths:
4379743811
enabledForGitHubApps: true
4379843812
category: pulls
4379943813
subcategory: pulls
43814+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive":
43815+
put:
43816+
summary: Archive a pull request
43817+
description: |-
43818+
Archives a pull request. Closes, locks, and marks the pull request as archived.
43819+
Only repository admins can archive pull requests.
43820+
Archived pull requests are hidden from non-admin users.
43821+
tags:
43822+
- pulls
43823+
operationId: pulls/archive
43824+
externalDocs:
43825+
description: API method documentation
43826+
url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request
43827+
parameters:
43828+
- "$ref": "#/components/parameters/owner"
43829+
- "$ref": "#/components/parameters/repo"
43830+
- "$ref": "#/components/parameters/pull-number"
43831+
responses:
43832+
'204':
43833+
description: Response
43834+
'403':
43835+
"$ref": "#/components/responses/forbidden"
43836+
'404':
43837+
"$ref": "#/components/responses/not_found"
43838+
'422':
43839+
"$ref": "#/components/responses/validation_failed"
43840+
x-github:
43841+
githubCloudOnly: false
43842+
enabledForGitHubApps: true
43843+
category: pulls
43844+
subcategory: pulls
43845+
delete:
43846+
summary: Unarchive a pull request
43847+
description: |-
43848+
Unarchives a pull request. Removes the archived flag from the pull request.
43849+
Does not automatically reopen or unlock the pull request.
43850+
Only repository admins can unarchive pull requests.
43851+
tags:
43852+
- pulls
43853+
operationId: pulls/unarchive
43854+
externalDocs:
43855+
description: API method documentation
43856+
url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request
43857+
parameters:
43858+
- "$ref": "#/components/parameters/owner"
43859+
- "$ref": "#/components/parameters/repo"
43860+
- "$ref": "#/components/parameters/pull-number"
43861+
responses:
43862+
'204':
43863+
description: Response
43864+
'403':
43865+
"$ref": "#/components/responses/forbidden"
43866+
'404':
43867+
"$ref": "#/components/responses/not_found"
43868+
'422':
43869+
"$ref": "#/components/responses/validation_failed"
43870+
x-github:
43871+
githubCloudOnly: false
43872+
enabledForGitHubApps: true
43873+
category: pulls
43874+
subcategory: pulls
4380043875
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces":
4380143876
post:
4380243877
summary: Create a codespace from a pull request

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

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10271,6 +10271,15 @@
1027110271
"description": "The machine size of the runner. To list available sizes, use `GET actions/hosted-runners/machine-sizes`",
1027210272
"type": "string"
1027310273
},
10274+
"image_source": {
10275+
"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`.",
10276+
"type": "string",
10277+
"enum": [
10278+
"github",
10279+
"partner",
10280+
"custom"
10281+
]
10282+
},
1027410283
"image_id": {
1027510284
"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`.",
1027610285
"type": "string"
@@ -10281,6 +10290,10 @@
1028110290
"string",
1028210291
"null"
1028310292
]
10293+
},
10294+
"image_gen": {
10295+
"description": "Whether to enable image generation for this runner pool. When enabled, the runner pool is used to build and publish custom runner images.",
10296+
"type": "boolean"
1028410297
}
1028510298
}
1028610299
},
@@ -60165,6 +60178,94 @@
6016560178
}
6016660179
}
6016760180
},
60181+
"/repos/{owner}/{repo}/pulls/{pull_number}/archive": {
60182+
"put": {
60183+
"summary": "Archive a pull request",
60184+
"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.",
60185+
"tags": [
60186+
"pulls"
60187+
],
60188+
"operationId": "pulls/archive",
60189+
"externalDocs": {
60190+
"description": "API method documentation",
60191+
"url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request"
60192+
},
60193+
"parameters": [
60194+
{
60195+
"$ref": "#/components/parameters/owner"
60196+
},
60197+
{
60198+
"$ref": "#/components/parameters/repo"
60199+
},
60200+
{
60201+
"$ref": "#/components/parameters/pull-number"
60202+
}
60203+
],
60204+
"responses": {
60205+
"204": {
60206+
"description": "Response"
60207+
},
60208+
"403": {
60209+
"$ref": "#/components/responses/forbidden"
60210+
},
60211+
"404": {
60212+
"$ref": "#/components/responses/not_found"
60213+
},
60214+
"422": {
60215+
"$ref": "#/components/responses/validation_failed"
60216+
}
60217+
},
60218+
"x-github": {
60219+
"githubCloudOnly": false,
60220+
"enabledForGitHubApps": true,
60221+
"category": "pulls",
60222+
"subcategory": "pulls"
60223+
}
60224+
},
60225+
"delete": {
60226+
"summary": "Unarchive a pull request",
60227+
"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.",
60228+
"tags": [
60229+
"pulls"
60230+
],
60231+
"operationId": "pulls/unarchive",
60232+
"externalDocs": {
60233+
"description": "API method documentation",
60234+
"url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request"
60235+
},
60236+
"parameters": [
60237+
{
60238+
"$ref": "#/components/parameters/owner"
60239+
},
60240+
{
60241+
"$ref": "#/components/parameters/repo"
60242+
},
60243+
{
60244+
"$ref": "#/components/parameters/pull-number"
60245+
}
60246+
],
60247+
"responses": {
60248+
"204": {
60249+
"description": "Response"
60250+
},
60251+
"403": {
60252+
"$ref": "#/components/responses/forbidden"
60253+
},
60254+
"404": {
60255+
"$ref": "#/components/responses/not_found"
60256+
},
60257+
"422": {
60258+
"$ref": "#/components/responses/validation_failed"
60259+
}
60260+
},
60261+
"x-github": {
60262+
"githubCloudOnly": false,
60263+
"enabledForGitHubApps": true,
60264+
"category": "pulls",
60265+
"subcategory": "pulls"
60266+
}
60267+
}
60268+
},
6016860269
"/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": {
6016960270
"post": {
6017060271
"summary": "Create a codespace from a pull request",

0 commit comments

Comments
 (0)