From 9d236e0320dafcb9a09dca83d2def455b288ecc3 Mon Sep 17 00:00:00 2001 From: Marcin Kuzminski Date: Mon, 12 Oct 2020 15:38:00 +0200 Subject: [PATCH] docs: updated API docs --- docs/api/methods/pull-request-methods.rst | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/docs/api/methods/pull-request-methods.rst b/docs/api/methods/pull-request-methods.rst index 77d8cf43..d3368393 100644 --- a/docs/api/methods/pull-request-methods.rst +++ b/docs/api/methods/pull-request-methods.rst @@ -90,7 +90,7 @@ comment_pull_request create_pull_request ------------------- -.. py:function:: create_pull_request(apiuser, source_repo, target_repo, source_ref, target_ref, owner=>, title=, description=, description_renderer=, reviewers=) +.. py:function:: create_pull_request(apiuser, source_repo, target_repo, source_ref, target_ref, owner=>, title=, description=, description_renderer=, reviewers=, observers=) Creates a new pull request. @@ -128,6 +128,13 @@ create_pull_request Accepts username strings or objects of the format: [{'username': 'nick', 'reasons': ['original author'], 'mandatory': }] + :param observers: Set the new pull request observers list. + Reviewer defined by review rules will be added automatically to the + defined list. This feature is only available in RhodeCode EE + :type observers: Optional(list) + Accepts username strings or objects of the format: + + [{'username': 'nick', 'reasons': ['original author']}] get_pull_request @@ -392,7 +399,7 @@ merge_pull_request update_pull_request ------------------- -.. py:function:: update_pull_request(apiuser, pullrequestid, repoid=, title=, description=, description_renderer=, reviewers=, update_commits=) +.. py:function:: update_pull_request(apiuser, pullrequestid, repoid=, title=, description=, description_renderer=, reviewers=, observers=, update_commits=) Updates a pull request. @@ -414,7 +421,11 @@ update_pull_request Accepts username strings or objects of the format: [{'username': 'nick', 'reasons': ['original author'], 'mandatory': }] + :param observers: Update pull request observers list with new value. + :type observers: Optional(list) + Accepts username strings or objects of the format: + [{'username': 'nick', 'reasons': ['should be aware about this PR']}] :param update_commits: Trigger update of commits for this pull request :type: update_commits: Optional(bool) @@ -432,6 +443,12 @@ update_pull_request ], "removed": [] }, + "updated_observers": { + "added": [ + "username" + ], + "removed": [] + }, "updated_commits": { "added": [ ""