Update OpenAPI Descriptions #561
Merged
Conversation
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
gr2m
reviewed
Sep 22, 2021
| @@ -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.", | |||
| "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.", | |||
There was a problem hiding this comment.
@imwiss the description addition says that permission can be set to a custom role name
custom repository role name - Can assign a custom repository role if the owning organization has defined any.
But the property has an enum that does not permit custom values. It only permits
pullpushadminmaintaintriage
I'll file an issue, but wanted to add the comment in context
gr2m
reviewed
Sep 22, 2021
| "/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 {DELETE,PUT} /repos/{owner}/{repo}/lfs is subjected to change. Should we add a flag to x-github?
mmrobins
deleted the
openapi-update-9828bb4ef20a33f99a17b4dad564144fcae5e009f8861519638751c536dcfc76
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
👋 humans. This PR updates the OpenAPI description with the latest changes.