kallithea: docs/api/api.rst annotate

annotate docs/api/api.rst @ 2860:a5f29bd67760 beta

update zh_CN translation for 1.4.2.

author	xpol
date	Fri, 21 Sep 2012 15:29:50 +0800
parents	e21cb7b1a4a5
children	63e58ef80ef1 9c778306eb73

rev	line source
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	1 .. _api:
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	2
2095 17c9393e9645 docs Marcin Kuzminski <marcin@python-works.com> parents: 2010 diff changeset	3 ===
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	4 API
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	5 ===
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	6
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	7
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	8 Starting from RhodeCode version 1.2 a simple API was implemented.
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	9 There's a single schema for calling all api methods. API is implemented
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	10 with JSON protocol both ways. An url to send API request to RhodeCode is
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	11 <your_server>/_admin/api
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	12
1839 9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	13 API ACCESS FOR WEB VIEWS
9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	14 ++++++++++++++++++++++++
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	15
1911 0bd97250cd36 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1909 diff changeset	16 API access can also be turned on for each web view in RhodeCode that is
0bd97250cd36 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1909 diff changeset	17 decorated with `@LoginRequired` decorator. To enable API access simple change
0bd97250cd36 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1909 diff changeset	18 the standard login decorator to `@LoginRequired(api_access=True)`.
0bd97250cd36 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1909 diff changeset	19 After this change, a rhodecode view can be accessed without login by adding a
0bd97250cd36 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1909 diff changeset	20 GET parameter `?api_key=<api_key>` to url. By default this is only
1812 320dec24fb9a Added instruction on enabling the API access to web views Marcin Kuzminski <marcin@python-works.com> parents: 1810 diff changeset	21 enabled on RSS/ATOM feed views.
320dec24fb9a Added instruction on enabling the API access to web views Marcin Kuzminski <marcin@python-works.com> parents: 1810 diff changeset	22
320dec24fb9a Added instruction on enabling the API access to web views Marcin Kuzminski <marcin@python-works.com> parents: 1810 diff changeset	23
1839 9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	24 API ACCESS
9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	25 ++++++++++
9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	26
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	27 All clients are required to send JSON-RPC spec JSON data::
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	28
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	29 {
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	30 "id:"<id>",
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	31 "api_key":"<api_key>",
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	32 "method":"<method_name>",
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	33 "args":{"<arg_key>":"<arg_val>"}
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	34 }
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	35
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	36 Example call for autopulling remotes repos using curl::
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	37 curl https://server.com/_admin/api -X POST -H 'content-type:text/plain' --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repo":"CPython"}}'
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	38
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	39 Simply provide
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	40 - id A value of any type, which is used to match the response with the request that it is replying to.
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	41 - api_key for access and permission validation.
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	42 - method is name of method to call
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	43 - args is an key:value list of arguments to pass to method
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	44
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	45 .. note::
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	46
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	47 api_key can be found in your user account page
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	48
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	49
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	50 RhodeCode API will return always a JSON-RPC response::
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	51
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	52 {
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	53 "id":<id>, # matching id sent by request
c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	54 "result": "<result>"\|null, # JSON formatted result, null if any errors
c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	55 "error": "null"\|<error_message> # JSON formatted error (if any)
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	56 }
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	57
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	58 All responses from API will be `HTTP/1.0 200 OK`, if there's an error while
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	59 calling api error key from response will contain failure description
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	60 and result will be null.
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	61
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	62
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	63 API CLIENT
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	64 ++++++++++
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	65
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	66 From version 1.4 RhodeCode adds a script that allows to easily
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	67 communicate with API. After installing RhodeCode a `rhodecode-api` script
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	68 will be available.
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	69
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	70 To get started quickly simply run::
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	71
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	72 rhodecode-api _create_config --apikey=<youapikey> --apihost=<rhodecode host>
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	73
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	74 This will create a file named .config in the directory you executed it storing
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	75 json config file with credentials. You can skip this step and always provide
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	76 both of the arguments to be able to communicate with server
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	77
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	78
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	79 after that simply run any api command for example get_repo::
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	80
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	81 rhodecode-api get_repo
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	82
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	83 calling {"api_key": "<apikey>", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	84 rhodecode said:
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	85 {'error': 'Missing non optional `repoid` arg in JSON DATA',
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	86 'id': 75,
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	87 'result': None}
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	88
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	89 Ups looks like we forgot to add an argument
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	90
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	91 Let's try again now giving the repoid as parameters::
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	92
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	93 rhodecode-api get_repo repoid:rhodecode
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	94
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	95 calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "rhodecode"}, "method": "get_repo"} to http://127.0.0.1:5000
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	96 rhodecode said:
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	97 {'error': None,
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	98 'id': 39,
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	99 'result': <json data...>}
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	100
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	101
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	102
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	103 API METHODS
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	104 +++++++++++
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	105
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	106
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	107 pull
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	108 ----
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	109
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	110 Pulls given repo from remote location. Can be used to automatically keep
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	111 remote repos up to date. This command can be executed only using api_key
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	112 belonging to user with admin rights
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	113
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	114 INPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	115
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	116 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	117 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	118 method : "pull"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	119 args : {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	120 "repoid" : "<reponame or repo_id>"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	121 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	122
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	123 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	124
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	125 id : <id_given_in_input>
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	126 result : "Pulled from `<reponame>`"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	127 error : null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	128
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	129
2697 4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	130 rescan_repos
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	131 ------------
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	132
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	133 Dispatch rescan repositories action. If remove_obsolete is set
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	134 RhodeCode will delete repos that are in database but not in the filesystem.
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	135 This command can be executed only using api_key belonging to user with admin
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	136 rights.
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	137
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	138 INPUT::
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	139
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	140 id : <id_for_response>
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	141 api_key : "<api_key>"
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	142 method : "rescan_repos"
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	143 args : {
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	144 "remove_obsolete" : "<boolean = Optional(False)>"
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	145 }
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	146
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	147 OUTPUT::
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	148
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	149 id : <id_given_in_input>
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	150 result : "{'added': [<list of names of added repos>],
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	151 'removed': [<list of names of removed repos>]}"
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	152 error : null
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	153
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	154
2737 e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	155 lock
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	156 ----
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	157
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	158 Set locking state on given repository by given user.
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	159 This command can be executed only using api_key belonging to user with admin
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	160 rights.
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	161
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	162 INPUT::
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	163
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	164 id : <id_for_response>
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	165 api_key : "<api_key>"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	166 method : "lock"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	167 args : {
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	168 "repoid" : "<reponame or repo_id>"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	169 "userid" : "<user_id or username>",
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	170 "locked" : "<bool true\|false>"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	171
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	172 }
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	173
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	174 OUTPUT::
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	175
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	176 id : <id_given_in_input>
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	177 result : "User `<username>` set lock state for repo `<reponame>` to `true\|false`"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	178 error : null
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	179
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	180
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	181 get_user
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	182 --------
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	183
2010 14dffcfebb02 API get_user and get_repo methods can fetch by id or names Marcin Kuzminski <marcin@python-works.com> parents: 2009 diff changeset	184 Get's an user by username or user_id, Returns empty result if user is not found.
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	185 This command can be executed only using api_key belonging to user with admin
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	186 rights.
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	187
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	188
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	189 INPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	190
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	191 id : <id_for_response>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	192 api_key : "<api_key>"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	193 method : "get_user"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	194 args : {
2010 14dffcfebb02 API get_user and get_repo methods can fetch by id or names Marcin Kuzminski <marcin@python-works.com> parents: 2009 diff changeset	195 "userid" : "<username or user_id>"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	196 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	197
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	198 OUTPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	199
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	200 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	201 result: None if user does not exist or
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	202 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	203 "user_id" : "<user_id>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	204 "username" : "<username>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	205 "firstname": "<firstname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	206 "lastname" : "<lastname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	207 "email" : "<email>",
2506 7e3e9d0c5575 Add list of all emails that user may have into get_user call Marcin Kuzminski <marcin@python-works.com> parents: 2379 diff changeset	208 "emails": "<list_of_all_additional_emails>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	209 "active" : "<bool>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	210 "admin" : "<bool>",
2151 12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	211 "ldap_dn" : "<ldap_dn>",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	212 "last_login": "<last_login>",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	213 "permissions": {
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	214 "global": ["hg.create.repository",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	215 "repository.read",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	216 "hg.register.manual_activate"],
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	217 "repositories": {"repo1": "repository.none"},
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	218 "repositories_groups": {"Group1": "group.read"}
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	219 },
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	220 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	221
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	222 error: null
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	223
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	224
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	225 get_users
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	226 ---------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	227
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	228 Lists all existing users. This command can be executed only using api_key
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	229 belonging to user with admin rights.
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	230
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	231
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	232 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	233
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	234 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	235 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	236 method : "get_users"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	237 args : { }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	238
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	239 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	240
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	241 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	242 result: [
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	243 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	244 "user_id" : "<user_id>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	245 "username" : "<username>",
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	246 "firstname": "<firstname>",
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	247 "lastname" : "<lastname>",
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	248 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	249 "emails": "<list_of_all_additional_emails>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	250 "active" : "<bool>",
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	251 "admin" : "<bool>",
2151 12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	252 "ldap_dn" : "<ldap_dn>",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	253 "last_login": "<last_login>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	254 },
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	255 …
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	256 ]
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	257 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	258
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	259
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	260 create_user
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	261 -----------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	262
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	263 Creates new user. This command can
1909 f2bd5b0c1094 create user api_doc update Marcin Kuzminski <marcin@python-works.com> parents: 1843 diff changeset	264 be executed only using api_key belonging to user with admin rights.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	265
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	266
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	267 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	268
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	269 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	270 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	271 method : "create_user"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	272 args : {
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	273 "username" : "<username>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	274 "email" : "<useremail>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	275 "password" : "<password>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	276 "firstname" : "<firstname> = Optional(None)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	277 "lastname" : "<lastname> = Optional(None)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	278 "active" : "<bool> = Optional(True)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	279 "admin" : "<bool> = Optional(False)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	280 "ldap_dn" : "<ldap_dn> = Optional(None)"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	281 }
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	282
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	283 OUTPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	284
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	285 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	286 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	287 "msg" : "created new user `<username>`",
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	288 "user": {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	289 "user_id" : "<user_id>",
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	290 "username" : "<username>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	291 "firstname": "<firstname>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	292 "lastname" : "<lastname>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	293 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	294 "emails": "<list_of_all_additional_emails>",
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	295 "active" : "<bool>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	296 "admin" : "<bool>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	297 "ldap_dn" : "<ldap_dn>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	298 "last_login": "<last_login>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	299 },
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	300 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	301 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	302
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	303
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	304 update_user
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	305 -----------
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	306
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	307 updates given user if such user exists. This command can
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	308 be executed only using api_key belonging to user with admin rights.
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	309
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	310
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	311 INPUT::
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	312
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	313 id : <id_for_response>
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	314 api_key : "<api_key>"
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	315 method : "update_user"
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	316 args : {
2009 b63adad7c4af API updates Marcin Kuzminski <marcin@python-works.com> parents: 2006 diff changeset	317 "userid" : "<user_id or username>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	318 "username" : "<username> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	319 "email" : "<useremail> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	320 "password" : "<password> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	321 "firstname" : "<firstname> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	322 "lastname" : "<lastname> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	323 "active" : "<bool> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	324 "admin" : "<bool> = Optional",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	325 "ldap_dn" : "<ldap_dn> = Optional"
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	326 }
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	327
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	328 OUTPUT::
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	329
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	330 id : <id_given_in_input>
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	331 result: {
2507 374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	332 "msg" : "updated user ID:<userid> <username>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	333 "user": {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	334 "user_id" : "<user_id>",
2507 374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	335 "username" : "<username>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	336 "firstname": "<firstname>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	337 "lastname" : "<lastname>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	338 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	339 "emails": "<list_of_all_additional_emails>",
2507 374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	340 "active" : "<bool>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	341 "admin" : "<bool>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	342 "ldap_dn" : "<ldap_dn>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	343 "last_login": "<last_login>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	344 },
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	345 }
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	346 error: null
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	347
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	348
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	349 delete_user
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	350 -----------
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	351
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	352
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	353 deletes givenuser if such user exists. This command can
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	354 be executed only using api_key belonging to user with admin rights.
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	355
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	356
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	357 INPUT::
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	358
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	359 id : <id_for_response>
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	360 api_key : "<api_key>"
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	361 method : "delete_user"
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	362 args : {
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	363 "userid" : "<user_id or username>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	364 }
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	365
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	366 OUTPUT::
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	367
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	368 id : <id_given_in_input>
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	369 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	370 "msg" : "deleted user ID:<userid> <username>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	371 "user": null
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	372 }
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	373 error: null
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	374
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	375
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	376 get_users_group
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	377 ---------------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	378
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	379 Gets an existing users group. This command can be executed only using api_key
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	380 belonging to user with admin rights.
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	381
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	382
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	383 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	384
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	385 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	386 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	387 method : "get_users_group"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	388 args : {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	389 "usersgroupid" : "<users group id or name>"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	390 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	391
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	392 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	393
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	394 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	395 result : None if group not exist
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	396 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	397 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	398 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	399 "active": "<bool>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	400 "members" : [
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	401 {
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	402 "user_id" : "<user_id>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	403 "username" : "<username>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	404 "firstname": "<firstname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	405 "lastname" : "<lastname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	406 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	407 "emails": "<list_of_all_additional_emails>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	408 "active" : "<bool>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	409 "admin" : "<bool>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	410 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	411 "last_login": "<last_login>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	412 },
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	413 …
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	414 ]
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	415 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	416 error : null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	417
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	418
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	419 get_users_groups
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	420 ----------------
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	421
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	422 Lists all existing users groups. This command can be executed only using
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	423 api_key belonging to user with admin rights.
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	424
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	425
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	426 INPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	427
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	428 id : <id_for_response>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	429 api_key : "<api_key>"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	430 method : "get_users_groups"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	431 args : { }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	432
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	433 OUTPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	434
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	435 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	436 result : [
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	437 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	438 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	439 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	440 "active": "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	441 "members" : [
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	442 {
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	443 "user_id" : "<user_id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	444 "username" : "<username>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	445 "firstname": "<firstname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	446 "lastname" : "<lastname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	447 "email" : "<email>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	448 "emails": "<list_of_all_additional_emails>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	449 "active" : "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	450 "admin" : "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	451 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	452 "last_login": "<last_login>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	453 },
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	454 …
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	455 ]
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	456 },
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	457 …
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	458 ]
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	459 error : null
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	460
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	461
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	462 create_users_group
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	463 ------------------
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	464
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	465 Creates new users group. This command can be executed only using api_key
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	466 belonging to user with admin rights
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	467
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	468
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	469 INPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	470
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	471 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	472 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	473 method : "create_users_group"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	474 args: {
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	475 "group_name": "<groupname>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	476 "active":"<bool> = Optional(True)"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	477 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	478
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	479 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	480
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	481 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	482 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	483 "msg": "created new users group `<groupname>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	484 "users_group": {
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	485 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	486 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	487 "active": "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	488 "members" : [
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	489 {
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	490 "user_id" : "<user_id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	491 "username" : "<username>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	492 "firstname": "<firstname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	493 "lastname" : "<lastname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	494 "email" : "<email>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	495 "emails": "<list_of_all_additional_emails>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	496 "active" : "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	497 "admin" : "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	498 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	499 "last_login": "<last_login>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	500 },
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	501 …
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	502 ]
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	503 },
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	504 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	505 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	506
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	507
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	508 add_user_to_users_group
631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	509 -----------------------
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	510
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	511 Adds a user to a users group. If user exists in that group success will be
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	512 `false`. This command can be executed only using api_key
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	513 belonging to user with admin rights
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	514
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	515
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	516 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	517
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	518 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	519 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	520 method : "add_user_users_group"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	521 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	522 "usersgroupid" : "<users group id or name>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	523 "userid" : "<user_id or username>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	524 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	525
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	526 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	527
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	528 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	529 result: {
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	530 "success": True\|False # depends on if member is in group
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	531 "msg": "added member `<username>` to users group `<groupname>` \|
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	532 User is already in that group"
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	533 }
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	534 error: null
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	535
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	536
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	537 remove_user_from_users_group
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	538 ----------------------------
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	539
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	540 Removes a user from a users group. If user is not in given group success will
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	541 be `false`. This command can be executed only
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	542 using api_key belonging to user with admin rights
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	543
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	544
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	545 INPUT::
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	546
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	547 id : <id_for_response>
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	548 api_key : "<api_key>"
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	549 method : "remove_user_from_users_group"
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	550 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	551 "usersgroupid" : "<users group id or name>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	552 "userid" : "<user_id or username>",
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	553 }
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	554
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	555 OUTPUT::
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	556
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	557 id : <id_given_in_input>
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	558 result: {
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	559 "success": True\|False, # depends on if member is in group
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	560 "msg": "removed member <username> from users group <groupname> \|
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	561 User wasn't in group"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	562 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	563 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	564
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	565
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	566 get_repo
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	567 --------
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	568
2146 ee45677c4edc Api docs fixes Marcin Kuzminski <marcin@python-works.com> parents: 2143 diff changeset	569 Gets an existing repository by it's name or repository_id. Members will return
ee45677c4edc Api docs fixes Marcin Kuzminski <marcin@python-works.com> parents: 2143 diff changeset	570 either users_group or user associated to that repository. This command can
2010 14dffcfebb02 API get_user and get_repo methods can fetch by id or names Marcin Kuzminski <marcin@python-works.com> parents: 2009 diff changeset	571 be executed only using api_key belonging to user with admin rights.
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	572
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	573
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	574 INPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	575
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	576 id : <id_for_response>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	577 api_key : "<api_key>"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	578 method : "get_repo"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	579 args: {
2010 14dffcfebb02 API get_user and get_repo methods can fetch by id or names Marcin Kuzminski <marcin@python-works.com> parents: 2009 diff changeset	580 "repoid" : "<reponame or repo_id>"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	581 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	582
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	583 OUTPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	584
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	585 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	586 result: None if repository does not exist or
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	587 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	588 "repo_id" : "<repo_id>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	589 "repo_name" : "<reponame>"
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	590 "repo_type" : "<repo_type>",
2338 347b00545b60 Updated API to return clone_uri, private, created_on Marcin Kuzminski <marcin@python-works.com> parents: 2151 diff changeset	591 "clone_uri" : "<clone_uri>",
347b00545b60 Updated API to return clone_uri, private, created_on Marcin Kuzminski <marcin@python-works.com> parents: 2151 diff changeset	592 "private": : "<bool>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	593 "created_on" : "<datetimecreated>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	594 "description" : "<description>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	595 "landing_rev": "<landing_rev>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	596 "owner": "<repo_owner>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	597 "fork_of": "<name_of_fork_parent>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	598 "members" : [
2146 ee45677c4edc Api docs fixes Marcin Kuzminski <marcin@python-works.com> parents: 2143 diff changeset	599 {
ee45677c4edc Api docs fixes Marcin Kuzminski <marcin@python-works.com> parents: 2143 diff changeset	600 "type": "user",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	601 "user_id" : "<user_id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	602 "username" : "<username>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	603 "firstname": "<firstname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	604 "lastname" : "<lastname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	605 "email" : "<email>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	606 "emails": "<list_of_all_additional_emails>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	607 "active" : "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	608 "admin" : "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	609 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	610 "last_login": "<last_login>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	611 "permission" : "repository.(read\|write\|admin)"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	612 },
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	613 …
2146 ee45677c4edc Api docs fixes Marcin Kuzminski <marcin@python-works.com> parents: 2143 diff changeset	614 {
ee45677c4edc Api docs fixes Marcin Kuzminski <marcin@python-works.com> parents: 2143 diff changeset	615 "type": "users_group",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	616 "id" : "<usersgroupid>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	617 "name" : "<usersgroupname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	618 "active": "<bool>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	619 "permission" : "repository.(read\|write\|admin)"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	620 },
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	621 …
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	622 ]
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	623 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	624 error: null
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	625
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	626
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	627 get_repos
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	628 ---------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	629
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	630 Lists all existing repositories. This command can be executed only using api_key
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	631 belonging to user with admin rights
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	632
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	633
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	634 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	635
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	636 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	637 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	638 method : "get_repos"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	639 args: { }
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	640
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	641 OUTPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	642
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	643 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	644 result: [
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	645 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	646 "repo_id" : "<repo_id>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	647 "repo_name" : "<reponame>"
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	648 "repo_type" : "<repo_type>",
2338 347b00545b60 Updated API to return clone_uri, private, created_on Marcin Kuzminski <marcin@python-works.com> parents: 2151 diff changeset	649 "clone_uri" : "<clone_uri>",
347b00545b60 Updated API to return clone_uri, private, created_on Marcin Kuzminski <marcin@python-works.com> parents: 2151 diff changeset	650 "private": : "<bool>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	651 "created_on" : "<datetimecreated>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	652 "description" : "<description>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	653 "landing_rev": "<landing_rev>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	654 "owner": "<repo_owner>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	655 "fork_of": "<name_of_fork_parent>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	656 },
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	657 …
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	658 ]
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	659 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	660
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	661
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	662 get_repo_nodes
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	663 --------------
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	664
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	665 returns a list of nodes and it's children in a flat list for a given path
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	666 at given revision. It's possible to specify ret_type to show only `files` or
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	667 `dirs`. This command can be executed only using api_key belonging to user
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	668 with admin rights
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	669
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	670
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	671 INPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	672
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	673 id : <id_for_response>
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	674 api_key : "<api_key>"
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	675 method : "get_repo_nodes"
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	676 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	677 "repoid" : "<reponame or repo_id>"
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	678 "revision" : "<revision>",
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	679 "root_path" : "<root_path>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	680 "ret_type" : "<ret_type> = Optional('all')"
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	681 }
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	682
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	683 OUTPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	684
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	685 id : <id_given_in_input>
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	686 result: [
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	687 {
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	688 "name" : "<name>"
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	689 "type" : "<type>",
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	690 },
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	691 …
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	692 ]
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	693 error: null
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	694
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	695
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	696 create_repo
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	697 -----------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	698
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	699 Creates a repository. This command can be executed only using api_key
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	700 belonging to user with admin rights.
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	701 If repository name contains "/", all needed repository groups will be created.
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	702 For example "foo/bar/baz" will create groups "foo", "bar" (with "foo" as parent),
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	703 and create "baz" repository with "bar" as group.
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	704
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	705
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	706 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	707
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	708 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	709 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	710 method : "create_repo"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	711 args: {
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	712 "repo_name" : "<reponame>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	713 "owner" : "<onwer_name_or_id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	714 "repo_type" : "<repo_type>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	715 "description" : "<description> = Optional('')",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	716 "private" : "<bool> = Optional(False)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	717 "clone_uri" : "<clone_uri> = Optional(None)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	718 "landing_rev" : "<landing_rev> = Optional('tip')",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	719 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	720
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	721 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	722
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	723 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	724 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	725 "msg": "Created new repository `<reponame>`",
2378 04ef27ce939e API: create_repo returns now repo object after creation Marcin Kuzminski <marcin@python-works.com> parents: 2365 diff changeset	726 "repo": {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	727 "repo_id" : "<repo_id>",
2378 04ef27ce939e API: create_repo returns now repo object after creation Marcin Kuzminski <marcin@python-works.com> parents: 2365 diff changeset	728 "repo_name" : "<reponame>"
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	729 "repo_type" : "<repo_type>",
2378 04ef27ce939e API: create_repo returns now repo object after creation Marcin Kuzminski <marcin@python-works.com> parents: 2365 diff changeset	730 "clone_uri" : "<clone_uri>",
04ef27ce939e API: create_repo returns now repo object after creation Marcin Kuzminski <marcin@python-works.com> parents: 2365 diff changeset	731 "private": : "<bool>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	732 "created_on" : "<datetimecreated>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	733 "description" : "<description>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	734 "landing_rev": "<landing_rev>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	735 "owner": "<repo_owner>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	736 "fork_of": "<name_of_fork_parent>",
2378 04ef27ce939e API: create_repo returns now repo object after creation Marcin Kuzminski <marcin@python-works.com> parents: 2365 diff changeset	737 },
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	738 }
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	739 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	740
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	741
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	742 delete_repo
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	743 -----------
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	744
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	745 Deletes a repository. This command can be executed only using api_key
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	746 belonging to user with admin rights.
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	747
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	748
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	749 INPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	750
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	751 id : <id_for_response>
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	752 api_key : "<api_key>"
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	753 method : "delete_repo"
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	754 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	755 "repoid" : "<reponame or repo_id>"
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	756 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	757
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	758 OUTPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	759
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	760 id : <id_given_in_input>
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	761 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	762 "msg": "Deleted repository `<reponame>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	763 "success": true
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	764 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	765 error: null
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	766
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	767
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	768 grant_user_permission
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	769 ---------------------
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	770
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	771 Grant permission for user on given repository, or update existing one
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	772 if found. This command can be executed only using api_key belonging to user
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	773 with admin rights.
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	774
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	775
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	776 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	777
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	778 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	779 api_key : "<api_key>"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	780 method : "grant_user_permission"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	781 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	782 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	783 "userid" : "<username or user_id>"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	784 "perm" : "(repository.(none\|read\|write\|admin))",
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	785 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	786
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	787 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	788
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	789 id : <id_given_in_input>
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	790 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	791 "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	792 "success": true
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	793 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	794 error: null
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	795
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	796
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	797 revoke_user_permission
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	798 ----------------------
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	799
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	800 Revoke permission for user on given repository. This command can be executed
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	801 only using api_key belonging to user with admin rights.
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	802
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	803
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	804 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	805
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	806 id : <id_for_response>
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	807 api_key : "<api_key>"
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	808 method : "revoke_user_permission"
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	809 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	810 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	811 "userid" : "<username or user_id>"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	812 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	813
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	814 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	815
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	816 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	817 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	818 "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	819 "success": true
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	820 }
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	821 error: null
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	822
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	823
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	824 grant_users_group_permission
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	825 ----------------------------
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	826
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	827 Grant permission for users group on given repository, or update
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	828 existing one if found. This command can be executed only using
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	829 api_key belonging to user with admin rights.
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	830
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	831
631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	832 INPUT::
631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	833
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	834 id : <id_for_response>
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	835 api_key : "<api_key>"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	836 method : "grant_users_group_permission"
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	837 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	838 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	839 "usersgroupid" : "<users group id or name>"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	840 "perm" : "(repository.(none\|read\|write\|admin))",
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	841 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	842
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	843 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	844
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	845 id : <id_given_in_input>
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	846 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	847 "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	848 "success": true
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	849 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	850 error: null
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	851
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	852
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	853 revoke_users_group_permission
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	854 -----------------------------
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	855
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	856 Revoke permission for users group on given repository.This command can be
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	857 executed only using api_key belonging to user with admin rights.
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	858
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	859 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	860
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	861 id : <id_for_response>
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	862 api_key : "<api_key>"
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	863 method : "revoke_users_group_permission"
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	864 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	865 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	866 "usersgroupid" : "<users group id or name>"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	867 }
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	868
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	869 OUTPUT::
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	870
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	871 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	872 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	873 "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	874 "success": true
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	875 }
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	876 error: null

Mercurial > kallithea

annotate docs/api/api.rst @ 2860:a5f29bd67760 beta