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 @@ -39,7 +39,7 @@ close_pull_request comment_pull_request -------------------- -.. py:function:: comment_pull_request(apiuser, pullrequestid, repoid=, message=, commit_id=, status=, comment_type=, resolves_comment_id=, extra_recipients=, userid=>) +.. py:function:: comment_pull_request(apiuser, pullrequestid, repoid=, message=, commit_id=, status=, comment_type=, resolves_comment_id=, extra_recipients=, userid=>, send_email=) Comment on the pull request specified with the `pullrequestid`, in the |repo| specified by the `repoid`, and optionally change the @@ -70,6 +70,8 @@ comment_pull_request :type extra_recipients: Optional(list) :param userid: Comment on the pull request as this user :type userid: Optional(str or int) + :param send_email: Define if this comment should also send email notification + :type send_email: Optional(bool) Example output: @@ -160,6 +162,7 @@ get_pull_request "status" : "", "created_on": "", "updated_on": "", + "versions": "", "commit_ids": [ ... "", @@ -249,7 +252,9 @@ get_pull_request_comments }, "comment_text": "Example text", "comment_type": null, - "pull_request_version": null + "pull_request_version": null, + "comment_commit_id": None, + "comment_pull_request_id": } ], error : null 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 @@ -28,7 +28,7 @@ add_field_to_repo comment_commit -------------- -.. py:function:: comment_commit(apiuser, repoid, commit_id, message, status=, comment_type=, resolves_comment_id=, extra_recipients=, userid=>) +.. py:function:: comment_commit(apiuser, repoid, commit_id, message, status=, comment_type=, resolves_comment_id=, extra_recipients=, userid=>, send_email=) Set a commit comment, and optionally change the status of the commit. @@ -52,6 +52,8 @@ comment_commit :type extra_recipients: Optional(list) :param userid: Set the user name of the comment creator. :type userid: Optional(str or int) + :param send_email: Define if this comment should also send email notification + :type send_email: Optional(bool) Example error output: diff --git a/docs/api/methods/search-methods.rst b/docs/api/methods/search-methods.rst --- a/docs/api/methods/search-methods.rst +++ b/docs/api/methods/search-methods.rst @@ -3,6 +3,21 @@ search methods ============== +get_audit_logs +-------------- + +.. py:function:: get_audit_logs(apiuser, query) + + return full audit logs based on the query. + + Please see `example query in admin > settings > audit logs` for examples + + :param apiuser: This is filled automatically from the |authtoken|. + :type apiuser: AuthUser + :param query: filter query, example: action:repo.artifact.add date:[20200401 TO 20200601]" + :type query: str + + search ------