kallithea Changeset - d69c3e30f8b5

Changeset - d69c3e30f8b5

Parent rev.

Child rev.

[Not reviewed]

stable

0 1 0

Mads Kiilerich - 3 years ago 2022-10-13 19:37:43
mads@kiilerich.com

Grafted from: 9f919f8b2eac

api docs: update docstrings

Changes contributed by toras <toras9000@gmail.com>.

1 file changed with 22 insertions and 25 deletions:

kallithea/controllers/api/api.py

0 comments (0 inline, 0 general)

kallithea/controllers/api/api.py

➞

Show inline comments

@@ @@ -338,16 +338,18 @@ class ApiController(JSONRPCController): @@
         OUTPUT::
           id : <id_given_in_input>
           result : {
             'modules': [<module name>,...]
+            'modules': [ [<module name>, <module version>], ...]
             'py_version': <python version>,
             'platform': <platform type>,
             'kallithea_version': <kallithea version>
             'kallithea_version': <kallithea version>,
             'git_version': '<git version>',
             'git_path': '<git path>'
+          }
           error :  null
         """
         return db.Setting.get_server_info()
     def get_user(self, userid=None):
@@ @@ -364,31 +366,26 @@ class ApiController(JSONRPCController): @@
         OUTPUT::
             id : <id_given_in_input>
             result: None if user does not exist or
+                    {
                         "user_id" :     "<user_id>",
                         "api_key" :     "<api_key>",
                         "api_keys":     "[<list of all API keys including additional ones>]"
                         "username" :    "<username>",
                         "firstname":    "<firstname>",
                         "lastname" :    "<lastname>",
                         "email" :       "<email>",
                         "emails":       "[<list of all emails including additional ones>]",
                         "ip_addresses": "[<ip_address_for_user>,...]",
                         "active" :      "<bool: user active>",
                         "admin" :       "<bool: user is admin>",
                         "extern_name" : "<extern_name>",
                         "extern_type" : "<extern type>
                         "last_login":   "<last_login>",
                         "admin" :       "<bool: user is admin>",
                         "permissions": {
                             "global": ["hg.create.repository",
                                        "repository.read",
                                        "hg.register.manual_activate"],
                             "repositories": {"repo1": "repository.none"},
                             "repositories_groups": {"Group1": "group.read"}
                             "repositories_groups": {"Group1": "group.read"},
                             "user_groups": { "usrgrp1": "usergroup.admin" }
                          },
+                    }
             error:  null
         """
@@ @@ -443,15 +440,15 @@ class ApiController(JSONRPCController): @@
         :type username: str or int
         :param email: email
         :type email: str
         :param password: password
         :type password: Optional(str)
         :param firstname: firstname
-        :type firstname: Optional(str)
         :type firstname: str
         :param lastname: lastname
-        :type lastname: Optional(str)
         :type lastname: str
         :param active: active
         :type active: Optional(bool)
         :param admin: admin
         :type admin: Optional(bool)
         :param extern_name: name of extern
         :type extern_name: Optional(str)
@@ @@ -519,15 +516,15 @@ class ApiController(JSONRPCController): @@
         updates given user if such user exists. This command can
         be executed only using api_key belonging to user with admin rights.
         :param userid: userid to update
         :type userid: str or int
         :param username: new username
         :type username: str or int
+        :type username: Optional(str or int)
         :param email: email
         :type email: str
+        :type email: Optional(str)
         :param password: password
         :type password: Optional(str)
         :param firstname: firstname
         :type firstname: Optional(str)
         :param lastname: lastname
         :type lastname: Optional(str)
@@ @@ -646,13 +643,15 @@ class ApiController(JSONRPCController): @@
             id : <id_given_in_input>
             result : None if group not exist
+                     {
                        "users_group_id" : "<id>",
                        "group_name" :     "<groupname>",
                        "group_description": "<description>"
                        "active":          "<bool>",
                        "owner":           "<username>"
                        "members" :  [<user_obj>,...]
+                     }
             error : null
         """
         user_group = get_user_group_or_error(usergroupid)
@@ @@ -691,13 +690,13 @@ class ApiController(JSONRPCController): @@
         belonging to user with admin rights or an user who has create user group
         permission
         :param group_name: name of new user group
         :type group_name: str
         :param description: group description
         :type description: str
+        :type description: Optional(str)
         :param owner: owner of group. If not passed apiuser is the owner
         :type owner: Optional(str or int)
         :param active: group is active
         :type active: Optional(bool)
         OUTPUT::
@@ @@ -807,13 +806,13 @@ class ApiController(JSONRPCController): @@
         """
         Delete given user group by user group id or name.
         This command can be executed only using api_key
         belonging to user with admin rights or an admin of given user group
         :param usergroupid:
         :type usergroupid: int
+        :type usergroupid: str or int
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg": "deleted user group ID:<user_group_id> <user_group_name>"
@@ @@ -859,15 +858,15 @@ class ApiController(JSONRPCController): @@
         """
         Adds a user to a user group. If user exists in that group success will be
         `false`. This command can be executed only using api_key
         belonging to user with admin rights  or an admin of given user group
         :param usergroupid:
         :type usergroupid: int
+        :type usergroupid: str or int
         :param userid:
         :type userid: int
+        :type userid: str or int
         OUTPUT::
           id : <id_given_in_input>
           result : {
               "success": True|False # depends on if member is in group
@@ @@ -1202,14 +1201,13 @@ class ApiController(JSONRPCController): @@
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "msg": "Created new repository `<reponame>`",
                       "success": true,
                       "task": "<celery task id or None if done sync>"
                       "success": true
+                    }
             error:  null
         ERROR OUTPUT::
           id : <id_given_in_input>
@@ @@ -1390,14 +1388,13 @@ class ApiController(JSONRPCController): @@
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "msg": "Created fork of `<reponame>` as `<forkname>`",
                       "success": true,
                       "task": "<celery task id or None if done sync>"
                       "success": true
+                    }
             error:  null
         """
         repo = get_repo_or_error(repoid)
         repo_name = repo.repo_name
@@ @@ -2216,20 +2213,20 @@ class ApiController(JSONRPCController): @@
         :type owner: Optional(str or int)
         :param gist_type: type of gist 'public' or 'private'
         :type gist_type: Optional(str)
         :param lifetime: time in minutes of gist lifetime
         :type lifetime: Optional(int)
         :param description: gist description
-        :type description: Optional(str)
         :type description: str
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg": "created new gist",
-            "gist": {}
+            "gist": <gist_object>
+          }
           error :  null
         ERROR OUTPUT::
           id : <id_given_in_input>
@@ @@ -2269,13 +2266,13 @@ class ApiController(JSONRPCController): @@
         :type gistid: str
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "deleted gist ID: <gist_id>",
+            "msg": "deleted gist ID: <gist_id>",
             "gist": null
+          }
           error :  null
         ERROR OUTPUT::

0 comments (0 inline, 0 general)