status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-09-01 11:21:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed links to github docs. [#2009]

Browse Source
This commit is contained in:
Mark Walker
2021-07-31 02:34:34 +01:00
parent 83d6e0719c
commit ab36b89aa5
45 changed files with 307 additions and 307 deletions
Download Patch File Download Diff File Expand all files Collapse all files
github/Repository.py
+94 -94
View File
@@ -147,7 +147,7 @@ from . import Consts
class Repository(github.GithubObject.CompletableGithubObject):
"""
This class represents Repositories. The reference can be found here http://docs.github.com/en/rest/reference/repos
This class represents Repositories. The reference can be found here https://docs.github.com/en/rest/reference/repos
"""
def __repr__(self):
@@ -805,7 +805,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def add_to_collaborators(self, collaborator, permission=github.GithubObject.NotSet):
"""
:calls: `PUT /repos/{owner}/{repo}/collaborators/{user} <http://docs.github.com/en/rest/reference/repos#collaborators>`_
:calls: `PUT /repos/{owner}/{repo}/collaborators/{user} <https://docs.github.com/en/rest/reference/repos#collaborators>`_
:param collaborator: string or :class:`github.NamedUser.NamedUser`
:param permission: string 'pull', 'push' or 'admin'
:rtype: None
@@ -838,7 +838,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_collaborator_permission(self, collaborator):
"""
:calls: `GET /repos/{owner}/{repo}/collaborators/{username}/permission <http://docs.github.com/en/rest/reference/repos#collaborators>`_
:calls: `GET /repos/{owner}/{repo}/collaborators/{username}/permission <https://docs.github.com/en/rest/reference/repos#collaborators>`_
:param collaborator: string or :class:`github.NamedUser.NamedUser`
:rtype: string
"""
@@ -878,7 +878,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def compare(self, base, head):
"""
:calls: `GET /repos/{owner}/{repo}/compare/{base...:head} <http://docs.github.com/en/rest/reference/repos#commits>`_
:calls: `GET /repos/{owner}/{repo}/compare/{base...:head} <https://docs.github.com/en/rest/reference/repos#commits>`_
:param base: string
:param head: string
:rtype: :class:`github.Comparison.Comparison`
@@ -894,7 +894,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_git_blob(self, content, encoding):
"""
:calls: `POST /repos/{owner}/{repo}/git/blobs <http://docs.github.com/en/rest/reference/git#blobs>`_
:calls: `POST /repos/{owner}/{repo}/git/blobs <https://docs.github.com/en/rest/reference/git#blobs>`_
:param content: string
:param encoding: string
:rtype: :class:`github.GitBlob.GitBlob`
@@ -919,7 +919,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
committer=github.GithubObject.NotSet,
):
"""
:calls: `POST /repos/{owner}/{repo}/git/commits <http://docs.github.com/en/rest/reference/git#commits>`_
:calls: `POST /repos/{owner}/{repo}/git/commits <https://docs.github.com/en/rest/reference/git#commits>`_
:param message: string
:param tree: :class:`github.GitTree.GitTree`
:param parents: list of :class:`github.GitCommit.GitCommit`
@@ -956,7 +956,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_git_ref(self, ref, sha):
"""
:calls: `POST /repos/{owner}/{repo}/git/refs <http://docs.github.com/en/rest/reference/git#refs>`_
:calls: `POST /repos/{owner}/{repo}/git/refs <https://docs.github.com/en/rest/reference/git#references>`_
:param ref: string
:param sha: string
:rtype: :class:`github.GitRef.GitRef`
@@ -1019,7 +1019,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
target_commitish=github.GithubObject.NotSet,
):
"""
:calls: `POST /repos/{owner}/{repo}/releases <http://docs.github.com/en/rest/reference/repos#releases>`_
:calls: `POST /repos/{owner}/{repo}/releases <https://docs.github.com/en/rest/reference/repos#releases>`_
:param tag: string
:param name: string
:param message: string
@@ -1068,7 +1068,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
self, tag, message, object, type, tagger=github.GithubObject.NotSet
):
"""
:calls: `POST /repos/{owner}/{repo}/git/tags <http://docs.github.com/en/rest/reference/git#tags>`_
:calls: `POST /repos/{owner}/{repo}/git/tags <https://docs.github.com/en/rest/reference/git#tags>`_
:param tag: string
:param message: string
:param object: string
@@ -1098,7 +1098,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_git_tree(self, tree, base_tree=github.GithubObject.NotSet):
"""
:calls: `POST /repos/{owner}/{repo}/git/trees <http://docs.github.com/en/rest/reference/git#trees>`_
:calls: `POST /repos/{owner}/{repo}/git/trees <https://docs.github.com/en/rest/reference/git#trees>`_
:param tree: list of :class:`github.InputGitTreeElement.InputGitTreeElement`
:param base_tree: :class:`github.GitTree.GitTree`
:rtype: :class:`github.GitTree.GitTree`
@@ -1127,7 +1127,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
active=github.GithubObject.NotSet,
):
"""
:calls: `POST /repos/{owner}/{repo}/hooks <http://docs.github.com/en/rest/reference/repos#webhooks>`_
:calls: `POST /repos/{owner}/{repo}/hooks <https://docs.github.com/en/rest/reference/repos#webhooks>`_
:param name: string
:param config: dict
:param events: list of string
@@ -1163,7 +1163,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
assignees=github.GithubObject.NotSet,
):
"""
:calls: `POST /repos/{owner}/{repo}/issues <http://docs.github.com/en/rest/reference/issues>`_
:calls: `POST /repos/{owner}/{repo}/issues <https://docs.github.com/en/rest/reference/issues>`_
:param title: string
:param body: string
:param assignee: string or :class:`github.NamedUser.NamedUser`
@@ -1222,7 +1222,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_key(self, title, key, read_only=False):
"""
:calls: `POST /repos/{owner}/{repo}/keys <http://docs.github.com/en/rest/reference/repos#deploy-keys>`_
:calls: `POST /repos/{owner}/{repo}/keys <https://docs.github.com/en/rest/reference/repos#deploy-keys>`_
:param title: string
:param key: string
:param read_only: bool
@@ -1245,7 +1245,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_label(self, name, color, description=github.GithubObject.NotSet):
"""
:calls: `POST /repos/{owner}/{repo}/labels <http://docs.github.com/en/rest/reference/issues#labels>`_
:calls: `POST /repos/{owner}/{repo}/labels <https://docs.github.com/en/rest/reference/issues#labels>`_
:param name: string
:param color: string
:param description: string
@@ -1278,7 +1278,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
due_on=github.GithubObject.NotSet,
):
"""
:calls: `POST /repos/{owner}/{repo}/milestones <http://docs.github.com/en/rest/reference/issues#milestones>`_
:calls: `POST /repos/{owner}/{repo}/milestones <https://docs.github.com/en/rest/reference/issues#milestones>`_
:param title: string
:param state: string
:param description: string
@@ -1334,7 +1334,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_pull(self, *args, **kwds):
"""
:calls: `POST /repos/{owner}/{repo}/pulls <http://docs.github.com/en/rest/reference/pulls>`_
:calls: `POST /repos/{owner}/{repo}/pulls <https://docs.github.com/en/rest/reference/pulls>`_
:param title: string
:param body: string
:param issue: :class:`github.Issue.Issue`
@@ -1457,7 +1457,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
vcs_password=github.GithubObject.NotSet,
):
"""
:calls: `PUT /repos/{owner}/{repo}/import <https://docs.github.com/en/rest/reference/migration/source_imports#start-an-import>`_
:calls: `PUT /repos/{owner}/{repo}/import <https://docs.github.com/en/rest/reference/migrations#start-an-import>`_
:param vcs: string
:param vcs_url: string
:param vcs_username: string
@@ -1492,7 +1492,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def delete(self):
"""
:calls: `DELETE /repos/{owner}/{repo} <http://docs.github.com/en/rest/reference/repos>`_
:calls: `DELETE /repos/{owner}/{repo} <https://docs.github.com/en/rest/reference/repos>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
@@ -1515,7 +1515,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
archived=github.GithubObject.NotSet,
):
"""
:calls: `PATCH /repos/{owner}/{repo} <http://docs.github.com/en/rest/reference/repos>`_
:calls: `PATCH /repos/{owner}/{repo} <https://docs.github.com/en/rest/reference/repos>`_
:param name: string
:param description: string
:param homepage: string
@@ -1529,7 +1529,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
:param allow_merge_commit: bool
:param allow_rebase_merge: bool
:param delete_branch_on_merge: bool
:param archived: bool. Unarchiving repositories is currently not supported through API (https://docs.github.com/en/rest/reference/repos#edit)
:param archived: bool. Unarchiving repositories is currently not supported through API (https://docs.github.com/en/rest/reference/repos#update-a-repository)
:rtype: None
"""
if name is None:
@@ -1610,7 +1610,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_archive_link(self, archive_format, ref=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/{archive_format}/{ref} <http://docs.github.com/en/rest/reference/repos#contents>`_
:calls: `GET /repos/{owner}/{repo}/{archive_format}/{ref} <https://docs.github.com/en/rest/reference/repos#contents>`_
:param archive_format: string
:param ref: string
:rtype: string
@@ -1625,7 +1625,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_assignees(self):
"""
:calls: `GET /repos/{owner}/{repo}/assignees <http://docs.github.com/en/rest/reference/issues#assignees>`_
:calls: `GET /repos/{owner}/{repo}/assignees <https://docs.github.com/en/rest/reference/issues#assignees>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
return github.PaginatedList.PaginatedList(
@@ -1634,7 +1634,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_branch(self, branch):
"""
:calls: `GET /repos/{owner}/{repo}/branches/{branch} <https://docs.github.com/en/rest/reference/repos/branches#get-branch>`_
:calls: `GET /repos/{owner}/{repo}/branches/{branch} <https://docs.github.com/en/rest/reference/repos#get-a-branch>`_
:param branch: string
:rtype: :class:`github.Branch.Branch`
"""
@@ -1646,7 +1646,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_branches(self):
"""
:calls: `GET /repos/{owner}/{repo}/branches <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/branches <https://docs.github.com/en/rest/reference/repos>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Branch.Branch`
"""
return github.PaginatedList.PaginatedList(
@@ -1655,7 +1655,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_collaborators(self, affiliation=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/collaborators <http://docs.github.com/en/rest/reference/repos#collaborators>`_
:calls: `GET /repos/{owner}/{repo}/collaborators <https://docs.github.com/en/rest/reference/repos#collaborators>`_
:param affiliation: string
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
@@ -1678,7 +1678,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_comment(self, id):
"""
:calls: `GET /repos/{owner}/{repo}/comments/{id} <http://docs.github.com/en/rest/reference/repos#comments>`_
:calls: `GET /repos/{owner}/{repo}/comments/{id} <https://docs.github.com/en/rest/reference/repos#comments>`_
:param id: integer
:rtype: :class:`github.CommitComment.CommitComment`
"""
@@ -1692,7 +1692,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_comments(self):
"""
:calls: `GET /repos/{owner}/{repo}/comments <http://docs.github.com/en/rest/reference/repos#comments>`_
:calls: `GET /repos/{owner}/{repo}/comments <https://docs.github.com/en/rest/reference/repos#comments>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.CommitComment.CommitComment`
"""
return github.PaginatedList.PaginatedList(
@@ -1704,7 +1704,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_commit(self, sha):
"""
:calls: `GET /repos/{owner}/{repo}/commits/{sha} <http://docs.github.com/en/rest/reference/repos#commits>`_
:calls: `GET /repos/{owner}/{repo}/commits/{sha} <https://docs.github.com/en/rest/reference/repos#commits>`_
:param sha: string
:rtype: :class:`github.Commit.Commit`
"""
@@ -1723,7 +1723,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
author=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/commits <http://docs.github.com/en/rest/reference/repos#commits>`_
:calls: `GET /repos/{owner}/{repo}/commits <https://docs.github.com/en/rest/reference/repos#commits>`_
:param sha: string
:param path: string
:param since: datetime.datetime
@@ -1773,7 +1773,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_contents(self, path, ref=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/contents/{path} <http://docs.github.com/en/rest/reference/repos#contents>`_
:calls: `GET /repos/{owner}/{repo}/contents/{path} <https://docs.github.com/en/rest/reference/repos#contents>`_
:param path: string
:param ref: string
:rtype: :class:`github.ContentFile.ContentFile` or a list of them
@@ -2177,7 +2177,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
):
"""This method deletes a file in a repository
:calls: `DELETE /repos/{owner}/{repo}/contents/{path} <https://docs.github.com/en/rest/reference/repos/contents#delete-a-file>`_
:calls: `DELETE /repos/{owner}/{repo}/contents/{path} <https://docs.github.com/en/rest/reference/repos#delete-a-file>`_
:param path: string, Required. The content path.
:param message: string, Required. The commit message.
:param sha: string, Required. The blob SHA of the file being replaced.
@@ -2230,7 +2230,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
)
def get_dir_contents(self, path, ref=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/contents/{path} <http://docs.github.com/en/rest/reference/repos#contents>`_
:calls: `GET /repos/{owner}/{repo}/contents/{path} <https://docs.github.com/en/rest/reference/repos#contents>`_
:param path: string
:param ref: string
:rtype: list of :class:`github.ContentFile.ContentFile`
@@ -2239,7 +2239,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_contributors(self, anon=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/contributors <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/contributors <https://docs.github.com/en/rest/reference/repos>`_
:param anon: string
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
@@ -2256,7 +2256,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_download(self, id):
"""
:calls: `GET /repos/{owner}/{repo}/downloads/{id} <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/downloads/{id} <https://docs.github.com/en/rest/reference/repos>`_
:param id: integer
:rtype: :class:`github.Download.Download`
"""
@@ -2268,7 +2268,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_downloads(self):
"""
:calls: `GET /repos/{owner}/{repo}/downloads <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/downloads <https://docs.github.com/en/rest/reference/repos>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Download.Download`
"""
return github.PaginatedList.PaginatedList(
@@ -2277,7 +2277,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_events(self):
"""
:calls: `GET /repos/{owner}/{repo}/events <http://docs.github.com/en/rest/reference/activity#events>`_
:calls: `GET /repos/{owner}/{repo}/events <https://docs.github.com/en/rest/reference/activity#events>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`
"""
return github.PaginatedList.PaginatedList(
@@ -2286,7 +2286,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_forks(self):
"""
:calls: `GET /repos/{owner}/{repo}/forks <http://docs.github.com/en/rest/reference/repos#forks>`_
:calls: `GET /repos/{owner}/{repo}/forks <https://docs.github.com/en/rest/reference/repos#forks>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Repository.Repository`
"""
return github.PaginatedList.PaginatedList(
@@ -2295,7 +2295,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_fork(self, organization=github.GithubObject.NotSet):
"""
:calls: `POST /repos/{owner}/{repo}/forks <http://docs.github.com/en/rest/reference/repos#forks>`_
:calls: `POST /repos/{owner}/{repo}/forks <https://docs.github.com/en/rest/reference/repos#forks>`_
:param organization: string or "none" or "*"
:rtype: :class:`github.Repository.Repository`
"""
@@ -2314,7 +2314,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_blob(self, sha):
"""
:calls: `GET /repos/{owner}/{repo}/git/blobs/{sha} <http://docs.github.com/en/rest/reference/git#blobs>`_
:calls: `GET /repos/{owner}/{repo}/git/blobs/{sha} <https://docs.github.com/en/rest/reference/git#blobs>`_
:param sha: string
:rtype: :class:`github.GitBlob.GitBlob`
"""
@@ -2326,7 +2326,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_commit(self, sha):
"""
:calls: `GET /repos/{owner}/{repo}/git/commits/{sha} <http://docs.github.com/en/rest/reference/git#commits>`_
:calls: `GET /repos/{owner}/{repo}/git/commits/{sha} <https://docs.github.com/en/rest/reference/git#commits>`_
:param sha: string
:rtype: :class:`github.GitCommit.GitCommit`
"""
@@ -2340,7 +2340,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_ref(self, ref):
"""
:calls: `GET /repos/{owner}/{repo}/git/refs/{ref} <http://docs.github.com/en/rest/reference/git#refs>`_
:calls: `GET /repos/{owner}/{repo}/git/refs/{ref} <https://docs.github.com/en/rest/reference/git#references>`_
:param ref: string
:rtype: :class:`github.GitRef.GitRef`
"""
@@ -2355,7 +2355,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_refs(self):
"""
:calls: `GET /repos/{owner}/{repo}/git/refs <http://docs.github.com/en/rest/reference/git#refs>`_
:calls: `GET /repos/{owner}/{repo}/git/refs <https://docs.github.com/en/rest/reference/git#references>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GitRef.GitRef`
"""
return github.PaginatedList.PaginatedList(
@@ -2364,7 +2364,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_matching_refs(self, ref):
"""
:calls: `GET /repos/{owner}/{repo}/git/matching-refs/{ref} <https://docs.github.com/en/rest/reference/git/refs#list-matching-references>`
:calls: `GET /repos/{owner}/{repo}/git/matching-refs/{ref} <https://docs.github.com/en/rest/reference/git#list-matching-references>`
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GitRef.GitRef`
"""
assert isinstance(ref, str), ref
@@ -2377,7 +2377,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_tag(self, sha):
"""
:calls: `GET /repos/{owner}/{repo}/git/tags/{sha} <http://docs.github.com/en/rest/reference/git#tags>`_
:calls: `GET /repos/{owner}/{repo}/git/tags/{sha} <https://docs.github.com/en/rest/reference/git#tags>`_
:param sha: string
:rtype: :class:`github.GitTag.GitTag`
"""
@@ -2389,7 +2389,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_git_tree(self, sha, recursive=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/git/trees/{sha} <http://docs.github.com/en/rest/reference/git#trees>`_
:calls: `GET /repos/{owner}/{repo}/git/trees/{sha} <https://docs.github.com/en/rest/reference/git#trees>`_
:param sha: string
:param recursive: bool
:rtype: :class:`github.GitTree.GitTree`
@@ -2409,7 +2409,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_hook(self, id):
"""
:calls: `GET /repos/{owner}/{repo}/hooks/{id} <http://docs.github.com/en/rest/reference/repos#webhooks>`_
:calls: `GET /repos/{owner}/{repo}/hooks/{id} <https://docs.github.com/en/rest/reference/repos#webhooks>`_
:param id: integer
:rtype: :class:`github.Hook.Hook`
"""
@@ -2421,7 +2421,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_hooks(self):
"""
:calls: `GET /repos/{owner}/{repo}/hooks <http://docs.github.com/en/rest/reference/repos#webhooks>`_
:calls: `GET /repos/{owner}/{repo}/hooks <https://docs.github.com/en/rest/reference/repos#webhooks>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Hook.Hook`
"""
return github.PaginatedList.PaginatedList(
@@ -2430,7 +2430,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_issue(self, number):
"""
:calls: `GET /repos/{owner}/{repo}/issues/{number} <http://docs.github.com/en/rest/reference/issues>`_
:calls: `GET /repos/{owner}/{repo}/issues/{number} <https://docs.github.com/en/rest/reference/issues>`_
:param number: integer
:rtype: :class:`github.Issue.Issue`
"""
@@ -2453,7 +2453,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
creator=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/issues <http://docs.github.com/en/rest/reference/issues>`_
:calls: `GET /repos/{owner}/{repo}/issues <https://docs.github.com/en/rest/reference/issues>`_
:param milestone: :class:`github.Milestone.Milestone` or "none" or "*"
:param state: string. `open`, `closed`, or `all`. If this is not set the GitHub API default behavior will be used. At the moment this is to return only open issues. This might change anytime on GitHub API side and it could be clever to explicitly specify the state value.
:param assignee: string or :class:`github.NamedUser.NamedUser` or "none" or "*"
@@ -2540,7 +2540,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
since=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/issues/comments <http://docs.github.com/en/rest/reference/issues#comments>`_
:calls: `GET /repos/{owner}/{repo}/issues/comments <https://docs.github.com/en/rest/reference/issues#comments>`_
:param sort: string
:param direction: string
:param since: datetime.datetime
@@ -2569,7 +2569,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_issues_event(self, id):
"""
:calls: `GET /repos/{owner}/{repo}/issues/events/{id} <http://docs.github.com/en/rest/reference/issues#events>`_
:calls: `GET /repos/{owner}/{repo}/issues/events/{id} <https://docs.github.com/en/rest/reference/issues#events>`_
:param id: integer
:rtype: :class:`github.IssueEvent.IssueEvent`
"""
@@ -2585,7 +2585,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_issues_events(self):
"""
:calls: `GET /repos/{owner}/{repo}/issues/events <http://docs.github.com/en/rest/reference/issues#events>`_
:calls: `GET /repos/{owner}/{repo}/issues/events <https://docs.github.com/en/rest/reference/issues#events>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.IssueEvent.IssueEvent`
"""
return github.PaginatedList.PaginatedList(
@@ -2598,7 +2598,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_key(self, id):
"""
:calls: `GET /repos/{owner}/{repo}/keys/{id} <http://docs.github.com/en/rest/reference/repos#deploy-keys>`_
:calls: `GET /repos/{owner}/{repo}/keys/{id} <https://docs.github.com/en/rest/reference/repos#deploy-keys>`_
:param id: integer
:rtype: :class:`github.RepositoryKey.RepositoryKey`
"""
@@ -2612,7 +2612,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_keys(self):
"""
:calls: `GET /repos/{owner}/{repo}/keys <http://docs.github.com/en/rest/reference/repos#deploy-keys>`_
:calls: `GET /repos/{owner}/{repo}/keys <https://docs.github.com/en/rest/reference/repos#deploy-keys>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.RepositoryKey.RepositoryKey`
"""
return github.PaginatedList.PaginatedList(
@@ -2624,7 +2624,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_label(self, name):
"""
:calls: `GET /repos/{owner}/{repo}/labels/{name} <http://docs.github.com/en/rest/reference/issues#labels>`_
:calls: `GET /repos/{owner}/{repo}/labels/{name} <https://docs.github.com/en/rest/reference/issues#labels>`_
:param name: string
:rtype: :class:`github.Label.Label`
"""
@@ -2636,7 +2636,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_labels(self):
"""
:calls: `GET /repos/{owner}/{repo}/labels <http://docs.github.com/en/rest/reference/issues#labels>`_
:calls: `GET /repos/{owner}/{repo}/labels <https://docs.github.com/en/rest/reference/issues#labels>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Label.Label`
"""
return github.PaginatedList.PaginatedList(
@@ -2645,7 +2645,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_languages(self):
"""
:calls: `GET /repos/{owner}/{repo}/languages <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/languages <https://docs.github.com/en/rest/reference/repos>`_
:rtype: dict of string to integer
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -2668,7 +2668,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_milestone(self, number):
"""
:calls: `GET /repos/{owner}/{repo}/milestones/{number} <http://docs.github.com/en/rest/reference/issues#milestones>`_
:calls: `GET /repos/{owner}/{repo}/milestones/{number} <https://docs.github.com/en/rest/reference/issues#milestones>`_
:param number: integer
:rtype: :class:`github.Milestone.Milestone`
"""
@@ -2687,7 +2687,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
direction=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/milestones <http://docs.github.com/en/rest/reference/issues#milestones>`_
:calls: `GET /repos/{owner}/{repo}/milestones <https://docs.github.com/en/rest/reference/issues#milestones>`_
:param state: string
:param sort: string
:param direction: string
@@ -2714,7 +2714,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_network_events(self):
"""
:calls: `GET /networks/{owner}/{repo}/events <http://docs.github.com/en/rest/reference/activity#events>`_
:calls: `GET /networks/{owner}/{repo}/events <https://docs.github.com/en/rest/reference/activity#events>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Event.Event`
"""
return github.PaginatedList.PaginatedList(
@@ -2738,7 +2738,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_pull(self, number):
"""
:calls: `GET /repos/{owner}/{repo}/pulls/{number} <http://docs.github.com/en/rest/reference/pulls>`_
:calls: `GET /repos/{owner}/{repo}/pulls/{number} <https://docs.github.com/en/rest/reference/pulls>`_
:param number: integer
:rtype: :class:`github.PullRequest.PullRequest`
"""
@@ -2759,7 +2759,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
head=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/pulls <http://docs.github.com/en/rest/reference/pulls>`_
:calls: `GET /repos/{owner}/{repo}/pulls <https://docs.github.com/en/rest/reference/pulls>`_
:param state: string
:param sort: string
:param direction: string
@@ -2799,7 +2799,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
since=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/pulls/comments <http://docs.github.com/en/rest/reference/pulls#comments>`_
:calls: `GET /repos/{owner}/{repo}/pulls/comments <https://docs.github.com/en/rest/reference/pulls#comments>`_
:param sort: string
:param direction: string
:param since: datetime.datetime
@@ -2814,7 +2814,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
since=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/pulls/comments <http://docs.github.com/en/rest/reference/pulls#review-comments>`_
:calls: `GET /repos/{owner}/{repo}/pulls/comments <https://docs.github.com/en/rest/reference/pulls#review-comments>`_
:param sort: string
:param direction: string
:param since: datetime.datetime
@@ -2843,7 +2843,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_readme(self, ref=github.GithubObject.NotSet):
"""
:calls: `GET /repos/{owner}/{repo}/readme <http://docs.github.com/en/rest/reference/repos#contents>`_
:calls: `GET /repos/{owner}/{repo}/readme <https://docs.github.com/en/rest/reference/repos#contents>`_
:param ref: string
:rtype: :class:`github.ContentFile.ContentFile`
"""
@@ -2887,7 +2887,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_source_import(self):
"""
:calls: `GET /repos/{owner}/{repo}/import <https://docs.github.com/en/rest/reference/migration/source_imports#get-import-progress>`_
:calls: `GET /repos/{owner}/{repo}/import <https://docs.github.com/en/rest/reference/migrations#source-imports>`_
:rtype: :class:`github.SourceImport.SourceImport`
"""
import_header = {"Accept": Consts.mediaTypeImportPreview}
@@ -2905,7 +2905,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stargazers(self):
"""
:calls: `GET /repos/{owner}/{repo}/stargazers <http://docs.github.com/en/rest/reference/activity#starring>`_
:calls: `GET /repos/{owner}/{repo}/stargazers <https://docs.github.com/en/rest/reference/activity#starring>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
return github.PaginatedList.PaginatedList(
@@ -2914,7 +2914,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stargazers_with_dates(self):
"""
:calls: `GET /repos/{owner}/{repo}/stargazers <http://docs.github.com/en/rest/reference/activity#starring>`_
:calls: `GET /repos/{owner}/{repo}/stargazers <https://docs.github.com/en/rest/reference/activity#starring>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Stargazer.Stargazer`
"""
return github.PaginatedList.PaginatedList(
@@ -2927,7 +2927,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stats_contributors(self):
"""
:calls: `GET /repos/{owner}/{repo}/stats/contributors <http://docs.github.com/en/rest/reference/repos/statistics#get-contributors-list-with-additions-deletions-and-commit-counts>`_
:calls: `GET /repos/{owner}/{repo}/stats/contributors <https://docs.github.com/en/rest/reference/repos#get-all-contributor-commit-activity>`_
:rtype: None or list of :class:`github.StatsContributor.StatsContributor`
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -2945,7 +2945,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stats_commit_activity(self):
"""
:calls: `GET /repos/{owner}/{repo}/stats/commit_activity <docs.github.com/en/rest/reference/repos/statistics#get-the-number-of-commits-per-hour-in-each-day>`_
:calls: `GET /repos/{owner}/{repo}/stats/commit_activity <https://docs.github.com/en/rest/reference/repos#get-the-last-year-of-commit-activity>`_
:rtype: None or list of :class:`github.StatsCommitActivity.StatsCommitActivity`
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -2963,7 +2963,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stats_code_frequency(self):
"""
:calls: `GET /repos/{owner}/{repo}/stats/code_frequency <http://docs.github.com/en/rest/reference/repos/statistics#get-the-number-of-additions-and-deletions-per-week>`_
:calls: `GET /repos/{owner}/{repo}/stats/code_frequency <https://docs.github.com/en/rest/reference/repos#get-the-weekly-commit-activity>`_
:rtype: None or list of :class:`github.StatsCodeFrequency.StatsCodeFrequency`
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -2981,7 +2981,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stats_participation(self):
"""
:calls: `GET /repos/{owner}/{repo}/stats/participation <http://docs.github.com/en/rest/reference/repos/statistics#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else>`_
:calls: `GET /repos/{owner}/{repo}/stats/participation <https://docs.github.com/en/rest/reference/repos#get-the-weekly-commit-count>`_
:rtype: None or :class:`github.StatsParticipation.StatsParticipation`
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -2996,7 +2996,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_stats_punch_card(self):
"""
:calls: `GET /repos/{owner}/{repo}/stats/punch_card <http://docs.github.com/en/rest/reference/repos/statistics#get-the-number-of-commits-per-hour-in-each-day>`_
:calls: `GET /repos/{owner}/{repo}/stats/punch_card <https://docs.github.com/en/rest/reference/repos#get-the-hourly-commit-count-for-each-day>`_
:rtype: None or :class:`github.StatsPunchCard.StatsPunchCard`
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -3011,7 +3011,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_subscribers(self):
"""
:calls: `GET /repos/{owner}/{repo}/subscribers <http://docs.github.com/en/rest/reference/activity#watching>`_
:calls: `GET /repos/{owner}/{repo}/subscribers <https://docs.github.com/en/rest/reference/activity#watching>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
return github.PaginatedList.PaginatedList(
@@ -3020,7 +3020,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_tags(self):
"""
:calls: `GET /repos/{owner}/{repo}/tags <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/tags <https://docs.github.com/en/rest/reference/repos>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Tag.Tag`
"""
return github.PaginatedList.PaginatedList(
@@ -3029,7 +3029,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_releases(self):
"""
:calls: `GET /repos/{owner}/{repo}/releases <https://docs.github.com/en/rest/reference/repos/releases#list-releases-for-a-repository>`_
:calls: `GET /repos/{owner}/{repo}/releases <https://docs.github.com/en/rest/reference/repos#list-releases>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GitRelease.GitRelease`
"""
return github.PaginatedList.PaginatedList(
@@ -3038,7 +3038,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_release(self, id):
"""
:calls: `GET /repos/{owner}/{repo}/releases/{id} <https://docs.github.com/en/rest/reference/repos/releases#get-a-single-release>`_
:calls: `GET /repos/{owner}/{repo}/releases/{id} <https://docs.github.com/en/rest/reference/repos#get-a-release>`_
:param id: int (release id), str (tag name)
:rtype: None or :class:`github.GitRelease.GitRelease`
"""
@@ -3059,7 +3059,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_latest_release(self):
"""
:calls: `GET /repos/{owner}/{repo}/releases/latest <https://docs.github.com/en/rest/reference/repos/releases#get-the-latest-release>`_
:calls: `GET /repos/{owner}/{repo}/releases/latest <https://docs.github.com/en/rest/reference/repos#get-the-latest-release>`_
:rtype: :class:`github.GitRelease.GitRelease`
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -3071,7 +3071,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_teams(self):
"""
:calls: `GET /repos/{owner}/{repo}/teams <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/teams <https://docs.github.com/en/rest/reference/repos>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Team.Team`
"""
return github.PaginatedList.PaginatedList(
@@ -3080,7 +3080,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_topics(self):
"""
:calls: `GET /repos/{owner}/{repo}/topics <https://docs.github.com/en/rest/reference/repos#list-all-topics-for-a-repository>`_
:calls: `GET /repos/{owner}/{repo}/topics <https://docs.github.com/en/rest/reference/repos#replace-all-repository-topics>`_
:rtype: list of strings
"""
headers, data = self._requester.requestJsonAndCheck(
@@ -3092,7 +3092,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_watchers(self):
"""
:calls: `GET /repos/{owner}/{repo}/watchers <http://docs.github.com/en/rest/reference/activity#starring>`_
:calls: `GET /repos/{owner}/{repo}/watchers <https://docs.github.com/en/rest/reference/activity#starring>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.NamedUser.NamedUser`
"""
return github.PaginatedList.PaginatedList(
@@ -3133,7 +3133,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
status=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/actions/runs <https://docs.github.com/en/rest/reference/actions/workflow-runs#list-workflow-runs-for-a-repository>`_
:calls: `GET /repos/{owner}/{repo}/actions/runs <https://docs.github.com/en/rest/reference/actions#list-workflow-runs-for-a-repository>`_
:param actor: :class:`github.NamedUser.NamedUser` or string
:param branch: :class:`github.Branch.Branch` or string
:param event: string
@@ -3195,7 +3195,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def has_in_assignees(self, assignee):
"""
:calls: `GET /repos/{owner}/{repo}/assignees/{assignee} <http://docs.github.com/en/rest/reference/issues#assignees>`_
:calls: `GET /repos/{owner}/{repo}/assignees/{assignee} <https://docs.github.com/en/rest/reference/issues#assignees>`_
:param assignee: string or :class:`github.NamedUser.NamedUser`
:rtype: bool
"""
@@ -3213,7 +3213,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def has_in_collaborators(self, collaborator):
"""
:calls: `GET /repos/{owner}/{repo}/collaborators/{user} <http://docs.github.com/en/rest/reference/repos#collaborators>`_
:calls: `GET /repos/{owner}/{repo}/collaborators/{user} <https://docs.github.com/en/rest/reference/repos#collaborators>`_
:param collaborator: string or :class:`github.NamedUser.NamedUser`
:rtype: bool
"""
@@ -3249,7 +3249,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def legacy_search_issues(self, state, keyword):
"""
:calls: `GET /legacy/issues/search/{owner}/{repository}/{state}/{keyword} <http://docs.github.com/en/rest/reference/search#legacy>`_
:calls: `GET /legacy/issues/search/{owner}/{repository}/{state}/{keyword} <https://docs.github.com/en/rest/reference/search>`_
:param state: "open" or "closed"
:param keyword: string
:rtype: List of :class:`github.Issue.Issue`
@@ -3278,7 +3278,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
before=github.GithubObject.NotSet,
):
"""
:calls: `GET /repos/{owner}/{repo}/notifications <http://docs.github.com/en/rest/reference/activity#notifications>`_
:calls: `GET /repos/{owner}/{repo}/notifications <https://docs.github.com/en/rest/reference/activity#notifications>`_
:param all: bool
:param participating: bool
:param since: datetime.datetime
@@ -3328,7 +3328,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def merge(self, base, head, commit_message=github.GithubObject.NotSet):
"""
:calls: `POST /repos/{owner}/{repo}/merges <http://docs.github.com/en/rest/reference/repos#merging>`_
:calls: `POST /repos/{owner}/{repo}/merges <https://docs.github.com/en/rest/reference/repos#merging>`_
:param base: string
:param head: string
:param commit_message: string
@@ -3355,7 +3355,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def replace_topics(self, topics):
"""
:calls: `PUT /repos/{owner}/{repo}/topics <http://docs.github.com/en/rest/reference/repos>`_
:calls: `PUT /repos/{owner}/{repo}/topics <https://docs.github.com/en/rest/reference/repos>`_
:param topics: list of strings
:rtype: None
"""
@@ -3369,7 +3369,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_vulnerability_alert(self):
"""
:calls: `GET /repos/{owner}/{repo}/vulnerability-alerts <http://docs.github.com/en/rest/reference/repos>`_
:calls: `GET /repos/{owner}/{repo}/vulnerability-alerts <https://docs.github.com/en/rest/reference/repos>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson(
@@ -3381,7 +3381,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def enable_vulnerability_alert(self):
"""
:calls: `PUT /repos/{owner}/{repo}/vulnerability-alerts <http://docs.github.com/en/rest/reference/repos>`_
:calls: `PUT /repos/{owner}/{repo}/vulnerability-alerts <https://docs.github.com/en/rest/reference/repos>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson(
@@ -3393,7 +3393,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def disable_vulnerability_alert(self):
"""
:calls: `DELETE /repos/{owner}/{repo}/vulnerability-alerts <http://docs.github.com/en/rest/reference/repos>`_
:calls: `DELETE /repos/{owner}/{repo}/vulnerability-alerts <https://docs.github.com/en/rest/reference/repos>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson(
@@ -3405,7 +3405,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def enable_automated_security_fixes(self):
"""
:calls: `PUT /repos/{owner}/{repo}/automated-security-fixes <http://docs.github.com/en/rest/reference/repos>`_
:calls: `PUT /repos/{owner}/{repo}/automated-security-fixes <https://docs.github.com/en/rest/reference/repos>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson(
@@ -3417,7 +3417,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def disable_automated_security_fixes(self):
"""
:calls: `DELETE /repos/{owner}/{repo}/automated-security-fixes <http://docs.github.com/en/rest/reference/repos>`_
:calls: `DELETE /repos/{owner}/{repo}/automated-security-fixes <https://docs.github.com/en/rest/reference/repos>`_
:rtype: bool
"""
status, _, _ = self._requester.requestJson(
@@ -3429,7 +3429,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def remove_from_collaborators(self, collaborator):
"""
:calls: `DELETE /repos/{owner}/{repo}/collaborators/{user} <http://docs.github.com/en/rest/reference/repos#collaborators>`_
:calls: `DELETE /repos/{owner}/{repo}/collaborators/{user} <https://docs.github.com/en/rest/reference/repos#collaborators>`_
:param collaborator: string or :class:`github.NamedUser.NamedUser`
:rtype: None
"""