docs: update API documentation.

docs/api/methods/pull-request-methods.rst

@@ -24,13 +24,12 b' close_pull_request'
 
    .. code-block:: bash
 
-     "id": <id_given_in_input>,
-     "result":
-       {
+       "id": <id_given_in_input>,
+       "result": {
            "pull_request_id":  "<int>",
            "closed":           "<bool>"
        },
-     "error": null
+       "error": null
 
 
 comment_pull_request 
@@ -67,15 +66,14 b' comment_pull_request'
 
    .. code-block:: bash
 
-     id : <id_given_in_input>
-     result :
-       {
+       id : <id_given_in_input>
+       result : {
            "pull_request_id":  "<Integer>",
            "comment_id":       "<Integer>",
            "status": {"given": <given_status>,
                       "was_changed": <bool status_was_actually_changed> },
-       }
-     error :  null
+       },
+       error :  null
 
 
 create_pull_request 
@@ -109,9 +107,8 b' create_pull_request'
    :param reviewers: Set the new pull request reviewers list.
    :type reviewers: Optional(list)
        Accepts username strings or objects of the format:
-       {
-           'username': 'nick', 'reasons': ['original author']
-       }
+
+           {'username': 'nick', 'reasons': ['original author']}
 
 
 get_pull_request 
@@ -305,9 +302,8 b' merge_pull_request'
 
    .. code-block:: bash
 
-     "id": <id_given_in_input>,
-     "result":
-       {
+       "id": <id_given_in_input>,
+       "result": {
            "executed":         "<bool>",
            "failure_reason":   "<int>",
            "merge_commit_id":  "<merge_commit_id>",
@@ -318,7 +314,7 b' merge_pull_request'
                                    "name":      "<name>"
                                }
        },
-     "error": null
+       "error": null
 
 
 update_pull_request 
@@ -349,9 +345,8 b' update_pull_request'
 
    .. code-block:: bash
 
-     id : <id_given_in_input>
-     result :
-       {
+       id : <id_given_in_input>
+       result : {
            "msg": "Updated pull request `63`",
            "pull_request": <pull_request_object>,
            "updated_reviewers": {
@@ -371,6 +366,6 b' update_pull_request'
              "removed": []
            }
        }
-     error :  null
+       error :  null
 
 

docs/api/methods/server-methods.rst

@@ -85,6 +85,58 b' get_ip'
        }
 
 
+get_method 
+----------
+
+.. py:function:: get_method(apiuser, pattern=<Optional:'*'>)
+
+   Returns list of all available API methods. By default match pattern
+   os "*" but any other pattern can be specified. eg *comment* will return
+   all methods with comment inside them. If just single method is matched
+   returned data will also include method specification
+
+   This command can only be run using an |authtoken| with admin rights to
+   the specified repository.
+
+   This command takes the following options:
+
+   :param apiuser: This is filled automatically from the |authtoken|.
+   :type apiuser: AuthUser
+   :param pattern: pattern to match method names against
+   :type older_then: Optional("*")
+
+   Example output:
+
+   .. code-block:: bash
+
+     id : <id_given_in_input>
+     "result": [
+       "changeset_comment",
+       "comment_pull_request",
+       "comment_commit"
+     ]
+     error :  null
+
+   .. code-block:: bash
+
+     id : <id_given_in_input>
+     "result": [
+       "comment_commit",
+       {
+         "apiuser": "<RequiredType>",
+         "comment_type": "<Optional:u'note'>",
+         "commit_id": "<RequiredType>",
+         "message": "<RequiredType>",
+         "repoid": "<RequiredType>",
+         "request": "<RequiredType>",
+         "resolves_comment_id": "<Optional:None>",
+         "status": "<Optional:None>",
+         "userid": "<Optional:<OptionalAttr:apiuser>>"
+       }
+     ]
+     error :  null
+
+
 get_server_info 
 ---------------
 

docs/api/methods/user-methods.rst

@@ -41,15 +41,16 b' create_user'
    :type force_password_change: Optional(``True`` | ``False``)
    :param create_personal_repo_group: Create personal repo group for this user
    :type create_personal_repo_group: Optional(``True`` | ``False``)
+
    Example output:
 
    .. code-block:: bash
 
        id : <id_given_in_input>
        result: {
-                 "msg" : "created new user `<username>`",
-                 "user": <user_obj>
-               }
+           "msg" : "created new user `<username>`",
+           "user": <user_obj>
+       }
        error:  null
 
    Example error output:
@@ -98,9 +99,9 b' delete_user'
 
        id : <id_given_in_input>
        result: {
-                 "msg" : "deleted user ID:<userid> <username>",
-                 "user": null
-               }
+           "msg" : "deleted user ID:<userid> <username>",
+           "user": null
+       }
        error:  null
 
    Example error output:
