diff docs/api/api.rst @ 2091:7dfcdf4c7dd2 beta

implements #361 API method for deleting repositories
author Marcin Kuzminski <marcin@python-works.com>
date Sun, 19 Feb 2012 20:12:01 +0200
parents bdc0ad168006
children 34d009e5147a
line wrap: on
line diff
--- a/docs/api/api.rst	Sun Feb 19 20:00:18 2012 +0200
+++ b/docs/api/api.rst	Sun Feb 19 20:12:01 2012 +0200
@@ -503,6 +503,29 @@
     error:  null
 
 
+delete_repo
+-----------
+
+Deletes a repository. This command can be executed only using api_key
+belonging to user with admin rights.
+
+
+INPUT::
+
+    api_key : "<api_key>"
+    method :  "delete_repo"
+    args:     {
+                "repo_name" :   "<reponame>",
+              }
+
+OUTPUT::
+
+    result: {
+              "msg": "Deleted repository <reponame>",
+            }
+    error:  null
+
+
 grant_user_permission
 ---------------------