mirror of
https://github.com/status-im/PyGithub.git
synced 2026-09-02 11:51:10 +00:00
Fix our doc to match URLs described in Github API v3 ref doc
This commit is contained in:
+68
-65
@@ -308,7 +308,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def add_to_collaborators(self, collaborator):
|
||||
"""
|
||||
:calls: `PUT /repos/:user/:repo/collaborators/:user <http://developer.github.com/v3/todo>`_
|
||||
:calls: `PUT /repos/:owner/:repo/collaborators/:user <http://developer.github.com/v3/todo>`_
|
||||
:param collaborator: :class:`github.NamedUser.NamedUser`
|
||||
:rtype: None
|
||||
"""
|
||||
@@ -322,7 +322,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def compare(self, base, head):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/compare/:base...:head <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/compare/:base...:head <http://developer.github.com/v3/todo>`_
|
||||
:param base: string
|
||||
:param head: string
|
||||
:rtype: :class:`github.Comparison.Comparison`
|
||||
@@ -339,7 +339,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_download(self, name, size, description=github.GithubObject.NotSet, content_type=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/downloads <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/downloads <http://developer.github.com/v3/todo>`_
|
||||
:param name: string
|
||||
:param size: integer
|
||||
:param description: string
|
||||
@@ -368,7 +368,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_git_blob(self, content, encoding):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/git/blobs <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/git/blobs <http://developer.github.com/v3/todo>`_
|
||||
:param content: string
|
||||
:param encoding: string
|
||||
:rtype: :class:`github.GitBlob.GitBlob`
|
||||
@@ -389,7 +389,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_git_commit(self, message, tree, parents, author=github.GithubObject.NotSet, committer=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/git/commits <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/git/commits <http://developer.github.com/v3/todo>`_
|
||||
:param message: string
|
||||
:param tree: :class:`github.GitTree.GitTree`
|
||||
:param parents: list of :class:`github.GitCommit.GitCommit`
|
||||
@@ -421,7 +421,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_git_ref(self, ref, sha):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/git/refs <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/git/refs <http://developer.github.com/v3/todo>`_
|
||||
:param ref: string
|
||||
:param sha: string
|
||||
:rtype: :class:`github.GitRef.GitRef`
|
||||
@@ -442,7 +442,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_git_tag(self, tag, message, object, type, tagger=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/git/tags <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/git/tags <http://developer.github.com/v3/todo>`_
|
||||
:param tag: string
|
||||
:param message: string
|
||||
:param object: string
|
||||
@@ -473,7 +473,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_git_tree(self, tree, base_tree=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/git/trees <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/git/trees <http://developer.github.com/v3/todo>`_
|
||||
:param tree: list of :class:`github.InputGitTreeElement.InputGitTreeElement`
|
||||
:param base_tree: :class:`github.GitTree.GitTree`
|
||||
:rtype: :class:`github.GitTree.GitTree`
|
||||
@@ -495,7 +495,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_hook(self, name, config, events=github.GithubObject.NotSet, active=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/hooks <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/hooks <http://developer.github.com/v3/todo>`_
|
||||
:param name: string
|
||||
:param config: dict
|
||||
:param events: list of string
|
||||
@@ -524,7 +524,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_issue(self, title, body=github.GithubObject.NotSet, assignee=github.GithubObject.NotSet, milestone=github.GithubObject.NotSet, labels=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/issues <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/issues <http://developer.github.com/v3/todo>`_
|
||||
:param title: string
|
||||
:param body: string
|
||||
:param assignee: :class:`github.NamedUser.NamedUser`
|
||||
@@ -558,7 +558,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_key(self, title, key):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/keys <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/keys <http://developer.github.com/v3/todo>`_
|
||||
:param title: string
|
||||
:param key: string
|
||||
:rtype: :class:`github.RepositoryKey.RepositoryKey`
|
||||
@@ -579,7 +579,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_label(self, name, color):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/labels <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/labels <http://developer.github.com/v3/todo>`_
|
||||
:param name: string
|
||||
:param color: string
|
||||
:rtype: :class:`github.Label.Label`
|
||||
@@ -600,7 +600,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_milestone(self, title, state=github.GithubObject.NotSet, description=github.GithubObject.NotSet, due_on=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/milestones <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/milestones <http://developer.github.com/v3/todo>`_
|
||||
:param title: string
|
||||
:param state: string
|
||||
:param description: string
|
||||
@@ -630,7 +630,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def create_pull(self, *args, **kwds):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/pulls <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/pulls <http://developer.github.com/v3/todo>`_
|
||||
:param title: string
|
||||
:param body: string
|
||||
:param issue: :class:`github.Issue.Issue`
|
||||
@@ -668,7 +668,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def delete(self):
|
||||
"""
|
||||
:calls: `DELETE /repos/:user/:repo <http://developer.github.com/v3/todo>`_
|
||||
:calls: `DELETE /repos/:owner/:repo <http://developer.github.com/v3/todo>`_
|
||||
:rtype: None
|
||||
"""
|
||||
headers, data = self._requester.requestJsonAndCheck(
|
||||
@@ -680,7 +680,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def edit(self, name, description=github.GithubObject.NotSet, homepage=github.GithubObject.NotSet, public=github.GithubObject.NotSet, has_issues=github.GithubObject.NotSet, has_wiki=github.GithubObject.NotSet, has_downloads=github.GithubObject.NotSet, default_branch=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `PATCH /repos/:user/:repo <http://developer.github.com/v3/todo>`_
|
||||
:calls: `PATCH /repos/:owner/:repo <http://developer.github.com/v3/todo>`_
|
||||
:param name: string
|
||||
:param description: string
|
||||
:param homepage: string
|
||||
@@ -726,7 +726,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_archive_link(self, archive_format, ref=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/:archive_format/:ref <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/:archive_format/:ref <http://developer.github.com/v3/todo>`_
|
||||
:param archive_format: string
|
||||
:param ref: string
|
||||
:rtype: string
|
||||
@@ -746,7 +746,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_assignees(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/assignees <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/assignees <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -758,7 +758,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_branch(self, branch):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/branches/:branch <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/branches/:branch <http://developer.github.com/v3/todo>`_
|
||||
:param branch: string
|
||||
:rtype: :class:`github.Branch.Branch`
|
||||
"""
|
||||
@@ -773,7 +773,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_branches(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/branches <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/branches <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Branch.Branch`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -785,7 +785,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_collaborators(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/collaborators <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/collaborators <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -797,7 +797,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_comment(self, id):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/comments/:id <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/comments/:id <http://developer.github.com/v3/todo>`_
|
||||
:param id: integer
|
||||
:rtype: :class:`github.CommitComment.CommitComment`
|
||||
"""
|
||||
@@ -812,7 +812,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_comments(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/comments <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/comments <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.CommitComment.CommitComment`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -824,7 +824,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_commit(self, sha):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/commits/:sha <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/commits/:sha <http://developer.github.com/v3/todo>`_
|
||||
:param sha: string
|
||||
:rtype: :class:`github.Commit.Commit`
|
||||
"""
|
||||
@@ -839,7 +839,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_commits(self, sha=github.GithubObject.NotSet, path=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/commits <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/commits <http://developer.github.com/v3/todo>`_
|
||||
:param sha: string
|
||||
:param path: string
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Commit.Commit`
|
||||
@@ -860,6 +860,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_contents(self, path, ref=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:owner/:repo/contents/:path <http://developer.github.com/v3/todo>`_
|
||||
:param path: string
|
||||
:param ref: string
|
||||
:rtype: :class:`github.ContentFile.ContentFile`
|
||||
@@ -868,6 +869,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_file_contents(self, path, ref=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:owner/:repo/contents/:path <http://developer.github.com/v3/todo>`_
|
||||
:param path: string
|
||||
:param ref: string
|
||||
:rtype: :class:`github.ContentFile.ContentFile`
|
||||
@@ -887,6 +889,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_dir_contents(self, path, ref=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:owner/:repo/contents/:path <http://developer.github.com/v3/todo>`_
|
||||
:param path: string
|
||||
:param ref: string
|
||||
:rtype: list of :class:`github.ContentFile.ContentFile`
|
||||
@@ -919,7 +922,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_contributors(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/contributors <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/contributors <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -931,7 +934,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_download(self, id):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/downloads/:id <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/downloads/:id <http://developer.github.com/v3/todo>`_
|
||||
:param id: integer
|
||||
:rtype: :class:`github.Download.Download`
|
||||
"""
|
||||
@@ -946,7 +949,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_downloads(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/downloads <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/downloads <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Download.Download`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -958,7 +961,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_events(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/events <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/events <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -970,7 +973,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_forks(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/forks <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/forks <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -982,7 +985,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_git_blob(self, sha):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/git/blobs/:sha <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/git/blobs/:sha <http://developer.github.com/v3/todo>`_
|
||||
:param sha: string
|
||||
:rtype: :class:`github.GitBlob.GitBlob`
|
||||
"""
|
||||
@@ -997,7 +1000,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_git_commit(self, sha):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/git/commits/:sha <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/git/commits/:sha <http://developer.github.com/v3/todo>`_
|
||||
:param sha: string
|
||||
:rtype: :class:`github.GitCommit.GitCommit`
|
||||
"""
|
||||
@@ -1012,7 +1015,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_git_ref(self, ref):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/git/refs/:ref <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/git/refs/:ref <http://developer.github.com/v3/todo>`_
|
||||
:param ref: string
|
||||
:rtype: :class:`github.GitRef.GitRef`
|
||||
"""
|
||||
@@ -1030,7 +1033,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_git_refs(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/git/refs <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/git/refs <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GitRef.GitRef`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1042,7 +1045,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_git_tag(self, sha):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/git/tags/:sha <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/git/tags/:sha <http://developer.github.com/v3/todo>`_
|
||||
:param sha: string
|
||||
:rtype: :class:`github.GitTag.GitTag`
|
||||
"""
|
||||
@@ -1057,7 +1060,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_git_tree(self, sha, recursive=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/git/trees/:sha <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/git/trees/:sha <http://developer.github.com/v3/todo>`_
|
||||
:param sha: string
|
||||
:param recursive: bool
|
||||
:rtype: :class:`github.GitTree.GitTree`
|
||||
@@ -1077,7 +1080,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_hook(self, id):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/hooks/:id <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/hooks/:id <http://developer.github.com/v3/todo>`_
|
||||
:param id: integer
|
||||
:rtype: :class:`github.Hook.Hook`
|
||||
"""
|
||||
@@ -1092,7 +1095,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_hooks(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/hooks <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/hooks <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Hook.Hook`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1104,7 +1107,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_issue(self, number):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/issues/:number <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/issues/:number <http://developer.github.com/v3/todo>`_
|
||||
:param number: integer
|
||||
:rtype: :class:`github.Issue.Issue`
|
||||
"""
|
||||
@@ -1119,7 +1122,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_issues(self, milestone=github.GithubObject.NotSet, state=github.GithubObject.NotSet, assignee=github.GithubObject.NotSet, mentioned=github.GithubObject.NotSet, labels=github.GithubObject.NotSet, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet, since=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/issues <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/issues <http://developer.github.com/v3/todo>`_
|
||||
:param milestone: :class:`github.Milestone.Milestone` or "none" or "*"
|
||||
:param state: string
|
||||
:param assignee: :class:`github.NamedUser.NamedUser` or "none" or "*"
|
||||
@@ -1170,7 +1173,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_issues_comments(self, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet, since=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/issues/comments <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/issues/comments <http://developer.github.com/v3/todo>`_
|
||||
:param sort: string
|
||||
:param direction: string
|
||||
:param since: datetime.datetime
|
||||
@@ -1195,7 +1198,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_issues_event(self, id):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/issues/events/:id <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/issues/events/:id <http://developer.github.com/v3/todo>`_
|
||||
:param id: integer
|
||||
:rtype: :class:`github.IssueEvent.IssueEvent`
|
||||
"""
|
||||
@@ -1210,7 +1213,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_issues_events(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/issues/events <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/issues/events <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.IssueEvent.IssueEvent`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1222,7 +1225,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_key(self, id):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/keys/:id <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/keys/:id <http://developer.github.com/v3/todo>`_
|
||||
:param id: integer
|
||||
:rtype: :class:`github.RepositoryKey.RepositoryKey`
|
||||
"""
|
||||
@@ -1237,7 +1240,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_keys(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/keys <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/keys <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.RepositoryKey.RepositoryKey`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1249,7 +1252,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_label(self, name):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/labels/:name <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/labels/:name <http://developer.github.com/v3/todo>`_
|
||||
:param name: string
|
||||
:rtype: :class:`github.Label.Label`
|
||||
"""
|
||||
@@ -1264,7 +1267,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_labels(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/labels <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/labels <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Label.Label`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1276,7 +1279,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_languages(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/languages <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/languages <http://developer.github.com/v3/todo>`_
|
||||
:rtype: dict of string to integer
|
||||
"""
|
||||
headers, data = self._requester.requestJsonAndCheck(
|
||||
@@ -1289,7 +1292,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_milestone(self, number):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/milestones/:number <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/milestones/:number <http://developer.github.com/v3/todo>`_
|
||||
:param number: integer
|
||||
:rtype: :class:`github.Milestone.Milestone`
|
||||
"""
|
||||
@@ -1304,7 +1307,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_milestones(self, state=github.GithubObject.NotSet, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/milestones <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/milestones <http://developer.github.com/v3/todo>`_
|
||||
:param state: string
|
||||
:param sort: string
|
||||
:param direction: string
|
||||
@@ -1329,7 +1332,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_network_events(self):
|
||||
"""
|
||||
:calls: `GET /networks/:user/:repo/events <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /networks/:owner/:repo/events <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1341,7 +1344,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_pull(self, number):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/pulls/:number <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/pulls/:number <http://developer.github.com/v3/todo>`_
|
||||
:param number: integer
|
||||
:rtype: :class:`github.PullRequest.PullRequest`
|
||||
"""
|
||||
@@ -1356,7 +1359,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_pulls(self, state=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/pulls <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/pulls <http://developer.github.com/v3/todo>`_
|
||||
:param state: string
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequest.PullRequest`
|
||||
"""
|
||||
@@ -1373,7 +1376,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_pulls_comments(self, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet, since=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/pulls/comments <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/pulls/comments <http://developer.github.com/v3/todo>`_
|
||||
:param sort: string
|
||||
:param direction: string
|
||||
:param since: datetime.datetime
|
||||
@@ -1383,7 +1386,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_pulls_review_comments(self, sort=github.GithubObject.NotSet, direction=github.GithubObject.NotSet, since=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/pulls/comments <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/pulls/comments <http://developer.github.com/v3/todo>`_
|
||||
:param sort: string
|
||||
:param direction: string
|
||||
:param since: datetime.datetime
|
||||
@@ -1408,7 +1411,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_readme(self, ref=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/readme <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/readme <http://developer.github.com/v3/todo>`_
|
||||
:param ref: string
|
||||
:rtype: :class:`github.ContentFile.ContentFile`
|
||||
"""
|
||||
@@ -1426,7 +1429,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_stargazers(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/stargazers <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/stargazers <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1438,7 +1441,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_subscribers(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/subscribers <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/subscribers <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1450,7 +1453,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_tags(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/tags <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/tags <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Tag.Tag`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1462,7 +1465,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_teams(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/teams <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/teams <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Team.Team`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1474,7 +1477,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def get_watchers(self):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/watchers <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/watchers <http://developer.github.com/v3/todo>`_
|
||||
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
|
||||
"""
|
||||
return github.PaginatedList.PaginatedList(
|
||||
@@ -1486,7 +1489,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def has_in_assignees(self, assignee):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/assignees/:assignee <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/assignees/:assignee <http://developer.github.com/v3/todo>`_
|
||||
:param assignee: :class:`github.NamedUser.NamedUser`
|
||||
:rtype: bool
|
||||
"""
|
||||
@@ -1501,7 +1504,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def has_in_collaborators(self, collaborator):
|
||||
"""
|
||||
:calls: `GET /repos/:user/:repo/collaborators/:user <http://developer.github.com/v3/todo>`_
|
||||
:calls: `GET /repos/:owner/:repo/collaborators/:user <http://developer.github.com/v3/todo>`_
|
||||
:param collaborator: :class:`github.NamedUser.NamedUser`
|
||||
:rtype: bool
|
||||
"""
|
||||
@@ -1536,7 +1539,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def merge(self, base, head, commit_message=github.GithubObject.NotSet):
|
||||
"""
|
||||
:calls: `POST /repos/:user/:repo/merges <http://developer.github.com/v3/todo>`_
|
||||
:calls: `POST /repos/:owner/:repo/merges <http://developer.github.com/v3/todo>`_
|
||||
:param base: string
|
||||
:param head: string
|
||||
:param commit_message: string
|
||||
@@ -1564,7 +1567,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
|
||||
|
||||
def remove_from_collaborators(self, collaborator):
|
||||
"""
|
||||
:calls: `DELETE /repos/:user/:repo/collaborators/:user <http://developer.github.com/v3/todo>`_
|
||||
:calls: `DELETE /repos/:owner/:repo/collaborators/:user <http://developer.github.com/v3/todo>`_
|
||||
:param collaborator: :class:`github.NamedUser.NamedUser`
|
||||
:rtype: None
|
||||
"""
|
||||
|
||||
Reference in New Issue
Block a user