Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update allowed values for Repository collaborator permissions #1996

Merged
merged 5 commits into from
Dec 19, 2023
Merged

Update allowed values for Repository collaborator permissions #1996

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b1a07be
Update valid permissions
flying-sheep Jul 14, 2021
19b7b58
Merge branch 'master' into patch-1
flying-sheep Jan 10, 2022
ccb2a57
Update github/Repository.py
flying-sheep Dec 19, 2023
d70f6a9
Merge branch 'main' into patch-1
flying-sheep Dec 19, 2023
9927959
Assert allowed permission values
EnricoMi Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions github/Repository.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,11 +1036,13 @@ def web_commit_signoff_required(self) -> bool:

def add_to_collaborators(self, collaborator: str | NamedUser, permission: Opt[str] = NotSet) -> Invitation | None:
"""
:calls: `PUT /repos/{owner}/{repo}/collaborators/{user} <https://docs.github.com/en/rest/reference/repos#collaborators>`_
:param permission: string 'pull', 'push' or 'admin'
:calls: `PUT /repos/{owner}/{repo}/collaborators/{user} <https://docs.github.com/en/rest/collaborators/collaborators#add-a-repository-collaborator>`_
:param collaborator: string or :class:`github.NamedUser.NamedUser`
:param permission: string 'pull', 'push', 'admin', 'maintain', or 'triage'
:rtype: None
"""
assert isinstance(collaborator, github.NamedUser.NamedUser) or isinstance(collaborator, str), collaborator
assert is_optional(permission, str), permission
assert permission in ["pull", "push", "admin", "maintain", "triage", NotSet], permission

if isinstance(collaborator, github.NamedUser.NamedUser):
collaborator = collaborator._identity
Expand Down