kallithea Changeset - ac5525c48f0a

Changeset - ac5525c48f0a

Parent rev.

Child rev.

[Not reviewed]

stable

0 2 0

Mads Kiilerich (mads) - 3 years ago 2022-10-14 14:25:12
mads@kiilerich.com

Grafted from: 91e76b014653

api docs: more consistent use of space around ":" in examples

The examples are informal pseudo code - not json and not python. But let's try
to be consistent anyway.

2 files changed with 424 insertions and 424 deletions:

docs/api/api.rst

265

kallithea/controllers/api/api.py

159

0 comments (0 inline, 0 general)

docs/api/api.rst

➞

Show inline comments

@@ @@ -112,13 +112,13 @@ INPUT:: @@
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : "Pulled from `<reponame>`"
-    error :  null
     error : null
 rescan_repos
 ^^^^^^^^^^^^
 Rescan repositories. If ``remove_obsolete`` is set,
 Kallithea will delete repos that are in the database but not in the filesystem.
@@ @@ -135,13 +135,13 @@ INPUT:: @@
 OUTPUT::
     id : <id_given_in_input>
     result : "{'added': [<list of names of added repos>],
                'removed': [<list of names of removed repos>]}"
-    error :  null
     error : null
 invalidate_cache
 ^^^^^^^^^^^^^^^^
 Invalidate the cache for a repository.
 This command can only be executed using the api_key of a user with admin rights,
@@ @@ -157,13 +157,13 @@ INPUT:: @@
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : "Caches of repository `<reponame>`"
-    error :  null
     error : null
 get_ip
 ^^^^^^
 Return IP address as seen from Kallithea server, together with all
 defined IP addresses for given user.
@@ @@ -179,22 +179,22 @@ INPUT:: @@
+              }
 OUTPUT::
     id : <id_given_in_input>
     result : {
                  "ip_addr_server": <ip_from_client>",
                  "user_ips": [
                  "ip_addr_server" : <ip_from_client>",
                  "user_ips" : [
+                                {
                                    "ip_addr": "<ip_with_mask>",
                                    "ip_range": ["<start_ip>", "<end_ip>"],
                                    "ip_addr" : "<ip_with_mask>",
                                    "ip_range" : ["<start_ip>", "<end_ip>"],
                                 },
                                 ...
+                             ]
+                              ]
+             }
-    error :  null
     error : null
 get_user
 ^^^^^^^^
 Get a user by username or userid. The result is empty if user can't be found.
 If userid param is skipped, it is set to id of user who is calling this method.
@@ @@ -210,35 +210,35 @@ INPUT:: @@
                 "userid" : "<username or user_id Optional(=apiuser)>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: None if user does not exist or
+            {
     result : None if user does not exist or
+             {
                 "user_id" :     "<user_id>",
                 "api_key" :     "<api_key>",
                 "username" :    "<username>",
-                "firstname":    "<firstname>",
+                "firstname" :   "<firstname>",
                 "lastname" :    "<lastname>",
                 "email" :       "<email>",
-                "emails":       "<list_of_all_additional_emails>",
+                "emails" :      "<list_of_all_additional_emails>",
                 "ip_addresses": "<list_of_ip_addresses_for_user>",
                 "active" :      "<bool>",
                 "admin" :       "<bool>",
                 "ldap_dn" :     "<ldap_dn>",
-                "last_login":   "<last_login>",
+                "last_login" :  "<last_login>",
                 "permissions": {
                     "global": ["hg.create.repository",
                                "repository.read",
                                "hg.register.manual_activate"],
                     "repositories": {"repo1": "repository.none"},
                     "repositories_groups": {"Group1": "group.read"}
                     "repositories" : {"repo1" : "repository.none"},
                     "repositories_groups" : {"Group1" : "group.read"}
                  },
+            }
     error:  null
+             }
     error : null
 get_users
 ^^^^^^^^^
 List all existing users.
 This command can only be executed using the api_key of a user with admin rights.
@@ @@ -250,30 +250,30 @@ INPUT:: @@
     method :  "get_users"
     args :    { }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+    result : [
+              {
                 "user_id" :     "<user_id>",
                 "api_key" :     "<api_key>",
                 "username" :    "<username>",
-                "firstname":    "<firstname>",
+                "firstname" :   "<firstname>",
                 "lastname" :    "<lastname>",
                 "email" :       "<email>",
-                "emails":       "<list_of_all_additional_emails>",
+                "emails" :      "<list_of_all_additional_emails>",
                 "ip_addresses": "<list_of_ip_addresses_for_user>",
                 "active" :      "<bool>",
                 "admin" :       "<bool>",
                 "ldap_dn" :     "<ldap_dn>",
-                "last_login":   "<last_login>",
+                "last_login" :  "<last_login>",
               },
               …
+            ]
     error:  null
+             ]
     error : null
 .. _create-user:
 create_user
 ^^^^^^^^^^^
@@ @@ -296,28 +296,28 @@ INPUT:: @@
                 "ldap_dn" :   "<ldap_dn> = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "created new user `<username>`",
               "user": {
+              "user" : {
                 "user_id" :  "<user_id>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
-                "emails":    "<list_of_all_additional_emails>",
+                "emails" :   "<list_of_all_additional_emails>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>",
                 "last_login": "<last_login>",
               },
+            }
     error:  null
+             }
     error : null
 Example::
     kallithea-api create_user username:bent email:bent@example.com firstname:Bent lastname:Bentsen extern_type:ldap extern_name:uid=bent,dc=example,dc=com
 update_user
@@ @@ -343,29 +343,29 @@ INPUT:: @@
                 "ldap_dn" :   "<ldap_dn> = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "updated user ID:<userid> <username>",
               "user": {
+              "user" : {
                 "user_id" :  "<user_id>",
                 "api_key" :  "<api_key>",
                 "username" : "<username>",
                 "firstname": "<firstname>",
                 "lastname" : "<lastname>",
                 "email" :    "<email>",
-                "emails":    "<list_of_all_additional_emails>",
+                "emails" :   "<list_of_all_additional_emails>",
                 "active" :   "<bool>",
                 "admin" :    "<bool>",
                 "ldap_dn" :  "<ldap_dn>",
                 "last_login": "<last_login>",
               },
+            }
     error:  null
