Skip to content

Commit

Permalink
Update allowed values for Repository collaborator permissions (#1996)
Browse files Browse the repository at this point in the history
Co-authored-by: Enrico Minack <github@enrico.minack.dev>
  • Loading branch information
flying-sheep and EnricoMi committed Dec 19, 2023
1 parent 2783e67 commit b5b66da
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions github/Repository.py
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

0 comments on commit b5b66da

Please sign in to comment.