diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -7,7 +7,7 @@ API Starting from RhodeCode version 1.2 a simple API was implemented. There's a single schema for calling all api methods. API is implemented -with JSON protocol both ways. An url to send API request in RhodeCode is +with JSON protocol both ways. An url to send API request in RhodeCode is /_admin/api @@ -22,90 +22,341 @@ All clients need to send JSON data in su Example call for autopulling remotes repos using curl:: curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}' -Simply provide +Simply provide - *api_key* for access and permission validation. - *method* is name of method to call - *args* is an key:value list of arguments to pass to method - + .. note:: - - api_key can be found in your user account page - - + + api_key can be found in your user account page + + RhodeCode API will return always a JSON formatted answer:: - + { - "result": "", + "result": "", "error": null } All responses from API will be `HTTP/1.0 200 OK`, if there's an error while -calling api *error* key from response will contain failure description +calling api *error* key from response will contain failure description and result will be null. API METHODS +++++++++++ - + pull ---- -Pulls given repo from remote location. Can be used to automatically keep -remote repos up to date. This command can be executed only using api_key -belonging to user with admin rights - -INPUT:: - - api_key:"" - method: "pull" - args: {"repo":} - -OUTPUT:: - - result:"Pulled from " - error:null - - -create_user ------------ - -Creates new user in RhodeCode. This command can be executed only using api_key +Pulls given repo from remote location. Can be used to automatically keep +remote repos up to date. This command can be executed only using api_key belonging to user with admin rights INPUT:: - api_key:"" - method: "create_user" - args: {"username": "", - "password": "", - "active": "", - "admin": "", - "name": "", - "lastname": "", - "email": ""} + api_key : "" + method : "pull" + args : { + "repo" : "" + } + +OUTPUT:: + + result : "Pulled from " + error : null + + +get_users +--------- + +Lists all existing users. This command can be executed only using api_key +belonging to user with admin rights. + +INPUT:: + + api_key : "" + method : "get_users" + args : { } + +OUTPUT:: + + result: [ + { + "id" : "", + "username" : "", + "firstname": "", + "lastname" : "", + "email" : "", + "active" : "", + "admin" :  "", + "ldap" : "" + }, + … + ] + error: null + +create_user +----------- + +Creates new user in RhodeCode. This command can be executed only using api_key +belonging to user with admin rights. + +INPUT:: + + api_key : "" + method : "create_user" + args : { + "username" : "", + "password" : "", + "firstname" : "", + "lastname" : "", + "email" : "" + "active" : " = True", + "admin" : " = False", + "ldap_dn" : " = None" + } OUTPUT:: - result:{"id": , - "msg":"created new user "} - error:null - - + result: { + "msg" : "created new user " + } + error: null + +get_users_groups +---------------- + +Lists all existing users groups. This command can be executed only using api_key +belonging to user with admin rights. + +INPUT:: + + api_key : "" + method : "get_users_groups" + args : { } + +OUTPUT:: + + result : [ + { + "id" : "", + "name" : "", + "active": "", + "members" : [ + { + "id" : "", + "username" : "", + "firstname": "", + "lastname" : "", + "email" : "", + "active" : "", + "admin" :  "", + "ldap" : "" + }, + … + ] + } + ] + error : null + +get_users_group +--------------- + +Gets an existing users group. This command can be executed only using api_key +belonging to user with admin rights. + +INPUT:: + + api_key : "" + method : "get_users_group" + args : { + "group_name" : "" + } + +OUTPUT:: + + result : None if group not exist + { + "id" : "", + "name" : "", + "active": "", + "members" : [ + { "id" : "", + "username" : "", + "firstname": "", + "lastname" : "", + "email" : "", + "active" : "", + "admin" :  "", + "ldap" : "" + }, + … + ] + } + error : null + create_users_group ------------------ -creates new users group. This command can be executed only using api_key +Creates new users group. This command can be executed only using api_key belonging to user with admin rights INPUT:: - api_key:"" - method: "create_user" - args: {"name": "", - "active":""} + api_key : "" + method : "create_users_group" + args: { + "name": "", + "active":" = True" + } + +OUTPUT:: + + result: { + "id": "", + "msg": "created new users group " + } + error: null + +add_user_to_users_groups +------------------------ + +Adds a user to a users group. This command can be executed only using api_key +belonging to user with admin rights + +INPUT:: + + api_key : "" + method : "add_user_users_group" + args: { + "group_name" : "", + "user_name" : "" + } + +OUTPUT:: + + result: { + "id": "", + "msg": "created new users group member" + } + error: null + +get_repos +--------- + +Lists all existing repositories. This command can be executed only using api_key +belonging to user with admin rights + +INPUT:: + + api_key : "" + method : "get_repos" + args: { } OUTPUT:: - result:{"id": , - "msg":"created new users group "} - error:null + result: [ + { + "id" : "", + "name" : "" + "type" : "", + "description" : "" + }, + … + ] + error: null + +get_repo +-------- + +Gets an existing repository. This command can be executed only using api_key +belonging to user with admin rights + +INPUT:: + + api_key : "" + method : "get_repo" + args: { + "name" : "" + } + +OUTPUT:: + + result: None if repository not exist + { + "id" : "", + "name" : "" + "type" : "", + "description" : "", + "members" : [ + { "id" : "", + "username" : "", + "firstname": "", + "lastname" : "", + "email" : "", + "active" : "", + "admin" :  "", + "ldap" : "", + "permission" : "repository_(read|write|admin)" + }, + … + { + "id" : "", + "name" : "", + "active": "", + "permission" : "repository_(read|write|admin)" + }, + … + ] + } + error: null + +create_repo +----------- + +Creates a repository. This command can be executed only using api_key +belonging to user with admin rights. +If repository name contains "/", all needed repository groups will be created. +For example "foo/bar/baz" will create groups "foo", "bar" (with "foo" as parent), +and create "baz" repository with "bar" as group. + +INPUT:: + + api_key : "" + method : "create_repo" + args: { + "name" : "", + "owner_name" : "", + "description" : " = ''", + "repo_type" : " = 'hg'", + "private" : " = False" + } + +OUTPUT:: + + result: None + error: null + +add_user_to_repo +---------------- + +Add a user to a repository. This command can be executed only using api_key +belonging to user with admin rights. +If "perm" is None, user will be removed from the repository. + +INPUT:: + + api_key : "" + method : "add_user_to_repo" + args: { + "repo_name" : "", + "user_name" : "", + "perm" : "(None|repository_(read|write|admin))", + } + +OUTPUT:: + + result: None + error: null