Mercurial > kallithea

diff docs/api/api.rst @ 7672:99edd97366e3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
locking: drop the pull-to-lock / push-to-unlock functionality The feature is not worth the maintenance cost. The locking is too coarse and unflexible with insufficient UI and UX. The implementation is also quite invasive in tricky areas of the code, and thus high maintenance. Dropping this will enable other cleanup ... or at least make it easier.
author Mads Kiilerich <mads@kiilerich.com>
date Wed, 16 Jan 2019 02:32:35 +0100
parents b3289fef0daa
children 0e3e0864f210
line wrap: on
line diff
--- a/docs/api/api.rst	Wed May 22 18:06:55 2019 -0400
+++ b/docs/api/api.rst	Wed Jan 16 02:32:35 2019 +0100
@@ -162,37 +162,6 @@
     result : "Caches of repository `<reponame>`"
     error :  null
 
-lock
-^^^^
-
-Set the locking state on the given repository by the given user.
-If the param ``userid`` is skipped, it is set to the ID of the user who is calling this method.
-If param ``locked`` is skipped, the current lock state of the repository is returned.
-This command can only be executed using the api_key of a user with admin rights, or that of a regular user with admin or write access to the repository.
-
-INPUT::
-
-    id : <id_for_response>
-    api_key : "<api_key>"
-    method :  "lock"
-    args :    {
-                "repoid" : "<reponame or repo_id>"
-                "userid" : "<user_id or username = Optional(=apiuser)>",
-                "locked" : "<bool true|false = Optional(=None)>"
-              }
-
-OUTPUT::
-
-    id : <id_given_in_input>
-    result : {
-                 "repo": "<reponame>",
-                 "locked": "<bool true|false>",
-                 "locked_since": "<float lock_time>",
-                 "locked_by": "<username>",
-                 "msg": "User `<username>` set lock state for repo `<reponame>` to `<false|true>`"
-             }
-    error :  null
-
 get_ip
 ^^^^^^
 
@@ -601,7 +570,6 @@
                 "repo_type" :        "<repo_type>",
                 "clone_uri" :        "<clone_uri>",
                 "enable_downloads":  "<bool>",
-                "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
                 "private":           "<bool>",
                 "created_on" :       "<date_time_created>",
@@ -755,7 +723,6 @@
                 "owner":             "<repo_owner>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
-                "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
               },
               …
@@ -820,7 +787,6 @@
                 "clone_uri" :        "<clone_uri> = Optional(None)",
                 "landing_rev" :      "<landing_rev> = Optional('tip')",
                 "enable_downloads":  "<bool> = Optional(False)",
-                "enable_locking":    "<bool> = Optional(False)",
                 "enable_statistics": "<bool> = Optional(False)",
               }
 
@@ -841,7 +807,6 @@
                 "owner":             "<username or user_id>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
-                "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
               },
             }
@@ -870,7 +835,6 @@
                 "clone_uri" :        "<clone_uri> = Optional(None)",
                 "landing_rev" :      "<landing_rev> = Optional('tip')",
                 "enable_downloads":  "<bool> = Optional(False)",
-                "enable_locking":    "<bool> = Optional(False)",
                 "enable_statistics": "<bool> = Optional(False)",
               }
 
@@ -891,7 +855,6 @@
                 "owner":             "<username or user_id>",
                 "fork_of":           "<name_of_fork_parent>",
                 "enable_downloads":  "<bool>",
-                "enable_locking":    "<bool>",
                 "enable_statistics": "<bool>",
                 "last_changeset":    {
                                        "author":   "<full_author>",
@@ -901,8 +864,6 @@
                                        "revision": "<numeric_revision>",
                                        "short_id": "<short_id>"
                                      }
-                "locked_by": "<username>",
-                "locked_date": "<float lock_time>",
               },
             }
     error:  null