+             }
     error : null
 delete_user
 ^^^^^^^^^^^
 Delete the given user if such a user exists.
 This command can only be executed using the api_key of a user with admin rights.
@@ @@ -379,17 +379,17 @@ INPUT:: @@
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "deleted user ID:<userid> <username>",
               "user": null
+            }
     error:  null
               "user" : null
+             }
     error : null
 get_user_group
 ^^^^^^^^^^^^^^
 Get an existing user group.
 This command can only be executed using the api_key of a user with admin rights.
@@ @@ -407,22 +407,22 @@ OUTPUT:: @@
     id : <id_given_in_input>
     result : None if group not exist
+             {
                "users_group_id" : "<id>",
                "group_name" :     "<groupname>",
-               "active":          "<bool>",
+               "active" :         "<bool>",
                "members" :  [
+                              {
                                 "user_id" :  "<user_id>",
                                 "api_key" :  "<api_key>",
                                 "username" : "<username>",
                                 "firstname": "<firstname>",
                                 "lastname" : "<lastname>",
                                 "email" :    "<email>",
-                                "emails":    "<list_of_all_additional_emails>",
+                                "emails" :   "<list_of_all_additional_emails>",
                                 "active" :   "<bool>",
                                 "admin" :    "<bool>",
                                 "ldap_dn" :  "<ldap_dn>",
                                 "last_login": "<last_login>",
                               },
                               …
@@ @@ -447,13 +447,13 @@ OUTPUT:: @@
     id : <id_given_in_input>
     result : [
+               {
                "users_group_id" : "<id>",
                "group_name" :     "<groupname>",
-               "active":          "<bool>",
+               "active" :         "<bool>",
                },
                …
+              ]
     error : null
 create_user_group
@@ @@ -464,30 +464,30 @@ This command can only be executed using @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "create_user_group"
-    args:     {
+    args :    {
                 "group_name": "<groupname>",
                 "owner" :     "<owner_name_or_id = Optional(=apiuser)>",
-                "active":     "<bool> = Optional(True)"
+                "active" :    "<bool> = Optional(True)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "created new user group `<groupname>`",
               "users_group": {
     result : {
               "msg" : "created new user group `<groupname>`",
               "users_group" : {
                      "users_group_id" : "<id>",
                      "group_name" :     "<groupname>",
-                     "active":          "<bool>",
+                     "active" :         "<bool>",
                },
+            }
     error:  null
+             }
     error : null
 add_user_to_user_group
 ^^^^^^^^^^^^^^^^^^^^^^
 Adds a user to a user group. If the user already is in that group, success will be
 ``false``.
@@ @@ -495,26 +495,26 @@ This command can only be executed using @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "add_user_user_group"
-    args:     {
+    args :    {
                 "usersgroupid" : "<user group id or name>",
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "success": True|False # depends on if member is in group
               "msg": "added member `<username>` to a user group `<groupname>` |
                       User is already in that group"
+            }
     error:  null
     result : {
               "success" : True|False # depends on if member is in group
               "msg" : "added member `<username>` to a user group `<groupname>` |
                        User is already in that group"
+             }
     error : null
 remove_user_from_user_group
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Remove a user from a user group. If the user isn't in the given group, success will
 be ``false``.
@@ @@ -522,26 +522,26 @@ This command can only be executed using @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "remove_user_from_user_group"
-    args:     {
+    args :    {
                 "usersgroupid" : "<user group id or name>",
                 "userid" : "<user_id or username>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "success":  True|False,  # depends on if member is in group
               "msg": "removed member <username> from user group <groupname> |
                       User wasn't in group"
+            }
     error:  null
     result : {
               "success" : True|False,  # depends on if member is in group
               "msg" : "removed member <username> from user group <groupname> |
                        User wasn't in group"
+             }
     error : null
 get_repo
 ^^^^^^^^
 Get an existing repository by its name or repository_id. Members will contain
 either users_group or users associated to that repository.
@@ @@ -550,150 +550,150 @@ or that of a regular user with at least @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repo"
-    args:     {
+    args :    {
                 "repoid" : "<reponame or repo_id>",
                 "with_revision_names": "<bool> = Optional(False)",
                 "with_pullrequests": "<bool> = Optional(False)",
                 "with_revision_names" : "<bool> = Optional(False)",
                 "with_pullrequests" : "<bool> = Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: None if repository does not exist or
+            {
     result : None if repository does not exist or
+             {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
-                "enable_downloads":  "<bool>",
+                "enable_downloads" : "<bool>",
                 "enable_statistics": "<bool>",
-                "private":           "<bool>",
+                "private" :          "<bool>",
                 "created_on" :       "<date_time_created>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "last_changeset":    {
                                          "author":   "<full_author>",
                                          "date":     "<date_time_of_commit>",
                                          "message":  "<commit_message>",
                                          "raw_id":   "<raw_id>",
                 "landing_rev" :      "<landing_rev>",
                 "last_changeset" :   {
                                          "author" :  "<full_author>",
                                          "date" :    "<date_time_of_commit>",
                                          "message" : "<commit_message>",
                                          "raw_id" :  "<raw_id>",
                                          "revision": "<numeric_revision>",
                                          "short_id": "<short_id>"
                                      },
                 "owner":             "<repo_owner>",
                 "fork_of":           "<name_of_fork_parent>",
                 "owner" :            "<repo_owner>",
                 "fork_of" :          "<name_of_fork_parent>",
                 "members" :   [
+                                  {
-                                    "type":        "user",
+                                    "type" :       "user",
                                     "user_id" :    "<user_id>",
                                     "api_key" :    "<api_key>",
                                     "username" :   "<username>",
-                                    "firstname":   "<firstname>",
+                                    "firstname" :  "<firstname>",
                                     "lastname" :   "<lastname>",
                                     "email" :      "<email>",
-                                    "emails":      "<list_of_all_additional_emails>",
+                                    "emails" :     "<list_of_all_additional_emails>",
                                     "active" :     "<bool>",
                                     "admin" :      "<bool>",
                                     "ldap_dn" :    "<ldap_dn>",
-                                    "last_login":  "<last_login>",
+                                    "last_login" : "<last_login>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …
+                                  {
-                                    "type":      "users_group",
+                                    "type" :     "users_group",
                                     "id" :       "<usersgroupid>",
                                     "name" :     "<usersgroupname>",
-                                    "active":    "<bool>",
+                                    "active" :   "<bool>",
                                     "permission" : "repository.(read|write|admin)"
                                   },
                                   …
                               ],
-                "followers":  [
+                "followers" : [
+                                  {
                                     "user_id" :     "<user_id>",
                                     "username" :    "<username>",
                                     "api_key" :     "<api_key>",
-                                    "firstname":    "<firstname>",
+                                    "firstname" :   "<firstname>",
                                     "lastname" :    "<lastname>",
                                     "email" :       "<email>",
-                                    "emails":       "<list_of_all_additional_emails>",
+                                    "emails" :      "<list_of_all_additional_emails>",
                                     "ip_addresses": "<list_of_ip_addresses_for_user>",
                                     "active" :      "<bool>",
                                     "admin" :       "<bool>",
                                     "ldap_dn" :     "<ldap_dn>",
-                                    "last_login":   "<last_login>",
+                                    "last_login" :  "<last_login>",
                                   },
                                   …
                               ],
                 <if with_revision_names == True>
                 "tags": {
                             "<tagname>": "<raw_id>",
                 "tags" : {
                             "<tagname>" : "<raw_id>",
                             ...
                         },
                 "branches": {
                             "<branchname>": "<raw_id>",
                 "branches" : {
                             "<branchname>" : "<raw_id>",
                             ...
                         },
                 "bookmarks": {
                             "<bookmarkname>": "<raw_id>",
                 "bookmarks" : {
                             "<bookmarkname>" : "<raw_id>",
                             ...
                         },
                 <if with_pullrequests == True>
                 "pull_requests": [
+                "pull_requests" : [
+                  {
                     "status": "<pull_request_status>",
                     "pull_request_id": <pull_request_id>,
                     "description": "<pull_request_description>",
                     "title": "<pull_request_title>",
                     "url": "<pull_request_url>",
                     "reviewers": [
                     "status" : "<pull_request_status>",
                     "pull_request_id" : <pull_request_id>,
                     "description" : "<pull_request_description>",
                     "title" : "<pull_request_title>",
                     "url" : "<pull_request_url>",
                     "reviewers" : [
+                      {
                         "username": "<user_id>",
+                        "username" : "<user_id>",
                       },
                       ...
                     ],
                     "org_repo_url": "<repo_url>",
                     "org_ref_parts": [
                     "org_repo_url" : "<repo_url>",
                     "org_ref_parts" : [
                       "<ref_type>",
                       "<ref_name>",
                       "<raw_id>"
                     ],
                     "other_ref_parts": [
+                    "other_ref_parts" : [
                       "<ref_type>",
                       "<ref_name>",
                       "<raw_id>"
                     ],
                     "comments": [
+                    "comments" : [
+                      {
                         "username": "<user_id>",
                         "text": "<comment text>",
                         "comment_id": "<comment_id>",
                         "username" : "<user_id>",
                         "text" : "<comment text>",
                         "comment_id" : "<comment_id>",
                       },
                       ...
                     ],
                     "owner": "<username>",
                     "statuses": [
                     "owner" : "<username>",
                     "statuses" : [
+                      {
                         "status": "<status_of_review>",        # "under_review", "approved" or "rejected"
                         "reviewer": "<user_id>",
                         "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone
                         "status" : "<status_of_review>",        # "under_review", "approved" or "rejected"
                         "reviewer" : "<user_id>",
                         "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone
                       },
                       ...
                     ],
                     "revisions": [
+                    "revisions" : [
                       "<raw_id>",
                       ...
+                    ]
                   },
                   ...
+                ]
+            }
     error:  null
+             }
     error : null
 get_repos
 ^^^^^^^^^
 List all existing repositories.
 This command can only be executed using the api_key of a user with admin rights,
@@ @@ -701,35 +701,35 @@ or that of a regular user with at least @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repos"
-    args:     { }
+    args :    { }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+    result : [
+              {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
                 "private" :          "<bool>",
                 "created_on" :       "<datetimecreated>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "owner":             "<repo_owner>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
                 "landing_rev" :      "<landing_rev>",
                 "owner" :            "<repo_owner>",
                 "fork_of" :          "<name_of_fork_parent>",
                 "enable_downloads" : "<bool>",
                 "enable_statistics": "<bool>",
               },
               …
+            ]
     error:  null
+             ]
     error : null
 get_repo_nodes
 ^^^^^^^^^^^^^^
 Return a list of files and directories for a given path at the given revision.
 It is possible to specify ret_type to show only ``files`` or ``dirs``.
@@ @@ -737,30 +737,30 @@ This command can only be executed using @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "get_repo_nodes"
-    args:     {
+    args :    {
                 "repoid" : "<reponame or repo_id>"
-                "revision"  : "<revision>",
+                "revision" :  "<revision>",
                 "root_path" : "<root_path>",
-                "ret_type"  : "<ret_type> = Optional('all')"
+                "ret_type" :  "<ret_type> = Optional('all')"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+    result : [
+              {
                 "name" :        "<name>"
                 "type" :        "<type>",
               },
               …
+            ]
     error:  null
+             ]
     error : null
 create_repo
 ^^^^^^^^^^^
 Create a repository. If the repository name contains "/", the repository will be
 created in the repository group indicated by that path. Any such repository
@@ @@ -774,45 +774,45 @@ Regular users cannot specify owner param @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "create_repo"
-    args:     {
+    args :    {
                 "repo_name" :        "<reponame>",
                 "owner" :            "<owner_name_or_id = Optional(=apiuser)>",
                 "repo_type" :        "<repo_type> = Optional('hg')",
                 "description" :      "<description> = Optional('')",
                 "private" :          "<bool> = Optional(False)",
                 "clone_uri" :        "<clone_uri> = Optional(None)",
                 "landing_rev" :      "<landing_rev> = Optional('tip')",
-                "enable_downloads":  "<bool> = Optional(False)",
+                "enable_downloads" : "<bool> = Optional(False)",
                 "enable_statistics": "<bool> = Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "Created new repository `<reponame>`",
               "repo": {
     result : {
               "msg" : "Created new repository `<reponame>`",
               "repo" : {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
                 "private" :          "<bool>",
                 "created_on" :       "<datetimecreated>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "owner":             "<username or user_id>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
                 "landing_rev" :      "<landing_rev>",
                 "owner" :            "<username or user_id>",
                 "fork_of" :          "<name_of_fork_parent>",
                 "enable_downloads" : "<bool>",
                 "enable_statistics": "<bool>",
               },
+            }
     error:  null
+             }
     error : null
 update_repo
 ^^^^^^^^^^^
 Update a repository.
 This command can only be executed using the api_key of a user with admin rights,
@@ @@ -821,54 +821,54 @@ Regular users cannot specify owner param @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "update_repo"
-    args:     {
+    args :    {
                 "repoid" :           "<reponame or repo_id>"
                 "name" :             "<reponame> = Optional('')",
                 "group" :            "<group_id> = Optional(None)",
                 "owner" :            "<owner_name_or_id = Optional(=apiuser)>",
                 "description" :      "<description> = Optional('')",
                 "private" :          "<bool> = Optional(False)",
                 "clone_uri" :        "<clone_uri> = Optional(None)",
                 "landing_rev" :      "<landing_rev> = Optional('tip')",
-                "enable_downloads":  "<bool> = Optional(False)",
+                "enable_downloads" : "<bool> = Optional(False)",
                 "enable_statistics": "<bool> = Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "updated repo ID:repo_id `<reponame>`",
               "repository": {
     result : {
               "msg" : "updated repo ID:repo_id `<reponame>`",
               "repository" : {
                 "repo_id" :          "<repo_id>",
                 "repo_name" :        "<reponame>"
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
-                "private":           "<bool>",
+                "private" :          "<bool>",
                 "created_on" :       "<datetimecreated>",
                 "description" :      "<description>",
                 "landing_rev":       "<landing_rev>",
                 "owner":             "<username or user_id>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
                 "landing_rev" :      "<landing_rev>",
                 "owner" :            "<username or user_id>",
                 "fork_of" :          "<name_of_fork_parent>",
                 "enable_downloads" : "<bool>",
                 "enable_statistics": "<bool>",
                 "last_changeset":    {
                                        "author":   "<full_author>",
                                        "date":     "<date_time_of_commit>",
                                        "message":  "<commit_message>",
                                        "raw_id":   "<raw_id>",
                 "last_changeset" :   {
                                        "author" :  "<full_author>",
                                        "date" :    "<date_time_of_commit>",
                                        "message" : "<commit_message>",
                                        "raw_id" :  "<raw_id>",
                                        "revision": "<numeric_revision>",
                                        "short_id": "<short_id>"
+                                     }
               },
+            }
     error:  null
+             }
     error : null
 fork_repo
 ^^^^^^^^^
 Create a fork of the given repo. If using Celery, this will
 return success message immediately and a fork will be created
@@ @@ -880,30 +880,30 @@ Regular users cannot specify owner param @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "fork_repo"
-    args:     {
+    args :    {
                 "repoid" :          "<reponame or repo_id>",
                 "fork_name":        "<forkname>",
                 "owner":            "<username or user_id = Optional(=apiuser)>",
                 "description":      "<description>",
                 "fork_name" :       "<forkname>",
                 "owner" :           "<username or user_id = Optional(=apiuser)>",
                 "description" :     "<description>",
                 "copy_permissions": "<bool>",
                 "private":          "<bool>",
                 "landing_rev":      "<landing_rev>"
                 "private" :         "<bool>",
                 "landing_rev" :     "<landing_rev>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "Created fork of `<reponame>` as `<forkname>`",
               "success": true
+            }
     error:  null
     result : {
               "msg" : "Created fork of `<reponame>` as `<forkname>`",
               "success" : true
+             }
     error : null
 delete_repo
 ^^^^^^^^^^^
 Delete a repository.
 This command can only be executed using the api_key of a user with admin rights,
@@ @@ -912,76 +912,76 @@ When ``forks`` param is set it is possib @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "delete_repo"
-    args:     {
+    args :    {
                 "repoid" : "<reponame or repo_id>",
-                "forks"  : "`delete` or `detach` = Optional(None)"
+                "forks" :  "`delete` or `detach` = Optional(None)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "msg": "Deleted repository `<reponame>`",
               "success": true
+            }
     error:  null
     result : {
               "msg" : "Deleted repository `<reponame>`",
               "success" : true
+             }
     error : null
 grant_user_permission
 ^^^^^^^^^^^^^^^^^^^^^
 Grant permission for a user on the given repository, or update the existing one if found.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "grant_user_permission"
-    args:     {
+    args :    {
                 "repoid" : "<reponame or repo_id>"
                 "userid" : "<username or user_id>"
                 "perm" :       "(repository.(none|read|write|admin))",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
               "success" : true
+             }
     error : null
 revoke_user_permission
 ^^^^^^^^^^^^^^^^^^^^^^
 Revoke permission for a user on the given repository.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "revoke_user_permission"
     args:     {
     method :  "revoke_user_permission"
     args :    {
                 "repoid" : "<reponame or repo_id>"
                 "userid" : "<username or user_id>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
               "success" : true
+             }
     error : null
 grant_user_group_permission
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Grant permission for a user group on the given repository, or update the
 existing one if found.
@@ @@ -989,131 +989,131 @@ This command can only be executed using @@
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method :  "grant_user_group_permission"
-    args:     {
+    args :    {
                 "repoid" : "<reponame or repo_id>"
                 "usersgroupid" : "<user group id or name>"
                 "perm" : "(repository.(none|read|write|admin))",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
               "success" : true
+             }
     error : null
 revoke_user_group_permission
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Revoke permission for a user group on the given repository.
 This command can only be executed using the api_key of a user with admin rights.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "revoke_user_group_permission"
     args:     {
     method :  "revoke_user_group_permission"
     args :    {
                 "repoid" : "<reponame or repo_id>"
                 "usersgroupid" : "<user group id or name>"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
+    result : {
               "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`",
               "success": true
+            }
     error:  null
               "success" : true
+             }
     error : null
 get_changesets
 ^^^^^^^^^^^^^^
 Get changesets of a given repository. This command can only be executed using the api_key
 of a user with read permissions to the repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "get_changesets"
     args:     {
     method :  "get_changesets"
     args :    {
                 "repoid" : "<reponame or repo_id>",
                 "start": "<revision number> = Optional(None)",
                 "end": "<revision number> = Optional(None)",
                 "start_date": "<date> = Optional(None)",    # in "%Y-%m-%dT%H:%M:%S" format
                 "end_date": "<date> = Optional(None)",      # in "%Y-%m-%dT%H:%M:%S" format
                 "branch_name": "<branch name filter> = Optional(None)",
                 "reverse": "<bool> = Optional(False)",
                 "with_file_list": "<bool> = Optional(False)"
                 "start" : "<revision number> = Optional(None)",
                 "end" : "<revision number> = Optional(None)",
                 "start_date" : "<date> = Optional(None)",    # in "%Y-%m-%dT%H:%M:%S" format
                 "end_date" : "<date> = Optional(None)",      # in "%Y-%m-%dT%H:%M:%S" format
                 "branch_name" : "<branch name filter> = Optional(None)",
                 "reverse" : "<bool> = Optional(False)",
                 "with_file_list" : "<bool> = Optional(False)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: [
+    result : [
+    {
       "raw_id": "<raw_id>",
       "short_id": "<short_id>",
       "author": "<full_author>",
       "date": "<date_time_of_commit>",
       "message": "<commit_message>",
       "revision": "<numeric_revision>",
       "raw_id" : "<raw_id>",
       "short_id" : "<short_id>",
       "author" : "<full_author>",
       "date" : "<date_time_of_commit>",
       "message" : "<commit_message>",
       "revision" : "<numeric_revision>",
       <if with_file_list == True>
       "added": [<list of added files>],
       "changed": [<list of changed files>],
       "removed": [<list of removed files>]
       "added" : [<list of added files>],
       "changed" : [<list of changed files>],
       "removed" : [<list of removed files>]
     },
     ...
+    ]
-    error:  null
+    error : null
 get_changeset
 ^^^^^^^^^^^^^
 Get information and review status for a given changeset. This command can only
 be executed using the api_key of a user with read permissions to the
 repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "get_changeset"
     args:     {
     method :  "get_changeset"
     args :    {
                 "repoid" : "<reponame or repo_id>",
                 "raw_id" : "<raw_id>",
                 "with_reviews": "<bool> = Optional(False)"
+                "with_reviews" : "<bool> = Optional(False)"
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
               "author":   "<full_author>",
               "date":     "<date_time_of_commit>",
               "message":  "<commit_message>",
               "raw_id":   "<raw_id>",
     result : {
               "author" :  "<full_author>",
               "date" :    "<date_time_of_commit>",
               "message" : "<commit_message>",
               "raw_id" :  "<raw_id>",
               "revision": "<numeric_revision>",
               "short_id": "<short_id>",
               "reviews": [{
                     "reviewer":   "<username>",
                     "modified_at": "<date_time_of_review>",  # iso 8601 date, server's timezone
                     "status":   "<status_of_review>",        # "under_review", "approved" or "rejected"
               "reviews" : [{
                     "reviewer" :  "<username>",
                     "modified_at" : "<date_time_of_review>",  # iso 8601 date, server's timezone
                     "status" :  "<status_of_review>",        # "under_review", "approved" or "rejected"
                  },
                  ...
+              ]
+            }
     error:  null
+             }
     error : null
 Example output::
+    {
       "id" : 1,
       "error" : null,
@@ @@ -1150,90 +1150,90 @@ Get information and review status for a @@
 using the api_key of a user with read permissions to the original repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "get_pullrequest"
     args:     {
     method :  "get_pullrequest"
     args :    {
                 "pullrequest_id" : "<pullrequest_id>",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: {
         "status": "<pull_request_status>",
         "pull_request_id": <pull_request_id>,
         "description": "<pull_request_description>",
         "title": "<pull_request_title>",
         "url": "<pull_request_url>",
         "reviewers": [
     result : {
         "status" : "<pull_request_status>",
         "pull_request_id" : <pull_request_id>,
         "description" : "<pull_request_description>",
         "title" : "<pull_request_title>",
         "url" : "<pull_request_url>",
         "reviewers" : [
+          {
             "username": "<user_name>",
+            "username" : "<user_name>",
           },
           ...
         ],
         "org_repo_url": "<repo_url>",
         "org_ref_parts": [
         "org_repo_url" : "<repo_url>",
         "org_ref_parts" : [
           "<ref_type>",
           "<ref_name>",
           "<raw_id>"
         ],
         "other_ref_parts": [
+        "other_ref_parts" : [
           "<ref_type>",
           "<ref_name>",
           "<raw_id>"
         ],
         "comments": [
+        "comments" : [
+          {
             "username": "<user_name>",
             "text": "<comment text>",
             "comment_id": "<comment_id>",
             "username" : "<user_name>",
             "text" : "<comment text>",
             "comment_id" : "<comment_id>",
           },
           ...
         ],
         "owner": "<username>",
         "statuses": [
         "owner" : "<username>",
         "statuses" : [
+          {
             "status": "<status_of_review>",        # "under_review", "approved" or "rejected"
             "reviewer": "<user_name>",
             "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone
             "status" : "<status_of_review>",        # "under_review", "approved" or "rejected"
             "reviewer" : "<user_name>",
             "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone
           },
           ...
         ],
         "revisions": [
+        "revisions" : [
           "<raw_id>",
           ...
+        ]
     },
-    error:  null
+    error : null
 comment_pullrequest
 ^^^^^^^^^^^^^^^^^^^
 Add comment, change status or close a given pull request. This command can only be executed
 using the api_key of a user with read permissions to the original repository.
 INPUT::
     id : <id_for_response>
     api_key : "<api_key>"
     method  : "comment_pullrequest"
     args:     {
                 "pull_request_id":  "<pull_request_id>",
                 "comment_msg":      Optional(''),
                 "status":           Optional(None),     # "under_review", "approved" or "rejected"
                 "close_pr":         Optional(False)",
     method :  "comment_pullrequest"
     args :    {
                 "pull_request_id" : "<pull_request_id>",
                 "comment_msg" :     Optional(''),
                 "status" :          Optional(None),     # "under_review", "approved" or "rejected"
                 "close_pr" :        Optional(False)",
+              }
 OUTPUT::
     id : <id_given_in_input>
     result: True
     error:  null
     result : True
     error : null
 API access for web views
 ------------------------
 Kallithea HTTP entry points can also be accessed without login using bearer

kallithea/controllers/api/api.py

➞

Show inline comments

@@ @@ -171,16 +171,16 @@ class ApiController(JSONRPCController): @@
         :type clone_uri: str
         OUTPUT::
             id : <id_given_in_input>
             result : {
                 "msg": "Pulled from `<repository name>`"
                 "repository": "<repository name>"
                 "msg" : "Pulled from `<repository name>`"
                 "repository" : "<repository name>"
+            }
-            error :  null
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -220,13 +220,13 @@ class ApiController(JSONRPCController): @@
             id : <id_given_in_input>
             result : {
                 'added': [<added repository name>,...]
                 'removed': [<removed repository name>,...]
+            }
-            error :  null
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -257,13 +257,13 @@ class ApiController(JSONRPCController): @@
             id : <id_given_in_input>
             result : {
                 'msg': Cache for repository `<repository name>` was invalidated,
                 'repository': <repository name>
+            }
-            error :  null
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -300,20 +300,20 @@ class ApiController(JSONRPCController): @@
         :type userid: Optional(str or int)
         OUTPUT::
             id : <id_given_in_input>
             result : {
                          "server_ip_addr": "<ip_from_client>",
                          "user_ips": [
                          "server_ip_addr" : "<ip_from_client>",
                          "user_ips" : [
+                                        {
                                            "ip_addr": "<ip_with_mask>",
                                            "ip_range": ["<start_ip>", "<end_ip>"],
                                            "ip_addr" : "<ip_with_mask>",
                                            "ip_range" : ["<start_ip>", "<end_ip>"],
                                         },
                                         ...
+                                     ]
+                                      ]
+            }
             error : null
         """
         if userid is None:
             userid = request.authuser.user_id
         user = get_user_or_error(userid)
@@ @@ -332,18 +332,18 @@ class ApiController(JSONRPCController): @@
         return server info, including Kallithea version and installed packages
         OUTPUT::
             id : <id_given_in_input>
             result : {
                 'modules': [ [<module name>, <module version>], ...]
                 'py_version': <python version>,
                 'platform': <platform type>,
                 'kallithea_version': <kallithea version>,
                 'git_version': '<git version>',
                 'git_path': '<git path>'
                 'modules' : [ [<module name>, <module version>], ...]
                 'py_version' : <python version>,
                 'platform' : <platform type>,
                 '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):
@@ @@ -357,32 +357,32 @@ class ApiController(JSONRPCController): @@
         :param userid: user to get data for
         :type userid: Optional(str or int)
         OUTPUT::
             id : <id_given_in_input>
             result: None if user does not exist or
+                    {
             result : None if user does not exist or
+                     {
                         "user_id" :     "<user_id>",
                         "username" :    "<username>",
-                        "firstname":    "<firstname>",
+                        "firstname" :   "<firstname>",
                         "lastname" :    "<lastname>",
                         "email" :       "<email>",
-                        "emails":       "[<list of all emails including additional ones>]",
+                        "emails" :      "[<list of all emails including additional ones>]",
                         "active" :      "<bool: user active>",
                         "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"},
                             "user_groups": { "usrgrp1": "usergroup.admin" }
                         "permissions" : {
                             "global" : ["hg.create.repository",
                                         "repository.read",
                                         "hg.register.manual_activate"],
                             "repositories" : {"repo1" : "repository.none"},
                             "repositories_groups" : {"Group1" : "group.read"},
                             "user_groups" : { "usrgrp1" : "usergroup.admin" }
                          },
+                    }
             error:  null
+                     }
             error : null
         """
         if not HasPermissionAny('hg.admin')():
             # make sure normal user does not pass someone else userid,
             # he is not allowed to do that
             if userid is not None and userid != request.authuser.user_id:
                 raise JSONRPCError(
@@ @@ -403,14 +403,14 @@ class ApiController(JSONRPCController): @@
         Lists all existing users. This command can be executed only using api_key
         belonging to user with admin rights.
         OUTPUT::
             id : <id_given_in_input>
             result: [<user_object>, ...]
             error:  null
             result : [<user_object>, ...]
             error : null
         """
         return [
             user.get_api_data()
             for user in db.User.query()
                 .order_by(db.User.username)
                 .filter_by(is_default_user=False)
@@ @@ -445,17 +445,17 @@ class ApiController(JSONRPCController): @@
         :param extern_type: extern_type
         :type extern_type: Optional(str)
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "created new user `<username>`",
                       "user": <user_obj>
+                    }
             error:  null
                       "user" : <user_obj>
+                     }
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -524,17 +524,17 @@ class ApiController(JSONRPCController): @@
         :param extern_type:
         :type extern_type: Optional(str)
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "updated user ID:<userid> <username>",
                       "user": <user_object>,
+                    }
             error:  null
                       "user" : <user_object>,
+                     }
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -580,17 +580,17 @@ class ApiController(JSONRPCController): @@
         :param userid: user to delete
         :type userid: str or int
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "deleted user ID:<userid> <username>",
                       "user": null
+                    }
             error:  null
                       "user" : null
+                     }
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -626,16 +626,16 @@ 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>,...]
                        "group_description" : "<description>"
                        "active" :         "<bool>",
                        "owner" :          "<username>"
                        "members" :        [<user_obj>,...]
+                     }
             error : null
         """
         user_group = get_user_group_or_error(usergroupid)
         if not HasPermissionAny('hg.admin')():
             if not HasUserGroupPermissionLevel('read')(user_group.users_group_name):
@@ @@ -679,17 +679,17 @@ class ApiController(JSONRPCController): @@
         :param active: group is active
         :type active: Optional(bool)
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "msg": "created new user group `<groupname>`",
                       "user_group": <user_group_object>
+                    }
             error:  null
             result : {
                       "msg" : "created new user group `<groupname>`",
                       "user_group" : <user_group_object>
+                     }
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -737,16 +737,16 @@ class ApiController(JSONRPCController): @@
         :type active: Optional(bool)
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg": 'updated user group ID:<user group id> <user group name>',
             "user_group": <user_group_object>
             "msg" : 'updated user group ID:<user group id> <user group name>',
             "user_group" : <user_group_object>
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -789,15 +789,15 @@ class ApiController(JSONRPCController): @@
         :type usergroupid: str or int
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg": "deleted user group ID:<user_group_id> <user_group_name>"
+            "msg" : "deleted user group ID:<user_group_id> <user_group_name>"
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -842,17 +842,17 @@ class ApiController(JSONRPCController): @@
         :type userid: str or int
         OUTPUT::
             id : <id_given_in_input>
             result : {
                 "success": True|False # depends on if member is in group
                 "msg": "added member `<username>` to a user group `<groupname>` |
                         User is already in that group"
                 "success" : True|False # depends on if member is in group
                 "msg" : "added member `<username>` to a user group `<groupname>` |
                          User is already in that group"
+            }
-            error :  null
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -896,18 +896,18 @@ class ApiController(JSONRPCController): @@
         :param usergroupid:
         :param userid:
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "success":  True|False,  # depends on if member is in group
                       "msg": "removed member <username> from user group <groupname> |
                               User wasn't in group"
+                    }
             error:  null
             result : {
                       "success" : True|False,  # depends on if member is in group
                       "msg" : "removed member <username> from user group <groupname> |
                                User wasn't in group"
+                     }
             error : null
         """
         user = get_user_or_error(userid)
         user_group = get_user_group_or_error(usergroupid)
         if not HasPermissionAny('hg.admin')():
             if not HasUserGroupPermissionLevel('admin')(user_group.users_group_name):
                 raise JSONRPCError('user group `%s` does not exist' % (usergroupid,))
@@ @@ -946,58 +946,58 @@ class ApiController(JSONRPCController): @@
             id : <id_given_in_input>
             result : {
                         "repo_id" :          "<repo_id>",
                         "repo_name" :        "<reponame>"
                         "repo_type" :        "<repo_type>",
                         "clone_uri" :        "<clone_uri>",
-                        "enable_downloads":  "<bool>",
+                        "enable_downloads" : "<bool>",
                         "enable_statistics": "<bool>",
-                        "private":           "<bool>",
+                        "private" :          "<bool>",
                         "created_on" :       "<date_time_created>",
                         "description" :      "<description>",
                         "landing_rev":       "<landing_rev>",
                         "last_changeset":    {
                                                  "author":   "<full_author>",
                                                  "date":     "<date_time_of_commit>",
                                                  "message":  "<commit_message>",
                                                  "raw_id":   "<raw_id>",
                         "landing_rev" :      "<landing_rev>",
                         "last_changeset" :   {
                                                  "author" :  "<full_author>",
                                                  "date" :    "<date_time_of_commit>",
                                                  "message" : "<commit_message>",
                                                  "raw_id" :  "<raw_id>",
                                                  "revision": "<numeric_revision>",
                                                  "short_id": "<short_id>"
+                                             }
                         "owner":             "<repo_owner>",
                         "fork_of":           "<name_of_fork_parent>",
                         "owner" :            "<repo_owner>",
                         "fork_of" :          "<name_of_fork_parent>",
                         "members" :     [
+                                            {
-                                                "name":     "<username>",
+                                                "name" :    "<username>",
                                                 "type" :    "user",
                                                 "permission" : "repository.(read|write|admin)"
                                             },
                                             …
+                                            {
-                                                "name":     "<usergroup name>",
+                                                "name" :    "<usergroup name>",
                                                 "type" :    "user_group",
                                                 "permission" : "usergroup.(read|write|admin)"
                                             },
                                             …
+                                        ]
-                        "followers":   [<user_obj>, ...],
+                        "followers" :  [<user_obj>, ...],
                         <if with_revision_names == True>
                         "tags": {
                                     "<tagname>": "<raw_id>",
                         "tags" : {
                                     "<tagname>" : "<raw_id>",
                                     ...
                                 },
                         "branches": {
                                     "<branchname>": "<raw_id>",
                         "branches" : {
                                     "<branchname>" : "<raw_id>",
                                     ...
                                 },
                         "bookmarks": {
                                     "<bookmarkname>": "<raw_id>",
                         "bookmarks" : {
                                     "<bookmarkname>" : "<raw_id>",
                                     ...
                                 },
+                    }
             error :  null
+                     }
             error : null
         """
         repo = get_repo_or_error(repoid)
         if not HasPermissionAny('hg.admin')():
             if not HasRepoPermissionLevel('read')(repo.repo_name):
                 raise JSONRPCError('repository `%s` does not exist' % (repoid,))
@@ @@ -1041,30 +1041,30 @@ class ApiController(JSONRPCController): @@
         api_key belonging to user with admin rights or regular user that have
         admin, write or read access to repository.
         OUTPUT::
             id : <id_given_in_input>
             result: [
+            result : [
+                      {
                         "repo_id" :          "<repo_id>",
                         "repo_name" :        "<reponame>"
                         "repo_type" :        "<repo_type>",
                         "clone_uri" :        "<clone_uri>",
                         "private" :          "<bool>",
                         "created_on" :       "<datetimecreated>",
                         "description" :      "<description>",
                         "landing_rev":       "<landing_rev>",
                         "owner":             "<repo_owner>",
                         "fork_of":           "<name_of_fork_parent>",
                         "enable_downloads":  "<bool>",
                         "landing_rev" :      "<landing_rev>",
                         "owner" :            "<repo_owner>",
                         "fork_of" :          "<name_of_fork_parent>",
                         "enable_downloads" : "<bool>",
                         "enable_statistics": "<bool>",
                       },
                       …
+                    ]
             error:  null
+                     ]
             error : null
         """
         if not HasPermissionAny('hg.admin')():
             repos = request.authuser.get_all_user_repos()
         else:
             repos = db.Repository.query()
@@ @@ -1091,20 +1091,20 @@ class ApiController(JSONRPCController): @@
         :param ret_type: return type 'all|files|dirs' nodes
         :type ret_type: Optional(str)
         OUTPUT::
             id : <id_given_in_input>
             result: [
+            result : [
+                      {
                         "name" :        "<name>"
                         "type" :        "<type>",
                       },
                       …
+                    ]
             error:  null
+                     ]
             error : null
         """
         repo = get_repo_or_error(repoid)
         if not HasPermissionAny('hg.admin')():
             if not HasRepoPermissionLevel('read')(repo.repo_name):
                 raise JSONRPCError('repository `%s` does not exist' % (repoid,))
@@ @@ -1166,17 +1166,17 @@ class ApiController(JSONRPCController): @@
             being created.
         :type copy_permissions: bool
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "msg": "Created new repository `<reponame>`",
                       "success": true
+                    }
             error:  null
             result : {
                       "msg" : "Created new repository `<reponame>`",
                       "success" : true
+                     }
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -1339,30 +1339,30 @@ class ApiController(JSONRPCController): @@
         INPUT::
             id : <id_for_response>
             api_key : "<api_key>"
             method :  "fork_repo"
-            args:     {
+            args :    {
                         "repoid" :          "<reponame or repo_id>",
                         "fork_name":        "<forkname>",
                         "owner":            "<username or user_id = Optional(=apiuser)>",
                         "description":      "<description>",
                         "fork_name" :       "<forkname>",
                         "owner" :           "<username or user_id = Optional(=apiuser)>",
                         "description" :     "<description>",
                         "copy_permissions": "<bool>",
                         "private":          "<bool>",
                         "landing_rev":      "<landing_rev>"
                         "private" :         "<bool>",
                         "landing_rev" :     "<landing_rev>"
+                      }
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "msg": "Created fork of `<reponame>` as `<forkname>`",
                       "success": true
+                    }
             error:  null
             result : {
                       "msg" : "Created fork of `<reponame>` as `<forkname>`",
                       "success" : true
+                     }
             error : null
         """
         repo = get_repo_or_error(repoid)
         repo_name = repo.repo_name
         _repo = RepoModel().get_by_repo_name(fork_name)
         if _repo:
@@ @@ -1439,17 +1439,17 @@ class ApiController(JSONRPCController): @@
         :param forks: `detach` or `delete`, what do do with attached forks for repo
         :type forks: Optional(str)
         OUTPUT::
             id : <id_given_in_input>
             result: {
                       "msg": "Deleted repository `<reponame>`",
                       "success": true
+                    }
             error:  null
             result : {
                       "msg" : "Deleted repository `<reponame>`",
                       "success" : true
+                     }
             error : null
         """
         repo = get_repo_or_error(repoid)
         if not HasPermissionAny('hg.admin')():
             if not HasRepoPermissionLevel('admin')(repo.repo_name):
                 raise JSONRPCError('repository `%s` does not exist' % (repoid,))
@@ @@ -1493,17 +1493,17 @@ class ApiController(JSONRPCController): @@
         :param perm: (repository.(none|read|write|admin))
         :type perm: str
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`",
                       "success": true
+                    }
             error:  null
                       "success" : true
+                     }
             error : null
         """
         repo = get_repo_or_error(repoid)
         user = get_user_or_error(userid)
         perm = get_perm_or_error(perm)
         try:
@@ @@ -1535,17 +1535,17 @@ class ApiController(JSONRPCController): @@
         :type repoid: str or int
         :param userid:
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`",
                       "success": true
+                    }
             error:  null
                       "success" : true
+                     }
             error : null
         """
         repo = get_repo_or_error(repoid)
         user = get_user_or_error(userid)
         try:
             RepoModel().revoke_user_permission(repo=repo, user=user)
             meta.Session().commit()
@@ @@ -1579,15 +1579,15 @@ class ApiController(JSONRPCController): @@
         OUTPUT::
             id : <id_given_in_input>
             result : {
                 "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
                 "success": true
+                "success" : true
+            }
-            error :  null
             error : null
         ERROR OUTPUT::
             id : <id_given_in_input>
             result : null
             error :  {
@@ @@ -1636,17 +1636,17 @@ class ApiController(JSONRPCController): @@
         :type repoid: str or int
         :param usergroupid:
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`",
                       "success": true
+                    }
             error:  null
                       "success" : true
+                     }
             error : null
         """
         repo = get_repo_or_error(repoid)
         user_group = get_user_group_or_error(usergroupid)
         if not HasPermissionAny('hg.admin')():
             if not HasRepoPermissionLevel('admin')(repo.repo_name):
                 raise JSONRPCError('repository `%s` does not exist' % (repoid,))
@@ @@ -1741,16 +1741,16 @@ class ApiController(JSONRPCController): @@
         :type copy_permissions:
         OUTPUT::
           id : <id_given_in_input>
           result : {
               "msg": "created new repo group `<repo_group_name>`"
               "repo_group": <repogroup_object>
               "msg" : "created new repo group `<repo_group_name>`"
               "repo_group" : <repogroup_object>
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -1817,16 +1817,16 @@ class ApiController(JSONRPCController): @@
         :type repogroupid: str or int
         OUTPUT::
           id : <id_given_in_input>
           result : {
             'msg': 'deleted repo group ID:<repogroupid> <repogroupname>
             'repo_group': null
             'msg' : 'deleted repo group ID:<repogroupid> <repogroupname>
             'repo_group' : null
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -1866,17 +1866,17 @@ class ApiController(JSONRPCController): @@
         :param apply_to_children: 'none', 'repos', 'groups', 'all'
         :type apply_to_children: str
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user: `<username>` in repo group: `<repo_group_name>`",
                       "success": true
+                    }
             error:  null
                       "success" : true
+                     }
             error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -1926,17 +1926,17 @@ class ApiController(JSONRPCController): @@
         :param apply_to_children: 'none', 'repos', 'groups', 'all'
         :type apply_to_children: str
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "Revoked perm (recursive:<apply_to_children>) for user: `<username>` in repo group: `<repo_group_name>`",
                       "success": true
+                    }
             error:  null
                       "success" : true
+                     }
             error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -1991,15 +1991,15 @@ class ApiController(JSONRPCController): @@
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`",
             "success": true
+            "success" : true
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -2056,17 +2056,17 @@ class ApiController(JSONRPCController): @@
         :param apply_to_children: 'none', 'repos', 'groups', 'all'
         :type apply_to_children: str
         OUTPUT::
             id : <id_given_in_input>
             result: {
+            result : {
                       "msg" : "Revoked perm (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`",
                       "success": true
+                    }
             error:  null
                       "success" : true
+                     }
             error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -2166,16 +2166,16 @@ class ApiController(JSONRPCController): @@
         :type description: str
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg": "created new gist",
             "gist": <gist_object>
             "msg" : "created new gist",
             "gist" : <gist_object>
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {
@@ @@ -2212,16 +2212,16 @@ class ApiController(JSONRPCController): @@
         :type gistid: str
         OUTPUT::
           id : <id_given_in_input>
           result : {
             "msg": "deleted gist ID: <gist_id>",
             "gist": null
             "msg" : "deleted gist ID: <gist_id>",
             "gist" : null
+          }
-          error :  null
           error : null
         ERROR OUTPUT::
           id : <id_given_in_input>
           result : null
           error :  {

0 comments (0 inline, 0 general)