diff docs/api/api.rst @ 2799:4565e655ea2a beta

API: Added option to rescann repositories via api call
author Marcin Kuzminski <marcin@python-works.com>
date Tue, 07 Aug 2012 02:55:15 +0200
parents d80a68e2ebcc
children
line wrap: on
line diff
--- a/docs/api/api.rst	Tue Aug 07 00:07:10 2012 +0200
+++ b/docs/api/api.rst	Tue Aug 07 02:55:15 2012 +0200
@@ -127,6 +127,31 @@
     error :  null
 
 
+rescan_repos
+------------
+
+Dispatch rescan repositories action. If remove_obsolete is set
+RhodeCode will delete repos that are in database but not in the filesystem.
+This command can be executed only using api_key belonging to user with admin 
+rights.
+
+INPUT::
+
+    id : <id_for_response>
+    api_key : "<api_key>"
+    method :  "rescan_repos"
+    args :    {
+                "remove_obsolete" : "<boolean = Optional(False)>"
+              }
+
+OUTPUT::
+
+    id : <id_given_in_input>
+    result : "{'added': [<list of names of added repos>], 
+               'removed': [<list of names of removed repos>]}"
+    error :  null
+
+
 get_user
 --------