aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMarcin Kuzminski <marcin@python-works.com>2013-03-31 16:18:09 +0200
committerMarcin Kuzminski <marcin@python-works.com>2013-03-31 16:18:09 +0200
commitb2d6e3bf2321f4b3e4791bbbcc0cfcfdaa9318c3 (patch)
treee9c002b03af6ef9a500f87fd7709286a4a5989cc /docs
parent9df1392b28e519ff2b010abff2a8e355d73f4924 (diff)
recursive forks detach
- added API attrs for option to delete or detach forks - deleting repos with attached forks raises an special Exception --HG-- branch : beta
Diffstat (limited to 'docs')
-rw-r--r--docs/api/api.rst9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/api/api.rst b/docs/api/api.rst
index d2a83a6e..4d3723d0 100644
--- a/docs/api/api.rst
+++ b/docs/api/api.rst
@@ -848,8 +848,10 @@ OUTPUT::
delete_repo
-----------
-Deletes a repository. This command can be executed only using api_key belonging to user with admin
-rights or regular user that have admin access to repository.
+Deletes a repository. This command can be executed only using api_key belonging
+to user with admin rights or regular user that have admin access to repository.
+When `forks` param is set it's possible to detach or delete forks of deleting
+repository
INPUT::
@@ -858,7 +860,8 @@ INPUT::
api_key : "<api_key>"
method : "delete_repo"
args: {
- "repoid" : "<reponame or repo_id>"
+ "repoid" : "<reponame or repo_id>",
+ "forks" : "`delete` or `detach` = Optional(None)"
}
OUTPUT::