Update OpenAPI Descriptions #561
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19536,9 +19536,11 @@ | |
| "previews": [ | ||
|
|
||
| ], | ||
| "deprecationDate": "2021-09-14", | ||
| "category": "actions", | ||
| "subcategory": "workflow-runs" | ||
| }, | ||
| "deprecated": true | ||
| } | ||
| }, | ||
| "/repos/{owner}/{repo}/actions/runs/{run_id}/retry": { | ||
|
|
@@ -25414,7 +25416,7 @@ | |
| "properties": { | ||
| "permission": { | ||
| "type": "string", | ||
| "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.", | ||
| "enum": [ | ||
| "pull", | ||
| "push", | ||
|
|
@@ -34176,20 +34178,12 @@ | |
| }, | ||
| "410": { | ||
| "$ref": "#/components/responses/gone" | ||
| } | ||
| }, | ||
| "x-github": { | ||
| "githubCloudOnly": false, | ||
| "enabledForGitHubApps": true, | ||
| "previews": [ | ||
| { | ||
| "required": false, | ||
| "name": "starfox", | ||
|
|
@@ -34831,6 +34825,79 @@ | |
| } | ||
| } | ||
| }, | ||
| "/repos/{owner}/{repo}/lfs": { | ||
| "put": { | ||
| "summary": "Enable Git LFS for a repository", | ||
| "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", | ||
|
There was a problem hiding this comment. @imwiss We would usually add a required preview header for an endpoint like this. For SDK users there is currently no telling that |
||
| "operationId": "repos/enable-lfs-for-repo", | ||
| "tags": [ | ||
| "repos" | ||
| ], | ||
| "externalDocs": { | ||
| "description": "API method documentation", | ||
| "url": "https://docs.github.com/rest/reference/repos#enable-git-lfs-for-a-repository" | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/components/parameters/owner" | ||
| }, | ||
| { | ||
| "$ref": "#/components/parameters/repo" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "202": { | ||
| "$ref": "#/components/responses/accepted" | ||
| }, | ||
| "403": { | ||
| "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>." | ||
| } | ||
| }, | ||
| "x-github": { | ||
| "githubCloudOnly": false, | ||
| "enabledForGitHubApps": false, | ||
| "previews": [ | ||
|
|
||
| ], | ||
| "category": "repos", | ||
| "subcategory": "lfs" | ||
| } | ||
| }, | ||
| "delete": { | ||
| "summary": "Disable Git LFS for a repository", | ||
| "description": "**Note:** The Git LFS API endpoints are currently in beta and are subject to change.", | ||
| "operationId": "repos/disable-lfs-for-repo", | ||
| "tags": [ | ||
| "repos" | ||
| ], | ||
| "externalDocs": { | ||
| "description": "API method documentation", | ||
| "url": "https://docs.github.com/rest/reference/repos#disable-git-lfs-for-a-repository" | ||
| }, | ||
| "parameters": [ | ||
| { | ||
| "$ref": "#/components/parameters/owner" | ||
| }, | ||
| { | ||
| "$ref": "#/components/parameters/repo" | ||
| } | ||
| ], | ||
| "responses": { | ||
| "204": { | ||
| "description": "Response" | ||
| } | ||
| }, | ||
| "x-github": { | ||
| "githubCloudOnly": false, | ||
| "enabledForGitHubApps": false, | ||
| "previews": [ | ||
|
|
||
| ], | ||
| "category": "repos", | ||
| "subcategory": "lfs" | ||
| } | ||
| } | ||
| }, | ||
| "/repos/{owner}/{repo}/license": { | ||
| "get": { | ||
| "summary": "Get the license for a repository", | ||
|
|
@@ -63704,6 +63771,11 @@ | |
| "description": "The auto incrementing run number for the workflow run.", | ||
| "example": 106 | ||
| }, | ||
| "run_attempt": { | ||
| "type": "integer", | ||
| "description": "Attempt number of the run, 1 for first attempt and higher if the workflow was retried.", | ||
| "example": 1 | ||
| }, | ||
| "event": { | ||
| "type": "string", | ||
| "example": "push" | ||
|
|
@@ -63777,6 +63849,12 @@ | |
| "type": "string", | ||
| "example": "https://github.com/api/repos/github/hello-world/actions/runs/5/rerun" | ||
| }, | ||
| "previous_attempt_url": { | ||
| "nullable": true, | ||
| "description": "The URL to the previous attempted run of this workflow, if one exists.", | ||
| "type": "string", | ||
| "example": "https://github.com/api/repos/github/hello-world/actions/runs/5/attempts/3" | ||
| }, | ||
| "workflow_url": { | ||
| "description": "The URL to the workflow.", | ||
| "type": "string", | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@imwiss the
descriptionaddition says thatpermissioncan be set to a custom role nameBut the property has an enum that does not permit custom values. It only permits
pullpushadminmaintaintriageI'll file an issue, but wanted to add the comment in context