# HG changeset patch # User Marcin Kuzminski # Date 2017-06-27 15:19:54 # Node ID e36eb8b6eb4a2a06b99555ac8aa920fc505e222f # Parent 05beb7b65dabff6efcd22af4689a7485153a67cd docs: updated api documentation diff --git a/docs/api/methods/pull-request-methods.rst b/docs/api/methods/pull-request-methods.rst --- a/docs/api/methods/pull-request-methods.rst +++ b/docs/api/methods/pull-request-methods.rst @@ -6,7 +6,7 @@ pull_request methods close_pull_request ------------------ -.. py:function:: close_pull_request(apiuser, repoid, pullrequestid, userid=>) +.. py:function:: close_pull_request(apiuser, repoid, pullrequestid, userid=>, message=) Close the pull request specified by `pullrequestid`. @@ -19,6 +19,9 @@ close_pull_request :type pullrequestid: int :param userid: Close the pull request as this user. :type userid: Optional(str or int) + :param message: Optional message to close the Pull Request with. If not + specified it will be generated automatically. + :type message: Optional(str) Example output: @@ -27,6 +30,7 @@ close_pull_request "id": , "result": { "pull_request_id": "", + "close_status": ", "closed": "" }, "error": null @@ -105,10 +109,12 @@ create_pull_request :param description: Set the pull request description. :type description: Optional(str) :param reviewers: Set the new pull request reviewers list. + Reviewer defined by review rules will be added automatically to the + defined list. :type reviewers: Optional(list) Accepts username strings or objects of the format: - {'username': 'nick', 'reasons': ['original author']} + [{'username': 'nick', 'reasons': ['original author'], 'mandatory': }] get_pull_request @@ -320,7 +326,7 @@ merge_pull_request update_pull_request ------------------- -.. py:function:: update_pull_request(apiuser, repoid, pullrequestid, title=, description=, reviewers=, update_commits=, close_pull_request=) +.. py:function:: update_pull_request(apiuser, repoid, pullrequestid, title=, description=, reviewers=, update_commits=) Updates a pull request. @@ -336,10 +342,12 @@ update_pull_request :type description: Optional(str) :param reviewers: Update pull request reviewers list with new value. :type reviewers: Optional(list) + Accepts username strings or objects of the format: + + [{'username': 'nick', 'reasons': ['original author'], 'mandatory': }] + :param update_commits: Trigger update of commits for this pull request :type: update_commits: Optional(bool) - :param close_pull_request: Close this pull request with rejected state - :type: close_pull_request: Optional(bool) Example output: diff --git a/docs/api/methods/repo-methods.rst b/docs/api/methods/repo-methods.rst --- a/docs/api/methods/repo-methods.rst +++ b/docs/api/methods/repo-methods.rst @@ -527,6 +527,7 @@ get_repo_settings "id": 237, "result": { "extensions_largefiles": true, + "extensions_evolve": true, "hooks_changegroup_push_logger": true, "hooks_changegroup_repo_size": false, "hooks_outgoing_pull_logger": true, @@ -762,6 +763,49 @@ lock } +maintenance +----------- + +.. py:function:: maintenance(apiuser, repoid) + + Triggers a maintenance on the given repository. + + This command can only be run using an |authtoken| with admin + rights to the specified repository. For more information, + see :ref:`config-token-ref`. + + This command takes the following options: + + :param apiuser: This is filled automatically from the |authtoken|. + :type apiuser: AuthUser + :param repoid: The repository name or repository ID. + :type repoid: str or int + + Example output: + + .. code-block:: bash + + id : + result : { + "msg": "executed maintenance command", + "executed_actions": [ + , ... + ], + "repository": "" + } + error : null + + Example error output: + + .. code-block:: bash + + id : + result : null + error : { + "Unable to execute maintenance on ``" + } + + pull ----