@@ -145,8 +146,8 b' get_user'
          "result": {
            "active": true,
            "admin": false,
-           "api_key": "api-key",
            "api_keys": [ list of keys ],
+           "auth_tokens": [ list of tokens with details ],
            "email": "[e-mail]",
            "emails": [
              "[e-mail]"
@@ -157,6 +158,7 b' get_user'
            "ip_addresses": [],
            "language": null,
            "last_login": "Timestamp",
+           "last_activity": "Timestamp",
            "lastname": "surnae",
            "permissions": {
              "global": [
@@ -183,6 +185,32 b' get_user'
        }
 
 
+get_user_audit_logs 
+-------------------
+
+.. py:function:: get_user_audit_logs(apiuser, userid=<Optional:<OptionalAttr:apiuser>>)
+
+   Fetches all action logs made by the specified user.
+
+   This command takes the following options:
+
+   :param apiuser: This is filled automatically from the |authtoken|.
+   :type apiuser: AuthUser
+   :param userid: Sets the userid whose list of locked |repos| will be
+       displayed.
+   :type userid: Optional(str or int)
+
+   Example output:
+
+   .. code-block:: bash
+
+       id : <id_given_in_input>
+       result : {
+           [action, action,...]
+       }
+       error :  null
+
+
 get_user_locks 
 --------------
 
@@ -232,7 +260,7 b' get_users'
    .. code-block:: bash
 
        id : <id_given_in_input>
-           result: [<user_object>, ...]
+       result: [<user_object>, ...]
        error:  null
 
 
@@ -279,9 +307,9 b' update_user'
 
        id : <id_given_in_input>
        result: {
-                 "msg" : "updated user ID:<userid> <username>",
-                 "user": <user_object>,
-               }
+           "msg" : "updated user ID:<userid> <username>",
+           "user": <user_object>,
+       }
        error:  null
 
    Example error output:

rhodecode/api/views/pull_request_api.py

@@ -244,9 +244,8 b' def merge_pull_request(request, apiuser,'
 
     .. code-block:: bash
 
-      "id": <id_given_in_input>,
-      "result":
-        {
+        "id": <id_given_in_input>,
+        "result": {
             "executed":         "<bool>",
             "failure_reason":   "<int>",
             "merge_commit_id":  "<merge_commit_id>",
@@ -257,8 +256,7 b' def merge_pull_request(request, apiuser,'
                                     "name":      "<name>"
                                 }
         },
-      "error": null
-
+        "error": null
     """
     repo = get_repo_or_error(repoid)
     if not isinstance(userid, Optional):
@@ -321,13 +319,12 b' def close_pull_request(request, apiuser,'
 
     .. code-block:: bash
 
-      "id": <id_given_in_input>,
-      "result":
-        {
+        "id": <id_given_in_input>,
+        "result": {
             "pull_request_id":  "<int>",
             "closed":           "<bool>"
         },
-      "error": null
+        "error": null
 
     """
     repo = get_repo_or_error(repoid)
@@ -396,15 +393,14 b' def comment_pull_request('
 
     .. code-block:: bash
 
-      id : <id_given_in_input>
-      result :
-        {
+        id : <id_given_in_input>
+        result : {
             "pull_request_id":  "<Integer>",
             "comment_id":       "<Integer>",
             "status": {"given": <given_status>,
                        "was_changed": <bool status_was_actually_changed> },
-        }
-      error :  null
+        },
+        error :  null
     """
     repo = get_repo_or_error(repoid)
     if not isinstance(userid, Optional):
@@ -535,9 +531,8 b' def create_pull_request('
     :param reviewers: Set the new pull request reviewers list.
     :type reviewers: Optional(list)
         Accepts username strings or objects of the format:
-        {
-            'username': 'nick', 'reasons': ['original author']
-        }
+
+            {'username': 'nick', 'reasons': ['original author']}
     """
 
     source = get_repo_or_error(source_repo)
@@ -633,9 +628,8 b' def update_pull_request('
 
     .. code-block:: bash
 
-      id : <id_given_in_input>
-      result :
-        {
+        id : <id_given_in_input>
+        result : {
             "msg": "Updated pull request `63`",
             "pull_request": <pull_request_object>,
             "updated_reviewers": {
@@ -655,7 +649,7 b' def update_pull_request('
               "removed": []
             }
         }
-      error :  null
+        error :  null
     """
 
     repo = get_repo_or_error(repoid)

rhodecode/api/views/user_api.py

@@ -133,7 +133,7 b' def get_users(request, apiuser):'
     .. code-block:: bash
 
         id : <id_given_in_input>
-            result: [<user_object>, ...]
+        result: [<user_object>, ...]
         error:  null
     """
 
@@ -191,15 +191,16 b' def create_user(request, apiuser, userna'
     :type force_password_change: Optional(``True`` | ``False``)
     :param create_personal_repo_group: Create personal repo group for this user
     :type create_personal_repo_group: Optional(``True`` | ``False``)
+
     Example output:
 
     .. code-block:: bash
 
         id : <id_given_in_input>
         result: {
-                  "msg" : "created new user `<username>`",
-                  "user": <user_obj>
-                }
+            "msg" : "created new user `<username>`",
+            "user": <user_obj>
+        }
         error:  null
 
     Example error output:
@@ -305,9 +306,9 b' def update_user(request, apiuser, userid'
 
         id : <id_given_in_input>
         result: {
-                  "msg" : "updated user ID:<userid> <username>",
-                  "user": <user_object>,
-                }
+            "msg" : "updated user ID:<userid> <username>",
+            "user": <user_object>,
+        }
         error:  null
 
     Example error output:
@@ -384,9 +385,9 b' def delete_user(request, apiuser, userid'
 
         id : <id_given_in_input>
         result: {
-                  "msg" : "deleted user ID:<userid> <username>",
-                  "user": null
-                }
+            "msg" : "deleted user ID:<userid> <username>",
+            "user": null
+        }
         error:  null
 
     Example error output: