# HG changeset patch # User Rasmus Selsmark # Date 2014-08-21 23:05:23 # Node ID 88b9cc4ba52f21aaf60f7de07f2526a1a48b5de1 # Parent b82e782d68245cd35241844148159cbd6b444bdc Corrected method names in documentation, to match API diff --git a/docs/api/api.rst b/docs/api/api.rst --- a/docs/api/api.rst +++ b/docs/api/api.rst @@ -222,8 +222,8 @@ OUTPUT:: error : null -show_ip -------- +get_ip +------ Shows IP address as seen from Kallithea server, together with all defined IP addresses for given user. @@ -234,7 +234,7 @@ INPUT:: id : api_key : "" - method : "show_ip" + method : "get_ip" args : { "userid" : "", } @@ -457,8 +457,8 @@ OUTPUT:: error: null -get_users_group ---------------- +get_user_group +-------------- Gets an existing user group. This command can be executed only using api_key belonging to user with admin rights. @@ -468,9 +468,9 @@ INPUT:: id : api_key : "" - method : "get_users_group" + method : "get_user_group" args : { - "usersgroupid" : "" + "usergroupid" : "" } OUTPUT:: @@ -501,8 +501,8 @@ OUTPUT:: error : null -get_users_groups ----------------- +get_user_groups +--------------- Lists all existing user groups. This command can be executed only using api_key belonging to user with admin rights. @@ -512,7 +512,7 @@ INPUT:: id : api_key : "" - method : "get_users_groups" + method : "get_user_groups" args : { } OUTPUT:: @@ -529,8 +529,8 @@ OUTPUT:: error : null -create_users_group ------------------- +create_user_group +----------------- Creates new user group. This command can be executed only using api_key belonging to user with admin rights @@ -540,7 +540,7 @@ INPUT:: id : api_key : "" - method : "create_users_group" + method : "create_user_group" args: { "group_name": "", "owner" : "", @@ -561,8 +561,8 @@ OUTPUT:: error: null -add_user_to_users_group ------------------------ +add_user_to_user_group +---------------------- Adds a user to a user group. If user exists in that group success will be `false`. This command can be executed only using api_key @@ -573,7 +573,7 @@ INPUT:: id : api_key : "" - method : "add_user_users_group" + method : "add_user_user_group" args: { "usersgroupid" : "", "userid" : "", @@ -590,8 +590,8 @@ OUTPUT:: error: null -remove_user_from_users_group ----------------------------- +remove_user_from_user_group +--------------------------- Removes a user from a user group. If user is not in given group success will be `false`. This command can be executed only @@ -602,7 +602,7 @@ INPUT:: id : api_key : "" - method : "remove_user_from_users_group" + method : "remove_user_from_user_group" args: { "usersgroupid" : "", "userid" : "", @@ -957,8 +957,8 @@ OUTPUT:: error: null -grant_users_group_permission ----------------------------- +grant_user_group_permission +--------------------------- Grant permission for user group on given repository, or update existing one if found. This command can be executed only using @@ -969,7 +969,7 @@ INPUT:: id : api_key : "" - method : "grant_users_group_permission" + method : "grant_user_group_permission" args: { "repoid" : "" "usersgroupid" : "" @@ -986,8 +986,8 @@ OUTPUT:: error: null -revoke_users_group_permission ------------------------------ +revoke_user_group_permission +---------------------------- Revoke permission for user group on given repository.This command can be executed only using api_key belonging to user with admin rights. @@ -996,7 +996,7 @@ INPUT:: id : api_key : "" - method : "revoke_users_group_permission" + method : "revoke_user_group_permission" args: { "repoid" : "" "usersgroupid" : ""