Skip to content

Commit 937304e

Browse files
author
Marc-Andre Giroux
authored
Merge pull request #616 from github/openapi-update-3e2a77e16137ca04a8d374d8dd618a9ba26ccf0b2b4c9f6771253264521977e6
Update OpenAPI Descriptions
2 parents 9ce8c65 + a9212a0 commit 937304e

24 files changed

Lines changed: 394 additions & 574 deletions

‎descriptions/api.github.com/api.github.com.json‎

Lines changed: 15 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -12886,13 +12886,6 @@
1288612886
"x-github": {
1288712887
"githubCloudOnly": false,
1288812888
"enabledForGitHubApps": true,
12889-
"previews": [
12890-
{
12891-
"required": false,
12892-
"name": "baptiste",
12893-
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
12894-
}
12895-
],
1289612889
"category": "repos",
1289712890
"subcategory": null
1289812891
}
@@ -13060,13 +13053,6 @@
1306013053
"x-github": {
1306113054
"githubCloudOnly": false,
1306213055
"enabledForGitHubApps": true,
13063-
"previews": [
13064-
{
13065-
"required": false,
13066-
"name": "baptiste",
13067-
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
13068-
}
13069-
],
1307013056
"category": "repos",
1307113057
"subcategory": null
1307213058
}
@@ -17497,13 +17483,6 @@
1749717483
"x-github": {
1749817484
"githubCloudOnly": false,
1749917485
"enabledForGitHubApps": true,
17500-
"previews": [
17501-
{
17502-
"required": false,
17503-
"name": "baptiste",
17504-
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
17505-
}
17506-
],
1750717486
"category": "repos",
1750817487
"subcategory": null
1750917488
}
@@ -18755,7 +18734,7 @@
1875518734
}
1875618735
}
1875718736
},
18758-
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}": {
18737+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}": {
1875918738
"get": {
1876018739
"summary": "Get a workflow run attempt",
1876118740
"description": "Gets a specific workflow run attempt. Anyone with read access to the repository\ncan use this endpoint. If the repository is private you must use an access token\nwith the `repo` scope. GitHub Apps must have the `actions:read` permission to\nuse this endpoint.",
@@ -18778,7 +18757,7 @@
1877818757
"$ref": "#/components/parameters/run-id"
1877918758
},
1878018759
{
18781-
"$ref": "#/components/parameters/attempt-num"
18760+
"$ref": "#/components/parameters/attempt-number"
1878218761
}
1878318762
],
1878418763
"responses": {
@@ -18809,7 +18788,7 @@
1880918788
}
1881018789
}
1881118790
},
18812-
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}/logs": {
18791+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs": {
1881318792
"get": {
1881418793
"summary": "Download workflow run attempt logs",
1881518794
"description": "Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after\n1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.",
@@ -18832,7 +18811,7 @@
1883218811
"$ref": "#/components/parameters/run-id"
1883318812
},
1883418813
{
18835-
"$ref": "#/components/parameters/attempt-num"
18814+
"$ref": "#/components/parameters/attempt-number"
1883618815
}
1883718816
],
1883818817
"responses": {
@@ -41326,13 +41305,6 @@
4132641305
"x-github": {
4132741306
"githubCloudOnly": false,
4132841307
"enabledForGitHubApps": false,
41329-
"previews": [
41330-
{
41331-
"required": true,
41332-
"name": "baptiste",
41333-
"note": "Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
41334-
}
41335-
],
4133641308
"category": "repos",
4133741309
"subcategory": null
4133841310
}
@@ -50086,13 +50058,6 @@
5008650058
"x-github": {
5008750059
"githubCloudOnly": false,
5008850060
"enabledForGitHubApps": false,
50089-
"previews": [
50090-
{
50091-
"required": false,
50092-
"name": "baptiste",
50093-
"note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```"
50094-
}
50095-
],
5009650061
"category": "repos",
5009750062
"subcategory": null
5009850063
}
@@ -71924,6 +71889,9 @@
7192471889
},
7192571890
"allow_forking": {
7192671891
"type": "boolean"
71892+
},
71893+
"is_template": {
71894+
"type": "boolean"
7192771895
}
7192871896
},
7192971897
"required": [
@@ -72191,6 +72159,9 @@
7219172159
"id": {
7219272160
"type": "integer"
7219372161
},
72162+
"is_template": {
72163+
"type": "boolean"
72164+
},
7219472165
"node_id": {
7219572166
"type": "string"
7219672167
},
@@ -75147,6 +75118,9 @@
7514775118
},
7514875119
"allow_forking": {
7514975120
"type": "boolean"
75121+
},
75122+
"is_template": {
75123+
"type": "boolean"
7515075124
}
7515175125
},
7515275126
"required": [
@@ -96821,8 +96795,8 @@
9682196795
"type": "integer"
9682296796
}
9682396797
},
96824-
"attempt-num": {
96825-
"name": "attempt_num",
96798+
"attempt-number": {
96799+
"name": "attempt_number",
9682696800
"description": "The attempt number of the workflow run.",
9682796801
"in": "path",
9682896802
"required": true,

‎descriptions/api.github.com/api.github.com.yaml‎

Lines changed: 12 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -9003,15 +9003,6 @@ paths:
90039003
x-github:
90049004
githubCloudOnly: false
90059005
enabledForGitHubApps: true
9006-
previews:
9007-
- required: false
9008-
name: baptiste
9009-
note: |-
9010-
The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
9011-
9012-
```shell
9013-
application/vnd.github.baptiste-preview+json
9014-
```
90159006
category: repos
90169007
subcategory:
90179008
post:
@@ -9170,15 +9161,6 @@ paths:
91709161
x-github:
91719162
githubCloudOnly: false
91729163
enabledForGitHubApps: true
9173-
previews:
9174-
- required: false
9175-
name: baptiste
9176-
note: |-
9177-
The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
9178-
9179-
```shell
9180-
application/vnd.github.baptiste-preview+json
9181-
```
91829164
category: repos
91839165
subcategory:
91849166
"/orgs/{org}/secret-scanning/alerts":
@@ -12294,15 +12276,6 @@ paths:
1229412276
x-github:
1229512277
githubCloudOnly: false
1229612278
enabledForGitHubApps: true
12297-
previews:
12298-
- required: false
12299-
name: baptiste
12300-
note: |-
12301-
The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
12302-
12303-
```shell
12304-
application/vnd.github.baptiste-preview+json
12305-
```
1230612279
category: repos
1230712280
subcategory:
1230812281
delete:
@@ -13130,7 +13103,7 @@ paths:
1313013103
previews: []
1313113104
category: actions
1313213105
subcategory: artifacts
13133-
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}":
13106+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}":
1313413107
get:
1313513108
summary: Get a workflow run attempt
1313613109
description: |-
@@ -13148,7 +13121,7 @@ paths:
1314813121
- "$ref": "#/components/parameters/owner"
1314913122
- "$ref": "#/components/parameters/repo"
1315013123
- "$ref": "#/components/parameters/run-id"
13151-
- "$ref": "#/components/parameters/attempt-num"
13124+
- "$ref": "#/components/parameters/attempt-number"
1315213125
responses:
1315313126
'200':
1315413127
description: Response
@@ -13165,7 +13138,7 @@ paths:
1316513138
previews: []
1316613139
category: actions
1316713140
subcategory: workflow-runs
13168-
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_num}/logs":
13141+
"/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs":
1316913142
get:
1317013143
summary: Download workflow run attempt logs
1317113144
description: |-
@@ -13183,7 +13156,7 @@ paths:
1318313156
- "$ref": "#/components/parameters/owner"
1318413157
- "$ref": "#/components/parameters/repo"
1318513158
- "$ref": "#/components/parameters/run-id"
13186-
- "$ref": "#/components/parameters/attempt-num"
13159+
- "$ref": "#/components/parameters/attempt-number"
1318713160
responses:
1318813161
'302':
1318913162
description: Response
@@ -29061,15 +29034,6 @@ paths:
2906129034
x-github:
2906229035
githubCloudOnly: false
2906329036
enabledForGitHubApps: false
29064-
previews:
29065-
- required: true
29066-
name: baptiste
29067-
note: |-
29068-
Creating and using repository templates is currently available for developers to preview. To access this new endpoint during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
29069-
29070-
```shell
29071-
application/vnd.github.baptiste-preview+json
29072-
```
2907329037
category: repos
2907429038
subcategory:
2907529039
"/repositories":
@@ -35409,15 +35373,6 @@ paths:
3540935373
x-github:
3541035374
githubCloudOnly: false
3541135375
enabledForGitHubApps: false
35412-
previews:
35413-
- required: false
35414-
name: baptiste
35415-
note: |-
35416-
The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
35417-
35418-
```shell
35419-
application/vnd.github.baptiste-preview+json
35420-
```
3542135376
category: repos
3542235377
subcategory:
3542335378
"/user/repository_invitations":
@@ -51870,6 +51825,8 @@ components:
5187051825
format: date-time
5187151826
allow_forking:
5187251827
type: boolean
51828+
is_template:
51829+
type: boolean
5187351830
required:
5187451831
- archive_url
5187551832
- assignees_url
@@ -52083,6 +52040,8 @@ components:
5208352040
format: uri
5208452041
id:
5208552042
type: integer
52043+
is_template:
52044+
type: boolean
5208652045
node_id:
5208752046
type: string
5208852047
issue_comment_url:
@@ -54252,6 +54211,8 @@ components:
5425254211
type: boolean
5425354212
allow_forking:
5425454213
type: boolean
54214+
is_template:
54215+
type: boolean
5425554216
required:
5425654217
- archive_url
5425754218
- assignees_url
@@ -73142,8 +73103,8 @@ components:
7314273103
required: true
7314373104
schema:
7314473105
type: integer
73145-
attempt-num:
73146-
name: attempt_num
73106+
attempt-number:
73107+
name: attempt_number
7314773108
description: The attempt number of the workflow run.
7314873109
in: path
7314973110
required: true

0 commit comments

Comments
 (0)