Skip to content

Commit 32b015f

Browse files
Update OpenAPI Descriptions
1 parent 774092c commit 32b015f

40 files changed

+870
-664
lines changed

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

Lines changed: 88 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19536,9 +19536,11 @@
1953619536
"previews": [
1953719537

1953819538
],
19539+
"deprecationDate": "2021-09-14",
1953919540
"category": "actions",
1954019541
"subcategory": "workflow-runs"
19541-
}
19542+
},
19543+
"deprecated": true
1954219544
}
1954319545
},
1954419546
"/repos/{owner}/{repo}/actions/runs/{run_id}/retry": {
@@ -25414,7 +25416,7 @@
2541425416
"properties": {
2541525417
"permission": {
2541625418
"type": "string",
25417-
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access.",
25419+
"description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository. \n\\* `maintain` - Recommended for project managers who need to manage the repository without access to sensitive or destructive actions. \n\\* `triage` - Recommended for contributors who need to proactively manage issues and pull requests without write access. \n\\* custom repository role name - Can assign a custom repository role if the owning organization has defined any.",
2541825420
"enum": [
2541925421
"pull",
2542025422
"push",
@@ -34176,20 +34178,12 @@
3417634178
},
3417734179
"410": {
3417834180
"$ref": "#/components/responses/gone"
34179-
},
34180-
"415": {
34181-
"$ref": "#/components/responses/preview_header_missing"
3418234181
}
3418334182
},
3418434183
"x-github": {
3418534184
"githubCloudOnly": false,
3418634185
"enabledForGitHubApps": true,
3418734186
"previews": [
34188-
{
34189-
"required": true,
34190-
"name": "mockingbird",
34191-
"note": "The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mockingbird-preview\n```"
34192-
},
3419334187
{
3419434188
"required": false,
3419534189
"name": "starfox",
@@ -34831,6 +34825,79 @@
3483134825
}
3483234826
}
3483334827
},
34828+
"/repos/{owner}/{repo}/lfs": {
34829+
"put": {
34830+
"summary": "Enable Git LFS for a repository",
34831+
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
34832+
"operationId": "repos/enable-lfs-for-repo",
34833+
"tags": [
34834+
"repos"
34835+
],
34836+
"externalDocs": {
34837+
"description": "API method documentation",
34838+
"url": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository"
34839+
},
34840+
"parameters": [
34841+
{
34842+
"$ref": "#/components/parameters/owner"
34843+
},
34844+
{
34845+
"$ref": "#/components/parameters/repo"
34846+
}
34847+
],
34848+
"responses": {
34849+
"202": {
34850+
"$ref": "#/components/responses/accepted"
34851+
},
34852+
"403": {
34853+
"description": "We will return a 403 with one of the following messages:\n\n- Git LFS support not enabled because Git LFS is globally disabled.\n- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.\n- Git LFS support not enabled because Git LFS is disabled for <owner>."
34854+
}
34855+
},
34856+
"x-github": {
34857+
"githubCloudOnly": false,
34858+
"enabledForGitHubApps": false,
34859+
"previews": [
34860+
34861+
],
34862+
"category": "repos",
34863+
"subcategory": "lfs"
34864+
}
34865+
},
34866+
"delete": {
34867+
"summary": "Disable Git LFS for a repository",
34868+
"description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.",
34869+
"operationId": "repos/disable-lfs-for-repo",
34870+
"tags": [
34871+
"repos"
34872+
],
34873+
"externalDocs": {
34874+
"description": "API method documentation",
34875+
"url": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository"
34876+
},
34877+
"parameters": [
34878+
{
34879+
"$ref": "#/components/parameters/owner"
34880+
},
34881+
{
34882+
"$ref": "#/components/parameters/repo"
34883+
}
34884+
],
34885+
"responses": {
34886+
"204": {
34887+
"description": "Response"
34888+
}
34889+
},
34890+
"x-github": {
34891+
"githubCloudOnly": false,
34892+
"enabledForGitHubApps": false,
34893+
"previews": [
34894+
34895+
],
34896+
"category": "repos",
34897+
"subcategory": "lfs"
34898+
}
34899+
}
34900+
},
3483434901
"/repos/{owner}/{repo}/license": {
3483534902
"get": {
3483634903
"summary": "Get the license for a repository",
@@ -63704,6 +63771,11 @@
6370463771
"description": "The auto incrementing run number for the workflow run.",
6370563772
"example": 106
6370663773
},
63774+
"run_attempt": {
63775+
"type": "integer",
63776+
"description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.",
63777+
"example": 1
63778+
},
6370763779
"event": {
6370863780
"type": "string",
6370963781
"example": "push"
@@ -63777,6 +63849,12 @@
6377763849
"type": "string",
6377863850
"example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun"
6377963851
},
63852+
"previous_attempt_url": {
63853+
"nullable": true,
63854+
"description": "The URL to the previous attempted run of this workflow, if one exists.",
63855+
"type": "string",
63856+
"example": "https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3"
63857+
},
6378063858
"workflow_url": {
6378163859
"description": "The URL to the workflow.",
6378263860
"type": "string",

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

Lines changed: 68 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13906,8 +13906,10 @@ paths:
1390613906
githubCloudOnly: false
1390713907
enabledForGitHubApps: false
1390813908
previews: []
13909+
deprecationDate: '2021-09-14'
1390913910
category: actions
1391013911
subcategory: workflow-runs
13912+
deprecated: true
1391113913
"/repos/{owner}/{repo}/actions/runs/{run_id}/retry":
1391213914
post:
1391313915
summary: Retry a workflow
@@ -18249,7 +18251,9 @@ paths:
1824918251
\ \n\\* `maintain` - Recommended for project managers who need
1825018252
to manage the repository without access to sensitive or destructive
1825118253
actions. \n\\* `triage` - Recommended for contributors who need
18252-
to proactively manage issues and pull requests without write access."
18254+
to proactively manage issues and pull requests without write access.
18255+
\n\\* custom repository role name - Can assign a custom repository
18256+
role if the owning organization has defined any."
1825318257
enum:
1825418258
- pull
1825518259
- push
@@ -24633,19 +24637,10 @@ paths:
2463324637
"$ref": "#/components/responses/not_found"
2463424638
'410':
2463524639
"$ref": "#/components/responses/gone"
24636-
'415':
24637-
"$ref": "#/components/responses/preview_header_missing"
2463824640
x-github:
2463924641
githubCloudOnly: false
2464024642
enabledForGitHubApps: true
2464124643
previews:
24642-
- required: true
24643-
name: mockingbird
24644-
note: |-
24645-
The API to get issue timeline events is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-23-timeline-preview-api/) for full details. To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
24646-
```shell
24647-
application/vnd.github.mockingbird-preview
24648-
```
2464924644
- required: false
2465024645
name: starfox
2465124646
note: |-
@@ -25062,6 +25057,58 @@ paths:
2506225057
previews: []
2506325058
category: repos
2506425059
subcategory:
25060+
"/repos/{owner}/{repo}/lfs":
25061+
put:
25062+
summary: Enable Git LFS for a repository
25063+
description: "**Note:** The Git LFS API endpoints are currently in beta and
25064+
are subject to change."
25065+
operationId: repos/enable-lfs-for-repo
25066+
tags:
25067+
- repos
25068+
externalDocs:
25069+
description: API method documentation
25070+
url: https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository
25071+
parameters:
25072+
- "$ref": "#/components/parameters/owner"
25073+
- "$ref": "#/components/parameters/repo"
25074+
responses:
25075+
'202':
25076+
"$ref": "#/components/responses/accepted"
25077+
'403':
25078+
description: |-
25079+
We will return a 403 with one of the following messages:
25080+
25081+
- Git LFS support not enabled because Git LFS is globally disabled.
25082+
- Git LFS support not enabled because Git LFS is disabled for the root repository in the network.
25083+
- Git LFS support not enabled because Git LFS is disabled for <owner>.
25084+
x-github:
25085+
githubCloudOnly: false
25086+
enabledForGitHubApps: false
25087+
previews: []
25088+
category: repos
25089+
subcategory: lfs
25090+
delete:
25091+
summary: Disable Git LFS for a repository
25092+
description: "**Note:** The Git LFS API endpoints are currently in beta and
25093+
are subject to change."
25094+
operationId: repos/disable-lfs-for-repo
25095+
tags:
25096+
- repos
25097+
externalDocs:
25098+
description: API method documentation
25099+
url: https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository
25100+
parameters:
25101+
- "$ref": "#/components/parameters/owner"
25102+
- "$ref": "#/components/parameters/repo"
25103+
responses:
25104+
'204':
25105+
description: Response
25106+
x-github:
25107+
githubCloudOnly: false
25108+
enabledForGitHubApps: false
25109+
previews: []
25110+
category: repos
25111+
subcategory: lfs
2506525112
"/repos/{owner}/{repo}/license":
2506625113
get:
2506725114
summary: Get the license for a repository
@@ -46340,6 +46387,11 @@ components:
4634046387
type: integer
4634146388
description: The auto incrementing run number for the workflow run.
4634246389
example: 106
46390+
run_attempt:
46391+
type: integer
46392+
description: Attempt number of the run, 1 for first attempt and higher if
46393+
the workflow was retried.
46394+
example: 1
4634346395
event:
4634446396
type: string
4634546397
example: push
@@ -46397,6 +46449,12 @@ components:
4639746449
description: The URL to rerun the workflow run.
4639846450
type: string
4639946451
example: https://api.github.com/repos/github/hello-world/actions/runs/5/rerun
46452+
previous_attempt_url:
46453+
nullable: true
46454+
description: The URL to the previous attempted run of this workflow, if
46455+
one exists.
46456+
type: string
46457+
example: https://api.github.com/repos/github/hello-world/actions/runs/5/attempts/3
4640046458
workflow_url:
4640146459
description: The URL to the workflow.
4640246460
type: string

0 commit comments

Comments
 (0)