From 8484260dc5f864136b45e3ac8e8068fc7da0b1f2 Mon Sep 17 00:00:00 2001 From: Vincent Jacques Date: Tue, 16 Jul 2013 10:32:57 +0200 Subject: [PATCH] Fix our doc to match URLs described in Github API v3 ref doc --- doc/apis.rst | 184 +++++++++++++++--------------- doc/changes.rst | 8 +- github/AuthenticatedUser.py | 22 ++-- github/Commit.py | 8 +- github/CommitComment.py | 4 +- github/Download.py | 2 +- github/Gist.py | 6 +- github/GistComment.py | 4 +- github/GitRef.py | 4 +- github/Hook.py | 6 +- github/Issue.py | 20 ++-- github/IssueComment.py | 4 +- github/Label.py | 4 +- github/MainClass.py | 2 +- github/Milestone.py | 6 +- github/NamedUser.py | 2 +- github/Organization.py | 4 +- github/PullRequest.py | 28 ++--- github/PullRequestComment.py | 4 +- github/Repository.py | 133 ++++++++++----------- github/RepositoryKey.py | 4 +- github/Team.py | 6 +- scripts/compare_to_api_ref_doc.py | 4 +- 23 files changed, 239 insertions(+), 230 deletions(-) diff --git a/doc/apis.rst b/doc/apis.rst index 365bc216..c5e71bb1 100644 --- a/doc/apis.rst +++ b/doc/apis.rst @@ -21,17 +21,23 @@ APIs * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_gists` * POST: :meth:`github.AuthenticatedUser.AuthenticatedUser.create_gist` +* ``/gists/:gist_id/comments`` + + * GET: :meth:`github.Gist.Gist.get_comments` + * POST: :meth:`github.Gist.Gist.create_comment` + +* ``/gists/:gist_id/comments/:id`` + + * GET: :meth:`github.Gist.Gist.get_comment` + * PATCH: :meth:`github.GistComment.GistComment.edit` + * DELETE: :meth:`github.GistComment.GistComment.delete` + * ``/gists/:id`` * GET: :meth:`github.MainClass.Github.get_gist` * PATCH: :meth:`github.Gist.Gist.edit` * DELETE: :meth:`github.Gist.Gist.delete` -* ``/gists/:id/comments`` - - * GET: :meth:`github.Gist.Gist.get_comments` - * POST: :meth:`github.Gist.Gist.create_comment` - * ``/gists/:id/fork`` * POST: :meth:`github.Gist.Gist.create_fork` @@ -42,12 +48,6 @@ APIs * PUT: :meth:`github.Gist.Gist.set_starred` * DELETE: :meth:`github.Gist.Gist.reset_starred` -* ``/gists/comments/:id`` - - * GET: :meth:`github.Gist.Gist.get_comment` - * PATCH: :meth:`github.GistComment.GistComment.edit` - * DELETE: :meth:`github.GistComment.GistComment.delete` - * ``/gists/public`` * GET: :meth:`github.MainClass.Github.get_gists` @@ -98,9 +98,9 @@ APIs * ``/markdown/raw`` - * POST: see ``/markdown`` + * POST: Not implemented, see ``/markdown`` -* ``/networks/:user/:repo/events`` +* ``/networks/:owner/:repo/events`` * GET: :meth:`github.Repository.Repository.get_network_events` @@ -156,313 +156,316 @@ APIs * ``/rate_limit`` - * GET: :meth:Ngithub.ot ot implemented, see `Github.rate_limiting` + * GET: Not implemented, see `Github.rate_limiting` -* ``/repos/:user/:repo`` +* ``/repos/:owner/:repo`` * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_repo` or :meth:`github.NamedUser.NamedUser.get_repo` or :meth:`github.Organization.Organization.get_repo` or :meth:`github.MainClass.Github.get_repo` * PATCH: :meth:`github.Repository.Repository.edit` * DELETE: :meth:`github.Repository.Repository.delete` -* ``/repos/:user/:repo/:archive_format/:ref`` +* ``/repos/:owner/:repo/:archive_format/:ref`` * GET: :meth:`github.Repository.Repository.get_archive_link` -* ``/repos/:user/:repo/assignees`` +* ``/repos/:owner/:repo/assignees`` * GET: :meth:`github.Repository.Repository.get_assignees` -* ``/repos/:user/:repo/assignees/:assignee`` +* ``/repos/:owner/:repo/assignees/:assignee`` * GET: :meth:`github.Repository.Repository.has_in_assignees` -* ``/repos/:user/:repo/branches`` +* ``/repos/:owner/:repo/branches`` * GET: :meth:`github.Repository.Repository.get_branches` -* ``/repos/:user/:repo/branches/:branch`` +* ``/repos/:owner/:repo/branches/:branch`` * GET: :meth:`github.Repository.Repository.get_branch` -* ``/repos/:user/:repo/collaborators`` +* ``/repos/:owner/:repo/collaborators`` * GET: :meth:`github.Repository.Repository.get_collaborators` -* ``/repos/:user/:repo/collaborators/:user`` +* ``/repos/:owner/:repo/collaborators/:user`` * GET: :meth:`github.Repository.Repository.has_in_collaborators` * PUT: :meth:`github.Repository.Repository.add_to_collaborators` * DELETE: :meth:`github.Repository.Repository.remove_from_collaborators` -* ``/repos/:user/:repo/comments`` +* ``/repos/:owner/:repo/comments`` * GET: :meth:`github.Repository.Repository.get_comments` -* ``/repos/:user/:repo/comments/:id`` +* ``/repos/:owner/:repo/comments/:id`` * GET: :meth:`github.Repository.Repository.get_comment` * PATCH: :meth:`github.CommitComment.CommitComment.edit` * DELETE: :meth:`github.CommitComment.CommitComment.delete` -* ``/repos/:user/:repo/commits`` +* ``/repos/:owner/:repo/commits`` * GET: :meth:`github.Repository.Repository.get_commits` -* ``/repos/:user/:repo/commits/:sha`` +* ``/repos/:owner/:repo/commits/:sha`` * GET: :meth:`github.Repository.Repository.get_commit` -* ``/repos/:user/:repo/commits/:sha/comments`` +* ``/repos/:owner/:repo/commits/:sha/comments`` * GET: :meth:`github.Commit.Commit.get_comments` * POST: :meth:`github.Commit.Commit.create_comment` -* ``/repos/:user/:repo/compare/:base...:head`` +* ``/repos/:owner/:repo/compare/:base...:head`` * GET: :meth:`github.Repository.Repository.compare` -* ``/repos/:user/:repo/contents/:path`` +* ``/repos/:owner/:repo/contents/:path`` * GET: :meth:`github.Repository.Repository.get_contents` or :meth:`github.Repository.Repository.get_file_contents` or :meth:`github.Repository.Repository.get_dir_contents` -* ``/repos/:user/:repo/contributors`` +* ``/repos/:owner/:repo/contributors`` * GET: :meth:`github.Repository.Repository.get_contributors` -* ``/repos/:user/:repo/downloads`` +* ``/repos/:owner/:repo/downloads`` * GET: :meth:`github.Repository.Repository.get_downloads` * POST: :meth:`github.Repository.Repository.create_download` -* ``/repos/:user/:repo/downloads/:id`` +* ``/repos/:owner/:repo/downloads/:id`` * GET: :meth:`github.Repository.Repository.get_download` * DELETE: :meth:`github.Download.Download.delete` -* ``/repos/:user/:repo/events`` +* ``/repos/:owner/:repo/events`` * GET: :meth:`github.Repository.Repository.get_events` -* ``/repos/:user/:repo/forks`` +* ``/repos/:owner/:repo/forks`` * GET: :meth:`github.Repository.Repository.get_forks` * POST: :meth:`github.AuthenticatedUser.AuthenticatedUser.create_fork` or `Organization.create_fork` -* ``/repos/:user/:repo/git/blobs`` +* ``/repos/:owner/:repo/git/blobs`` * POST: :meth:`github.Repository.Repository.create_git_blob` -* ``/repos/:user/:repo/git/blobs/:sha`` +* ``/repos/:owner/:repo/git/blobs/:sha`` * GET: :meth:`github.Repository.Repository.get_git_blob` -* ``/repos/:user/:repo/git/commits`` +* ``/repos/:owner/:repo/git/commits`` * POST: :meth:`github.Repository.Repository.create_git_commit` -* ``/repos/:user/:repo/git/commits/:sha`` +* ``/repos/:owner/:repo/git/commits/:sha`` * GET: :meth:`github.Repository.Repository.get_git_commit` -* ``/repos/:user/:repo/git/refs`` +* ``/repos/:owner/:repo/git/refs`` * GET: :meth:`github.Repository.Repository.get_git_refs` * POST: :meth:`github.Repository.Repository.create_git_ref` -* ``/repos/:user/:repo/git/refs/:ref`` +* ``/repos/:owner/:repo/git/refs/:ref`` * GET: :meth:`github.Repository.Repository.get_git_ref` * PATCH: :meth:`github.GitRef.GitRef.edit` * DELETE: :meth:`github.GitRef.GitRef.delete` -* ``/repos/:user/:repo/git/tags`` +* ``/repos/:owner/:repo/git/tags`` * POST: :meth:`github.Repository.Repository.create_git_tag` -* ``/repos/:user/:repo/git/tags/:sha`` +* ``/repos/:owner/:repo/git/tags/:sha`` * GET: :meth:`github.Repository.Repository.get_git_tag` -* ``/repos/:user/:repo/git/trees`` +* ``/repos/:owner/:repo/git/trees`` * POST: :meth:`github.Repository.Repository.create_git_tree` -* ``/repos/:user/:repo/git/trees/:sha`` +* ``/repos/:owner/:repo/git/trees/:sha`` * GET: :meth:`github.Repository.Repository.get_git_tree` -* ``/repos/:user/:repo/hooks`` +* ``/repos/:owner/:repo/hooks`` * GET: :meth:`github.Repository.Repository.get_hooks` * POST: :meth:`github.Repository.Repository.create_hook` -* ``/repos/:user/:repo/hooks/:id`` +* ``/repos/:owner/:repo/hooks/:id`` * GET: :meth:`github.Repository.Repository.get_hook` * PATCH: :meth:`github.Hook.Hook.edit` * DELETE: :meth:`github.Hook.Hook.delete` -* ``/repos/:user/:repo/hooks/:id/test`` +* ``/repos/:owner/:repo/hooks/:id/test`` * POST: :meth:`github.Hook.Hook.test` -* ``/repos/:user/:repo/issues`` +* ``/repos/:owner/:repo/issues`` * GET: :meth:`github.Repository.Repository.get_issues` * POST: :meth:`github.Repository.Repository.create_issue` -* ``/repos/:user/:repo/issues/:number`` +* ``/repos/:owner/:repo/issues/:issue_number/events`` + + * GET: :meth:`github.Issue.Issue.get_events` + +* ``/repos/:owner/:repo/issues/:number`` * GET: :meth:`github.Repository.Repository.get_issue` * PATCH: :meth:`github.Issue.Issue.edit` -* ``/repos/:user/:repo/issues/:number/comments`` +* ``/repos/:owner/:repo/issues/:number/comments`` * GET: :meth:`github.Issue.Issue.get_comments` or :meth:`gituhub.PullRequest.PullRequest.get_issue_comments` * POST: :meth:`github.Issue.Issue.create_comment` or :meth:`gituhub.PullRequest.PullRequest.create_issue_comment` -* ``/repos/:user/:repo/issues/:number/events`` - - * GET: :meth:`github.Issue.Issue.get_events` - -* ``/repos/:user/:repo/issues/:number/labels`` +* ``/repos/:owner/:repo/issues/:number/labels`` * GET: :meth:`github.Issue.Issue.get_labels` * POST: :meth:`github.Issue.Issue.add_to_labels` * PUT: :meth:`github.Issue.Issue.set_labels` * DELETE: :meth:`github.Issue.Issue.delete_labels` -* ``/repos/:user/:repo/issues/:number/labels/:name`` +* ``/repos/:owner/:repo/issues/:number/labels/:name`` * DELETE: :meth:`github.Issue.Issue.remove_from_labels` -* ``/repos/:user/:repo/issues/comments`` +* ``/repos/:owner/:repo/issues/comments`` * GET: :meth:`github.Repository.Repository.get_issues_comments` -* ``/repos/:user/:repo/issues/comments/:id`` +* ``/repos/:owner/:repo/issues/comments/:id`` * GET: :meth:`github.Issue.Issue.get_comment` or :meth:`gituhub.PullRequest.PullRequest.get_issue_comment` * PATCH: :meth:`github.IssueComment.IssueComment.edit` * DELETE: :meth:`github.IssueComment.IssueComment.delete` -* ``/repos/:user/:repo/issues/events`` +* ``/repos/:owner/:repo/issues/events`` * GET: :meth:`github.Repository.Repository.get_issues_events` -* ``/repos/:user/:repo/issues/events/:id`` +* ``/repos/:owner/:repo/issues/events/:id`` * GET: :meth:`github.Repository.Repository.get_issues_event` -* ``/repos/:user/:repo/keys`` +* ``/repos/:owner/:repo/keys`` * GET: :meth:`github.Repository.Repository.get_keys` * POST: :meth:`github.Repository.Repository.create_key` -* ``/repos/:user/:repo/keys/:id`` +* ``/repos/:owner/:repo/keys/:id`` * GET: :meth:`github.Repository.Repository.get_key` * PATCH: :meth:`github.RepositoryKey.RepositoryKey.edit` * DELETE: :meth:`github.RepositoryKey.RepositoryKey.delete` -* ``/repos/:user/:repo/labels`` +* ``/repos/:owner/:repo/labels`` * GET: :meth:`github.Repository.Repository.get_labels` * POST: :meth:`github.Repository.Repository.create_label` -* ``/repos/:user/:repo/labels/:name`` +* ``/repos/:owner/:repo/labels/:name`` * GET: :meth:`github.Repository.Repository.get_label` * PATCH: :meth:`github.Label.Label.edit` * DELETE: :meth:`github.Label.Label.delete` -* ``/repos/:user/:repo/languages`` +* ``/repos/:owner/:repo/languages`` * GET: :meth:`github.Repository.Repository.get_languages` -* ``/repos/:user/:repo/merges`` +* ``/repos/:owner/:repo/merges`` * POST: :meth:`github.Repository.Repository.merge` -* ``/repos/:user/:repo/milestones`` +* ``/repos/:owner/:repo/milestones`` * GET: :meth:`github.Repository.Repository.get_milestones` * POST: :meth:`github.Repository.Repository.create_milestone` -* ``/repos/:user/:repo/milestones/:number`` +* ``/repos/:owner/:repo/milestones/:number`` * GET: :meth:`github.Repository.Repository.get_milestone` * PATCH: :meth:`github.Milestone.Milestone.edit` * DELETE: :meth:`github.Milestone.Milestone.delete` -* ``/repos/:user/:repo/milestones/:number/labels`` +* ``/repos/:owner/:repo/milestones/:number/labels`` * GET: :meth:`github.Milestone.Milestone.get_labels` -* ``/repos/:user/:repo/pulls`` +* ``/repos/:owner/:repo/pulls`` * GET: :meth:`github.Repository.Repository.get_pulls` * POST: :meth:`github.Repository.Repository.create_pull` -* ``/repos/:user/:repo/pulls/:number`` +* ``/repos/:owner/:repo/pulls/:number`` * GET: :meth:`github.Repository.Repository.get_pull` * PATCH: :meth:`github.PullRequest.PullRequest.edit` -* ``/repos/:user/:repo/pulls/:number/comments`` +* ``/repos/:owner/:repo/pulls/:number/comments`` * GET: :meth:`github.PullRequest.PullRequest.get_comments` or :meth:`github.PullRequest.PullRequest.get_review_comments` * POST: :meth:`github.PullRequest.PullRequest.create_comment` or :meth:`github.PullRequest.PullRequest.create_review_comment` -* ``/repos/:user/:repo/pulls/:number/commits`` +* ``/repos/:owner/:repo/pulls/:number/commits`` * GET: :meth:`github.PullRequest.PullRequest.get_commits` -* ``/repos/:user/:repo/pulls/:number/files`` +* ``/repos/:owner/:repo/pulls/:number/files`` * GET: :meth:`github.PullRequest.PullRequest.get_files` -* ``/repos/:user/:repo/pulls/:number/merge`` +* ``/repos/:owner/:repo/pulls/:number/merge`` * GET: :meth:`github.PullRequest.PullRequest.is_merged` * PUT: :meth:`github.PullRequest.PullRequest.merge` -* ``/repos/:user/:repo/pulls/comments`` +* ``/repos/:owner/:repo/pulls/comments`` * GET: :meth:`github.Repository.Repository.get_pulls_comments` or :meth:`github.Repository.Repository.get_pulls_review_comments` -* ``/repos/:user/:repo/pulls/comments/:number`` +* ``/repos/:owner/:repo/pulls/comments/:number`` * GET: :meth:`github.PullRequest.PullRequest.get_comment` or :meth:`github.PullRequest.PullRequest.get_review_comment` * PATCH: :meth:`github.PullRequestComment.PullRequestComment.edit` * DELETE: :meth:`github.PullRequestComment.PullRequestComment.delete` -* ``/repos/:user/:repo/readme`` +* ``/repos/:owner/:repo/readme`` * GET: :meth:`github.Repository.Repository.get_readme` -* ``/repos/:user/:repo/stargazers`` +* ``/repos/:owner/:repo/stargazers`` * GET: :meth:`github.Repository.Repository.get_stargazers` -* ``/repos/:user/:repo/statuses/:sha`` +* ``/repos/:owner/:repo/statuses/:ref`` * GET: :meth:`github.Commit.Commit.get_statuses` + +* ``/repos/:owner/:repo/statuses/:sha`` + * POST: :meth:`github.Commit.Commit.create_status` -* ``/repos/:user/:repo/subscribers`` +* ``/repos/:owner/:repo/subscribers`` * GET: :meth:`github.Repository.Repository.get_subscribers` -* ``/repos/:user/:repo/tags`` +* ``/repos/:owner/:repo/tags`` * GET: :meth:`github.Repository.Repository.get_tags` -* ``/repos/:user/:repo/teams`` +* ``/repos/:owner/:repo/teams`` * GET: :meth:`github.Repository.Repository.get_teams` -* ``/repos/:user/:repo/watchers`` +* ``/repos/:owner/:repo/watchers`` * GET: :meth:`github.Repository.Repository.get_watchers` @@ -486,10 +489,13 @@ APIs * GET: :meth:`github.Team.Team.get_repos` -* ``/teams/:id/repos/:user/:repo`` +* ``/teams/:id/repos/:org/:repo`` + + * PUT: :meth:`github.Team.Team.add_to_repos` + +* ``/teams/:id/repos/:owner/:repo`` * GET: :meth:`github.Team.Team.has_in_repos` - * PUT: :meth:`github.Team.Team.add_to_repos` * DELETE: :meth:`github.Team.Team.remove_from_repos` * ``/user`` @@ -545,7 +551,7 @@ APIs * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_starred` -* ``/user/starred/:user/:repo`` +* ``/user/starred/:owner/:repo`` * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.has_in_starred` * PUT: :meth:`github.AuthenticatedUser.AuthenticatedUser.add_to_starred` @@ -555,7 +561,7 @@ APIs * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_subscriptions` -* ``/user/subscriptions/:user/:repo`` +* ``/user/subscriptions/:owner/:repo`` * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.has_in_subscriptions` * PUT: :meth:`github.AuthenticatedUser.AuthenticatedUser.add_to_subscriptions` @@ -565,7 +571,7 @@ APIs * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.get_watched` -* ``/user/watched/:user/:repo`` +* ``/user/watched/:owner/:repo`` * GET: :meth:`github.AuthenticatedUser.AuthenticatedUser.has_in_watched` * PUT: :meth:`github.AuthenticatedUser.AuthenticatedUser.add_to_watched` diff --git a/doc/changes.rst b/doc/changes.rst index 4fb35905..8202f7b8 100644 --- a/doc/changes.rst +++ b/doc/changes.rst @@ -93,7 +93,7 @@ Version 1.12.1 (February 20th, 2013) * Add a shortcut function :meth:`github.MainClass.Github.get_repo` to get a repo directly from its full name. thank you `lwc `_ for the contribution * :meth:`github.MainClass.Github.get_gitignore_templates` and :meth:`github.MainClass.Github.get_gitignore_template` for APIs ``/gitignore/templates`` * Add the optional ``ref`` parameter to :meth:`github.Repository.Repository.get_contents` and :meth:`github.Repository.Repository.get_readme`. Thank you `fixxxeruk `_ for the contribution -* Get comments for all issues and all pull requests on a repository (``GET /repos/:user/:repo/pulls/comments``: :meth:`github.Repository.Repository.get_pulls_comments` or :meth:`github.Repository.Repository.get_pulls_review_comments`; ``GET /repos/:user/:repo/issues/comments``: :meth:`github.Repository.Repository.get_issues_comments`) +* Get comments for all issues and all pull requests on a repository (``GET /repos/:owner/:repo/pulls/comments``: :meth:`github.Repository.Repository.get_pulls_comments` or :meth:`github.Repository.Repository.get_pulls_review_comments`; ``GET /repos/:owner/:repo/issues/comments``: :meth:`github.Repository.Repository.get_issues_comments`) `Version 1.9.1 `_ (November 20th, 2012) -------------------------------------------------------------------------------------------------------------- @@ -225,9 +225,9 @@ Pre-release versions * GET `/gists/public` * GET `/issues` - * GET `/repos/:user/:repo/compare/:base...:head` - * GET `/repos/:user/:repo/git/trees/:sha?recursive-1` - * POST `/repos/:user/:repo/git/trees?base_tree-` + * GET `/repos/:owner/:repo/compare/:base...:head` + * GET `/repos/:owner/:repo/git/trees/:sha?recursive-1` + * POST `/repos/:owner/:repo/git/trees?base_tree-` * Gists * Autorizations diff --git a/github/AuthenticatedUser.py b/github/AuthenticatedUser.py index e64bb2d8..56638122 100644 --- a/github/AuthenticatedUser.py +++ b/github/AuthenticatedUser.py @@ -276,7 +276,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def add_to_starred(self, starred): """ - :calls: `PUT /user/starred/:user/:repo `_ + :calls: `PUT /user/starred/:owner/:repo `_ :param starred: :class:`github.Repository.Repository` :rtype: None """ @@ -290,7 +290,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def add_to_subscriptions(self, subscription): """ - :calls: `PUT /user/subscriptions/:user/:repo `_ + :calls: `PUT /user/subscriptions/:owner/:repo `_ :param subscription: :class:`github.Repository.Repository` :rtype: None """ @@ -304,7 +304,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def add_to_watched(self, watched): """ - :calls: `PUT /user/watched/:user/:repo `_ + :calls: `PUT /user/watched/:owner/:repo `_ :param watched: :class:`github.Repository.Repository` :rtype: None """ @@ -352,7 +352,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def create_fork(self, repo): """ - :calls: `POST /repos/:user/:repo/forks `_ + :calls: `POST /repos/:owner/:repo/forks `_ :param repo: :class:`github.Repository.Repository` :rtype: :class:`github.Repository.Repository` """ @@ -760,7 +760,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def get_repo(self, name): """ - :calls: `GET /repos/:user/:repo `_ + :calls: `GET /repos/:owner/:repo `_ :param name: string :rtype: :class:`github.Repository.Repository` """ @@ -863,7 +863,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def has_in_starred(self, starred): """ - :calls: `GET /user/starred/:user/:repo `_ + :calls: `GET /user/starred/:owner/:repo `_ :param starred: :class:`github.Repository.Repository` :rtype: bool """ @@ -878,7 +878,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def has_in_subscriptions(self, subscription): """ - :calls: `GET /user/subscriptions/:user/:repo `_ + :calls: `GET /user/subscriptions/:owner/:repo `_ :param subscription: :class:`github.Repository.Repository` :rtype: bool """ @@ -893,7 +893,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def has_in_watched(self, watched): """ - :calls: `GET /user/watched/:user/:repo `_ + :calls: `GET /user/watched/:owner/:repo `_ :param watched: :class:`github.Repository.Repository` :rtype: bool """ @@ -937,7 +937,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def remove_from_starred(self, starred): """ - :calls: `DELETE /user/starred/:user/:repo `_ + :calls: `DELETE /user/starred/:owner/:repo `_ :param starred: :class:`github.Repository.Repository` :rtype: None """ @@ -951,7 +951,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def remove_from_subscriptions(self, subscription): """ - :calls: `DELETE /user/subscriptions/:user/:repo `_ + :calls: `DELETE /user/subscriptions/:owner/:repo `_ :param subscription: :class:`github.Repository.Repository` :rtype: None """ @@ -965,7 +965,7 @@ class AuthenticatedUser(github.GithubObject.CompletableGithubObject): def remove_from_watched(self, watched): """ - :calls: `DELETE /user/watched/:user/:repo `_ + :calls: `DELETE /user/watched/:owner/:repo `_ :param watched: :class:`github.Repository.Repository` :rtype: None """ diff --git a/github/Commit.py b/github/Commit.py index 613885ab..264dc420 100644 --- a/github/Commit.py +++ b/github/Commit.py @@ -106,7 +106,7 @@ class Commit(github.GithubObject.CompletableGithubObject): def create_comment(self, body, line=github.GithubObject.NotSet, path=github.GithubObject.NotSet, position=github.GithubObject.NotSet): """ - :calls: `POST /repos/:user/:repo/commits/:sha/comments `_ + :calls: `POST /repos/:owner/:repo/commits/:sha/comments `_ :param body: string :param line: integer :param path: string @@ -136,7 +136,7 @@ class Commit(github.GithubObject.CompletableGithubObject): def create_status(self, state, target_url=github.GithubObject.NotSet, description=github.GithubObject.NotSet): """ - :calls: `POST /repos/:user/:repo/statuses/:sha `_ + :calls: `POST /repos/:owner/:repo/statuses/:sha `_ :param state: string :param target_url: string :param description: string @@ -162,7 +162,7 @@ class Commit(github.GithubObject.CompletableGithubObject): def get_comments(self): """ - :calls: `GET /repos/:user/:repo/commits/:sha/comments `_ + :calls: `GET /repos/:owner/:repo/commits/:sha/comments `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.CommitComment.CommitComment` """ return github.PaginatedList.PaginatedList( @@ -174,7 +174,7 @@ class Commit(github.GithubObject.CompletableGithubObject): def get_statuses(self): """ - :calls: `GET /repos/:user/:repo/statuses/:sha `_ + :calls: `GET /repos/:owner/:repo/statuses/:ref `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.CommitStatus.CommitStatus` """ return github.PaginatedList.PaginatedList( diff --git a/github/CommitComment.py b/github/CommitComment.py index bdb30272..0a3cacdf 100644 --- a/github/CommitComment.py +++ b/github/CommitComment.py @@ -123,7 +123,7 @@ class CommitComment(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/comments/:id `_ + :calls: `DELETE /repos/:owner/:repo/comments/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -135,7 +135,7 @@ class CommitComment(github.GithubObject.CompletableGithubObject): def edit(self, body): """ - :calls: `PATCH /repos/:user/:repo/comments/:id `_ + :calls: `PATCH /repos/:owner/:repo/comments/:id `_ :param body: string :rtype: None """ diff --git a/github/Download.py b/github/Download.py index 580e3cd2..3023d051 100644 --- a/github/Download.py +++ b/github/Download.py @@ -193,7 +193,7 @@ class Download(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/downloads/:id `_ + :calls: `DELETE /repos/:owner/:repo/downloads/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( diff --git a/github/Gist.py b/github/Gist.py index bc6c05cb..744df418 100644 --- a/github/Gist.py +++ b/github/Gist.py @@ -160,7 +160,7 @@ class Gist(github.GithubObject.CompletableGithubObject): def create_comment(self, body): """ - :calls: `POST /gists/:id/comments `_ + :calls: `POST /gists/:gist_id/comments `_ :param body: string :rtype: :class:`github.GistComment.GistComment` """ @@ -225,7 +225,7 @@ class Gist(github.GithubObject.CompletableGithubObject): def get_comment(self, id): """ - :calls: `GET /gists/comments/:id `_ + :calls: `GET /gists/:gist_id/comments/:id `_ :param id: integer :rtype: :class:`github.GistComment.GistComment` """ @@ -240,7 +240,7 @@ class Gist(github.GithubObject.CompletableGithubObject): def get_comments(self): """ - :calls: `GET /gists/:id/comments `_ + :calls: `GET /gists/:gist_id/comments `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GistComment.GistComment` """ return github.PaginatedList.PaginatedList( diff --git a/github/GistComment.py b/github/GistComment.py index 1c0c5978..498b2e1b 100644 --- a/github/GistComment.py +++ b/github/GistComment.py @@ -83,7 +83,7 @@ class GistComment(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /gists/comments/:id `_ + :calls: `DELETE /gists/:gist_id/comments/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -95,7 +95,7 @@ class GistComment(github.GithubObject.CompletableGithubObject): def edit(self, body): """ - :calls: `PATCH /gists/comments/:id `_ + :calls: `PATCH /gists/:gist_id/comments/:id `_ :param body: string :rtype: None """ diff --git a/github/GitRef.py b/github/GitRef.py index bd489c81..ee55ef05 100644 --- a/github/GitRef.py +++ b/github/GitRef.py @@ -59,7 +59,7 @@ class GitRef(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/git/refs/:ref `_ + :calls: `DELETE /repos/:owner/:repo/git/refs/:ref `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -71,7 +71,7 @@ class GitRef(github.GithubObject.CompletableGithubObject): def edit(self, sha, force=github.GithubObject.NotSet): """ - :calls: `PATCH /repos/:user/:repo/git/refs/:ref `_ + :calls: `PATCH /repos/:owner/:repo/git/refs/:ref `_ :param sha: string :param force: bool :rtype: None diff --git a/github/Hook.py b/github/Hook.py index 6be867e3..17b6a480 100644 --- a/github/Hook.py +++ b/github/Hook.py @@ -107,7 +107,7 @@ class Hook(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/hooks/:id `_ + :calls: `DELETE /repos/:owner/:repo/hooks/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -119,7 +119,7 @@ class Hook(github.GithubObject.CompletableGithubObject): def edit(self, name, config, events=github.GithubObject.NotSet, add_events=github.GithubObject.NotSet, remove_events=github.GithubObject.NotSet, active=github.GithubObject.NotSet): """ - :calls: `PATCH /repos/:user/:repo/hooks/:id `_ + :calls: `PATCH /repos/:owner/:repo/hooks/:id `_ :param name: string :param config: dict :param events: list of string @@ -156,7 +156,7 @@ class Hook(github.GithubObject.CompletableGithubObject): def test(self): """ - :calls: `POST /repos/:user/:repo/hooks/:id/test `_ + :calls: `POST /repos/:owner/:repo/hooks/:id/test `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( diff --git a/github/Issue.py b/github/Issue.py index 84542541..7fa890e6 100644 --- a/github/Issue.py +++ b/github/Issue.py @@ -188,7 +188,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def add_to_labels(self, *labels): """ - :calls: `POST /repos/:user/:repo/issues/:number/labels `_ + :calls: `POST /repos/:owner/:repo/issues/:number/labels `_ :param label: :class:`github.Label.Label` :rtype: None """ @@ -203,7 +203,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def create_comment(self, body): """ - :calls: `POST /repos/:user/:repo/issues/:number/comments `_ + :calls: `POST /repos/:owner/:repo/issues/:number/comments `_ :param body: string :rtype: :class:`github.IssueComment.IssueComment` """ @@ -221,7 +221,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def delete_labels(self): """ - :calls: `DELETE /repos/:user/:repo/issues/:number/labels `_ + :calls: `DELETE /repos/:owner/:repo/issues/:number/labels `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -233,7 +233,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def edit(self, title=github.GithubObject.NotSet, body=github.GithubObject.NotSet, assignee=github.GithubObject.NotSet, state=github.GithubObject.NotSet, milestone=github.GithubObject.NotSet, labels=github.GithubObject.NotSet): """ - :calls: `PATCH /repos/:user/:repo/issues/:number `_ + :calls: `PATCH /repos/:owner/:repo/issues/:number `_ :param title: string :param body: string :param assignee: :class:`github.NamedUser.NamedUser` or None @@ -271,7 +271,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def get_comment(self, id): """ - :calls: `GET /repos/:user/:repo/issues/comments/:id `_ + :calls: `GET /repos/:owner/:repo/issues/comments/:id `_ :param id: integer :rtype: :class:`github.IssueComment.IssueComment` """ @@ -286,7 +286,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def get_comments(self): """ - :calls: `GET /repos/:user/:repo/issues/:number/comments `_ + :calls: `GET /repos/:owner/:repo/issues/:number/comments `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.IssueComment.IssueComment` """ return github.PaginatedList.PaginatedList( @@ -298,7 +298,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def get_events(self): """ - :calls: `GET /repos/:user/:repo/issues/:number/events `_ + :calls: `GET /repos/:owner/:repo/issues/:issue_number/events `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.IssueEvent.IssueEvent` """ return github.PaginatedList.PaginatedList( @@ -310,7 +310,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def get_labels(self): """ - :calls: `GET /repos/:user/:repo/issues/:number/labels `_ + :calls: `GET /repos/:owner/:repo/issues/:number/labels `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Label.Label` """ return github.PaginatedList.PaginatedList( @@ -322,7 +322,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def remove_from_labels(self, label): """ - :calls: `DELETE /repos/:user/:repo/issues/:number/labels/:name `_ + :calls: `DELETE /repos/:owner/:repo/issues/:number/labels/:name `_ :param label: :class:`github.Label.Label` :rtype: None """ @@ -336,7 +336,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def set_labels(self, *labels): """ - :calls: `PUT /repos/:user/:repo/issues/:number/labels `_ + :calls: `PUT /repos/:owner/:repo/issues/:number/labels `_ :param label: :class:`github.Label.Label` :rtype: None """ diff --git a/github/IssueComment.py b/github/IssueComment.py index 906b4059..79720181 100644 --- a/github/IssueComment.py +++ b/github/IssueComment.py @@ -92,7 +92,7 @@ class IssueComment(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/issues/comments/:id `_ + :calls: `DELETE /repos/:owner/:repo/issues/comments/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -104,7 +104,7 @@ class IssueComment(github.GithubObject.CompletableGithubObject): def edit(self, body): """ - :calls: `PATCH /repos/:user/:repo/issues/comments/:id `_ + :calls: `PATCH /repos/:owner/:repo/issues/comments/:id `_ :param body: string :rtype: None """ diff --git a/github/Label.py b/github/Label.py index 52e6f2ed..ff1c3d18 100644 --- a/github/Label.py +++ b/github/Label.py @@ -60,7 +60,7 @@ class Label(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/labels/:name `_ + :calls: `DELETE /repos/:owner/:repo/labels/:name `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -72,7 +72,7 @@ class Label(github.GithubObject.CompletableGithubObject): def edit(self, name, color): """ - :calls: `PATCH /repos/:user/:repo/labels/:name `_ + :calls: `PATCH /repos/:owner/:repo/labels/:name `_ :param name: string :param color: string :rtype: None diff --git a/github/MainClass.py b/github/MainClass.py index db99bce3..dbde89d9 100644 --- a/github/MainClass.py +++ b/github/MainClass.py @@ -158,7 +158,7 @@ class Github(object): def get_repo(self, full_name): """ - :calls: `GET /repos/:user/:repo `_ + :calls: `GET /repos/:owner/:repo `_ :rtype: :class:`github.Repository.Repository` """ assert isinstance(full_name, (str, unicode)), full_name diff --git a/github/Milestone.py b/github/Milestone.py index 32394583..717b23ad 100644 --- a/github/Milestone.py +++ b/github/Milestone.py @@ -128,7 +128,7 @@ class Milestone(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/milestones/:number `_ + :calls: `DELETE /repos/:owner/:repo/milestones/:number `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -140,7 +140,7 @@ class Milestone(github.GithubObject.CompletableGithubObject): def edit(self, title, state=github.GithubObject.NotSet, description=github.GithubObject.NotSet, due_on=github.GithubObject.NotSet): """ - :calls: `PATCH /repos/:user/:repo/milestones/:number `_ + :calls: `PATCH /repos/:owner/:repo/milestones/:number `_ :param title: string :param state: string :param description: string @@ -170,7 +170,7 @@ class Milestone(github.GithubObject.CompletableGithubObject): def get_labels(self): """ - :calls: `GET /repos/:user/:repo/milestones/:number/labels `_ + :calls: `GET /repos/:owner/:repo/milestones/:number/labels `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Label.Label` """ return github.PaginatedList.PaginatedList( diff --git a/github/NamedUser.py b/github/NamedUser.py index 3e24e5ac..12eed7e2 100644 --- a/github/NamedUser.py +++ b/github/NamedUser.py @@ -383,7 +383,7 @@ class NamedUser(github.GithubObject.CompletableGithubObject): def get_repo(self, name): """ - :calls: `GET /repos/:user/:repo `_ + :calls: `GET /repos/:owner/:repo `_ :param name: string :rtype: :class:`github.Repository.Repository` """ diff --git a/github/Organization.py b/github/Organization.py index 8c19f160..a89b5b42 100644 --- a/github/Organization.py +++ b/github/Organization.py @@ -250,7 +250,7 @@ class Organization(github.GithubObject.CompletableGithubObject): def create_fork(self, repo): """ - :calls: `POST /repos/:user/:repo/forks `_ + :calls: `POST /repos/:owner/:repo/forks `_ :param repo: :class:`github.Repository.Repository` :rtype: :class:`github.Repository.Repository` """ @@ -460,7 +460,7 @@ class Organization(github.GithubObject.CompletableGithubObject): def get_repo(self, name): """ - :calls: `GET /repos/:user/:repo `_ + :calls: `GET /repos/:owner/:repo `_ :param name: string :rtype: :class:`github.Repository.Repository` """ diff --git a/github/PullRequest.py b/github/PullRequest.py index 8104878b..f0d8ed12 100644 --- a/github/PullRequest.py +++ b/github/PullRequest.py @@ -260,7 +260,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def create_comment(self, body, commit_id, path, position): """ - :calls: `POST /repos/:user/:repo/pulls/:number/comments `_ + :calls: `POST /repos/:owner/:repo/pulls/:number/comments `_ :param body: string :param commit_id: :class:`github.Commit.Commit` :param path: string @@ -271,7 +271,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def create_review_comment(self, body, commit_id, path, position): """ - :calls: `POST /repos/:user/:repo/pulls/:number/comments `_ + :calls: `POST /repos/:owner/:repo/pulls/:number/comments `_ :param body: string :param commit_id: :class:`github.Commit.Commit` :param path: string @@ -298,7 +298,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def create_issue_comment(self, body): """ - :calls: `POST /repos/:user/:repo/issues/:number/comments `_ + :calls: `POST /repos/:owner/:repo/issues/:number/comments `_ :param body: string :rtype: :class:`github.IssueComment.IssueComment` """ @@ -316,7 +316,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def edit(self, title=github.GithubObject.NotSet, body=github.GithubObject.NotSet, state=github.GithubObject.NotSet): """ - :calls: `PATCH /repos/:user/:repo/pulls/:number `_ + :calls: `PATCH /repos/:owner/:repo/pulls/:number `_ :param title: string :param body: string :param state: string @@ -342,7 +342,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_comment(self, id): """ - :calls: `GET /repos/:user/:repo/pulls/comments/:number `_ + :calls: `GET /repos/:owner/:repo/pulls/comments/:number `_ :param id: integer :rtype: :class:`github.PullRequestComment.PullRequestComment` """ @@ -350,7 +350,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_review_comment(self, id): """ - :calls: `GET /repos/:user/:repo/pulls/comments/:number `_ + :calls: `GET /repos/:owner/:repo/pulls/comments/:number `_ :param id: integer :rtype: :class:`github.PullRequestComment.PullRequestComment` """ @@ -365,14 +365,14 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_comments(self): """ - :calls: `GET /repos/:user/:repo/pulls/:number/comments `_ + :calls: `GET /repos/:owner/:repo/pulls/:number/comments `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment` """ return self.get_review_comments() def get_review_comments(self): """ - :calls: `GET /repos/:user/:repo/pulls/:number/comments `_ + :calls: `GET /repos/:owner/:repo/pulls/:number/comments `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment` """ return github.PaginatedList.PaginatedList( @@ -384,7 +384,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_commits(self): """ - :calls: `GET /repos/:user/:repo/pulls/:number/commits `_ + :calls: `GET /repos/:owner/:repo/pulls/:number/commits `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Commit.Commit` """ return github.PaginatedList.PaginatedList( @@ -396,7 +396,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_files(self): """ - :calls: `GET /repos/:user/:repo/pulls/:number/files `_ + :calls: `GET /repos/:owner/:repo/pulls/:number/files `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.File.File` """ return github.PaginatedList.PaginatedList( @@ -408,7 +408,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_issue_comment(self, id): """ - :calls: `GET /repos/:user/:repo/issues/comments/:id `_ + :calls: `GET /repos/:owner/:repo/issues/comments/:id `_ :param id: integer :rtype: :class:`github.IssueComment.IssueComment` """ @@ -423,7 +423,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def get_issue_comments(self): """ - :calls: `GET /repos/:user/:repo/issues/:number/comments `_ + :calls: `GET /repos/:owner/:repo/issues/:number/comments `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.IssueComment.IssueComment` """ return github.PaginatedList.PaginatedList( @@ -435,7 +435,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def is_merged(self): """ - :calls: `GET /repos/:user/:repo/pulls/:number/merge `_ + :calls: `GET /repos/:owner/:repo/pulls/:number/merge `_ :rtype: bool """ status, headers, data = self._requester.requestJson( @@ -448,7 +448,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject): def merge(self, commit_message=github.GithubObject.NotSet): """ - :calls: `PUT /repos/:user/:repo/pulls/:number/merge `_ + :calls: `PUT /repos/:owner/:repo/pulls/:number/merge `_ :param commit_message: string :rtype: :class:`github.PullRequestMergeStatus.PullRequestMergeStatus` """ diff --git a/github/PullRequestComment.py b/github/PullRequestComment.py index 9704ef95..aec3ed84 100644 --- a/github/PullRequestComment.py +++ b/github/PullRequestComment.py @@ -133,7 +133,7 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/pulls/comments/:number `_ + :calls: `DELETE /repos/:owner/:repo/pulls/comments/:number `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -145,7 +145,7 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject): def edit(self, body): """ - :calls: `PATCH /repos/:user/:repo/pulls/comments/:number `_ + :calls: `PATCH /repos/:owner/:repo/pulls/comments/:number `_ :param body: string :rtype: None """ diff --git a/github/Repository.py b/github/Repository.py index 01072aad..306e9dc2 100644 --- a/github/Repository.py +++ b/github/Repository.py @@ -308,7 +308,7 @@ class Repository(github.GithubObject.CompletableGithubObject): def add_to_collaborators(self, collaborator): """ - :calls: `PUT /repos/:user/:repo/collaborators/:user `_ + :calls: `PUT /repos/:owner/:repo/collaborators/:user `_ :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 `_ + :calls: `GET /repos/:owner/:repo/compare/:base...:head `_ :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 `_ + :calls: `POST /repos/:owner/:repo/downloads `_ :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 `_ + :calls: `POST /repos/:owner/:repo/git/blobs `_ :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 `_ + :calls: `POST /repos/:owner/:repo/git/commits `_ :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 `_ + :calls: `POST /repos/:owner/:repo/git/refs `_ :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 `_ + :calls: `POST /repos/:owner/:repo/git/tags `_ :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 `_ + :calls: `POST /repos/:owner/:repo/git/trees `_ :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 `_ + :calls: `POST /repos/:owner/:repo/hooks `_ :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 `_ + :calls: `POST /repos/:owner/:repo/issues `_ :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 `_ + :calls: `POST /repos/:owner/:repo/keys `_ :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 `_ + :calls: `POST /repos/:owner/:repo/labels `_ :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 `_ + :calls: `POST /repos/:owner/:repo/milestones `_ :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 `_ + :calls: `POST /repos/:owner/:repo/pulls `_ :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 `_ + :calls: `DELETE /repos/:owner/:repo `_ :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 `_ + :calls: `PATCH /repos/:owner/:repo `_ :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 `_ + :calls: `GET /repos/:owner/:repo/:archive_format/:ref `_ :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 `_ + :calls: `GET /repos/:owner/:repo/assignees `_ :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 `_ + :calls: `GET /repos/:owner/:repo/branches/:branch `_ :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 `_ + :calls: `GET /repos/:owner/:repo/branches `_ :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 `_ + :calls: `GET /repos/:owner/:repo/collaborators `_ :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 `_ + :calls: `GET /repos/:owner/:repo/comments/:id `_ :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 `_ + :calls: `GET /repos/:owner/:repo/comments `_ :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 `_ + :calls: `GET /repos/:owner/:repo/commits/:sha `_ :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 `_ + :calls: `GET /repos/:owner/:repo/commits `_ :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 `_ :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 `_ :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 `_ :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 `_ + :calls: `GET /repos/:owner/:repo/contributors `_ :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 `_ + :calls: `GET /repos/:owner/:repo/downloads/:id `_ :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 `_ + :calls: `GET /repos/:owner/:repo/downloads `_ :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 `_ + :calls: `GET /repos/:owner/:repo/events `_ :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 `_ + :calls: `GET /repos/:owner/:repo/forks `_ :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 `_ + :calls: `GET /repos/:owner/:repo/git/blobs/:sha `_ :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 `_ + :calls: `GET /repos/:owner/:repo/git/commits/:sha `_ :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 `_ + :calls: `GET /repos/:owner/:repo/git/refs/:ref `_ :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 `_ + :calls: `GET /repos/:owner/:repo/git/refs `_ :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 `_ + :calls: `GET /repos/:owner/:repo/git/tags/:sha `_ :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 `_ + :calls: `GET /repos/:owner/:repo/git/trees/:sha `_ :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 `_ + :calls: `GET /repos/:owner/:repo/hooks/:id `_ :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 `_ + :calls: `GET /repos/:owner/:repo/hooks `_ :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 `_ + :calls: `GET /repos/:owner/:repo/issues/:number `_ :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 `_ + :calls: `GET /repos/:owner/:repo/issues `_ :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 `_ + :calls: `GET /repos/:owner/:repo/issues/comments `_ :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 `_ + :calls: `GET /repos/:owner/:repo/issues/events/:id `_ :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 `_ + :calls: `GET /repos/:owner/:repo/issues/events `_ :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 `_ + :calls: `GET /repos/:owner/:repo/keys/:id `_ :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 `_ + :calls: `GET /repos/:owner/:repo/keys `_ :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 `_ + :calls: `GET /repos/:owner/:repo/labels/:name `_ :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 `_ + :calls: `GET /repos/:owner/:repo/labels `_ :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 `_ + :calls: `GET /repos/:owner/:repo/languages `_ :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 `_ + :calls: `GET /repos/:owner/:repo/milestones/:number `_ :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 `_ + :calls: `GET /repos/:owner/:repo/milestones `_ :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 `_ + :calls: `GET /networks/:owner/:repo/events `_ :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 `_ + :calls: `GET /repos/:owner/:repo/pulls/:number `_ :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 `_ + :calls: `GET /repos/:owner/:repo/pulls `_ :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 `_ + :calls: `GET /repos/:owner/:repo/pulls/comments `_ :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 `_ + :calls: `GET /repos/:owner/:repo/pulls/comments `_ :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 `_ + :calls: `GET /repos/:owner/:repo/readme `_ :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 `_ + :calls: `GET /repos/:owner/:repo/stargazers `_ :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 `_ + :calls: `GET /repos/:owner/:repo/subscribers `_ :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 `_ + :calls: `GET /repos/:owner/:repo/tags `_ :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 `_ + :calls: `GET /repos/:owner/:repo/teams `_ :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 `_ + :calls: `GET /repos/:owner/:repo/watchers `_ :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 `_ + :calls: `GET /repos/:owner/:repo/assignees/:assignee `_ :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 `_ + :calls: `GET /repos/:owner/:repo/collaborators/:user `_ :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 `_ + :calls: `POST /repos/:owner/:repo/merges `_ :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 `_ + :calls: `DELETE /repos/:owner/:repo/collaborators/:user `_ :param collaborator: :class:`github.NamedUser.NamedUser` :rtype: None """ diff --git a/github/RepositoryKey.py b/github/RepositoryKey.py index 79953506..00da76b8 100644 --- a/github/RepositoryKey.py +++ b/github/RepositoryKey.py @@ -83,7 +83,7 @@ class RepositoryKey(github.GithubObject.CompletableGithubObject): def delete(self): """ - :calls: `DELETE /repos/:user/:repo/keys/:id `_ + :calls: `DELETE /repos/:owner/:repo/keys/:id `_ :rtype: None """ headers, data = self._requester.requestJsonAndCheck( @@ -95,7 +95,7 @@ class RepositoryKey(github.GithubObject.CompletableGithubObject): def edit(self, title=github.GithubObject.NotSet, key=github.GithubObject.NotSet): """ - :calls: `PATCH /repos/:user/:repo/keys/:id `_ + :calls: `PATCH /repos/:owner/:repo/keys/:id `_ :param title: string :param key: string :rtype: None diff --git a/github/Team.py b/github/Team.py index 0081aedd..4c570426 100644 --- a/github/Team.py +++ b/github/Team.py @@ -100,7 +100,7 @@ class Team(github.GithubObject.CompletableGithubObject): def add_to_repos(self, repo): """ - :calls: `PUT /teams/:id/repos/:user/:repo `_ + :calls: `PUT /teams/:id/repos/:org/:repo `_ :param repo: :class:`github.Repository.Repository` :rtype: None """ @@ -187,7 +187,7 @@ class Team(github.GithubObject.CompletableGithubObject): def has_in_repos(self, repo): """ - :calls: `GET /teams/:id/repos/:user/:repo `_ + :calls: `GET /teams/:id/repos/:owner/:repo `_ :param repo: :class:`github.Repository.Repository` :rtype: bool """ @@ -216,7 +216,7 @@ class Team(github.GithubObject.CompletableGithubObject): def remove_from_repos(self, repo): """ - :calls: `DELETE /teams/:id/repos/:user/:repo `_ + :calls: `DELETE /teams/:id/repos/:owner/:repo `_ :param repo: :class:`github.Repository.Repository` :rtype: None """ diff --git a/scripts/compare_to_api_ref_doc.py b/scripts/compare_to_api_ref_doc.py index 1e563445..0c2166e8 100755 --- a/scripts/compare_to_api_ref_doc.py +++ b/scripts/compare_to_api_ref_doc.py @@ -85,8 +85,8 @@ def parseApiList(): assert newUrl > url, url url = newUrl elif line.startswith(" * "): - verb, method = line[4:].split(": ") - if method.startswith(":meth:"): + verb = line[4:].split(":")[0] + if "Not implemented" not in line: urls.add(url + " " + verb) return urls