diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -540,6 +540,167 @@ OUTPUT:: } error : null +get_repo_group +^^^^^^^^^^^^^^ + +Get an existing repository group. +This command can only be executed using the api_key of a user with admin rights. + +INPUT:: + + id : + api_key : "" + method : "get_repo_group" + args : { + "repogroupid" : "" + } + +OUTPUT:: + + id : + result : + { + "group_id" : "", + "group_name" : "", + "group_description" : "", + "parent_group" : ""|null, + "repositories" : "", + "owner" : "", + "members" : [ + { + "name" : "", + "type" : "user", + "permission" : "group.(none|read|write|admin)" + }, + { + "name" : "", + "type" : "user_group", + "permission" : "group.(none|read|write|admin)" + }, + … + ] + + }, + error : null + +get_repo_groups +^^^^^^^^^^^^^^^ + +List all existing repository groups. +This command can only be executed using the api_key of a user with admin rights. + +INPUT:: + + id : + api_key : "" + method : "get_repo_groups" + args : { } + +OUTPUT:: + + id : + result : [ + { + "group_id" : "", + "group_name" : "", + "group_description" : "", + "parent_group" : ""|null, + "repositories" : "", + "owner" : "" + }, + … + ] + error : null + +create_repo_group +^^^^^^^^^^^^^^^^^ + +Create a new repository group. +This command can only be executed using the api_key of a user with admin rights. + +INPUT:: + + id : + api_key : "" + method : "create_repo_group" + args : { + "group_name" : "", + "description" : " = Optional("")", + "owner" : " = Optional(None)", + "parent" : " = Optional(None)", + "copy_permissions" : " = Optional(False)" + } + +OUTPUT:: + + id : + result : { + "msg" : "created new repo group ``", + "repo_group" : { + "group_id" : , + "group_name" : "/", + "group_description" : "", + "parent_group" : |null, + "repositories" : , + "owner" : "" + } + +update_repo_group +^^^^^^^^^^^^^^^^^ + +Update a repository group. +This command can only be executed using the api_key of a user with admin rights. + +INPUT:: + + id : + api_key : "" + method : "update_repo_group" + args : { + "repogroupid" : "", + "group_name" : " = Optional(None)", + "description" : " = Optional(None)", + "owner" : " = Optional(None)", + "parent" : " = Optional(None)" + } + +OUTPUT:: + + id : + result : { + "msg" : "updated repository group ID: ", + "repo_group" : { + "group_id" : , + "group_name" : "/", + "group_description" : "", + "parent_group" : |null, + "repositories" : , + "owner" : "" + } + +delete_repo_group +^^^^^^^^^^^^^^^^^ + +Delete a repository group. +This command can only be executed using the api_key of a user with admin rights. + +INPUT:: + + id : + api_key : "" + method : "delete_repo_group" + args : { + "repogroupid" : "" + } + +OUTPUT:: + + id : + result : { + "msg" : "deleted repo group ID: ", + "repo_group" : null + } + get_repo ^^^^^^^^