kallithea: docs/api/api.rst annotate

annotate docs/api/api.rst @ 5274:e268da9b748f

docs: add documentation for update_repo API

author	Mads Kiilerich <madski@unity3d.com>
date	Mon, 20 Jul 2015 15:11:42 +0200
parents	6620542597d3
children	5ae8e644aa88

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
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	8 Kallithea has a simple JSON RPC API with a single schema for calling all API
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	9 methods. Everything is available by sending JSON encoded http(s) requests to
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	10 <your_server>/_admin/api .
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	11
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	12
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4879 diff changeset	13 API access for web views
1839 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
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4189 diff changeset	16 API access can also be turned on for each web view in Kallithea that is
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	17 decorated with the ``@LoginRequired`` decorator. Some views use
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	18 ``@LoginRequired(api_access=True)`` and are always available. By default only
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	19 RSS/ATOM feed views are enabled. Other views are
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	20 only available if they have been white listed. Edit the
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	21 ``api_access_controllers_whitelist`` option in your .ini file and define views
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	22 that should have API access enabled.
3769 6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	23
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	24 For example, to enable API access to patch/diff raw file and archive::
3769 6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	25
3777 0b6982223baa cleanup code Marcin Kuzminski <marcin@python-works.com> parents: 3769 diff changeset	26 api_access_controllers_whitelist =
3769 6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	27 ChangesetController:changeset_patch,
6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	28 ChangesetController:changeset_raw,
6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	29 FilesController:raw,
6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	30 FilesController:archivefile
6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	31
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	32 After this change, a Kallithea view can be accessed without login by adding a
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	33 GET parameter ``?api_key=<api_key>`` to the URL.
3769 6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	34
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	35 Exposing raw diffs is a good way to integrate with
3769 6a820dcbcb99 update docs about the API access whitelist option Marcin Kuzminski <marcin@python-works.com> parents: 3759 diff changeset	36 3rd party services like code review, or build farms that could download archives.
1812 320dec24fb9a Added instruction on enabling the API access to web views Marcin Kuzminski <marcin@python-works.com> parents: 1810 diff changeset	37
320dec24fb9a Added instruction on enabling the API access to web views Marcin Kuzminski <marcin@python-works.com> parents: 1810 diff changeset	38
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4879 diff changeset	39 API access
1839 9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	40 ++++++++++
9da24750f563 docs update Marcin Kuzminski <marcin@python-works.com> parents: 1812 diff changeset	41
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	42 Clients must send JSON encoded JSON-RPC requests::
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	43
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	44 {
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	45 "id: "<id>",
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	46 "api_key": "<api_key>",
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	47 "method": "<method_name>",
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	48 "args": {"<arg_key>": "<arg_val>"}
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	49 }
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	50
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	51 For example, to pull to a local "CPython" mirror using curl::
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	52
1708 fee9895fa46e changed API to match fully JSON-RPC specs Marcin Kuzminski <marcin@python-works.com> parents: 1592 diff changeset	53 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	54
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	55 In general, provide
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	56 - id, a value of any type, can be used to match the response with the request that it is replying to.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	57 - api_key, for authentication and permission validation.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	58 - method, the name of the method to call - a list of available methods can be found below.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	59 - args, the arguments to pass to the method.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	60
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	61 .. note::
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	62
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	63 api_key can be found or set on the user account page
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	64
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	65 The response to the JSON-RPC API call will always be a JSON structure::
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	66
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	67 {
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	68 "id":<id>, # the id that was used in the request
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	69 "result": "<result>"\|null, # JSON formatted result, null if any errors
c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	70 "error": "null"\|<error_message> # JSON formatted error (if any)
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	71 }
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	72
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	73 All responses from API will be ``HTTP/1.0 200 OK``. If there is an error,
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	74 the reponse will have a failure description in error and
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	75 result will be null.
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	76
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	77
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4879 diff changeset	78 API client
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	79 ++++++++++
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	80
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	81 Kallithea comes with a ``kallithea-api`` command line tool providing a convenient
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	82 way to call the JSON-RPC API.
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	83
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	84 For example, to call ``get_repo``::
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	85
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	86 kallithea-api --apihost=<your.kallithea.server.url> --apikey=<yourapikey> get_repo
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	87
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	88 calling {"api_key": "<apikey>", "id": 75, "args": {}, "method": "get_repo"} to http://127.0.0.1:5000
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4189 diff changeset	89 Kallithea said:
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	90 {'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	91 'id': 75,
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	92 'result': None}
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	93
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	94 Oops, looks like we forgot to add an argument. Let's try again, now
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	95 providing the ``repoid`` as a parameter::
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	96
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4189 diff changeset	97 kallithea-api get_repo repoid:myrepo
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	98
4192 e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4189 diff changeset	99 calling {"api_key": "<apikey>", "id": 39, "args": {"repoid": "myrepo"}, "method": "get_repo"} to http://127.0.0.1:5000
e73a69cb98dc Rename some strings examples and commands in documentation Bradley M. Kuhn <bkuhn@sfconservancy.org> parents: 4189 diff changeset	100 Kallithea said:
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	101 {'error': None,
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	102 'id': 39,
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	103 '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	104
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	105 To avoid specifying ``apihost`` and ``apikey`` every time, run::
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	106
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	107 kallithea-api --save-config --apihost=<your.kallithea.server.url> --apikey=<yourapikey>
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	108
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	109 This will create a ``~/.config/kallithea`` with the specified hostname and apikey
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	110 so you don't have to specify them every time.
2379 7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	111
7ac09514a178 created rhodecode-api binary script for working with api via cli Marcin Kuzminski <marcin@python-works.com> parents: 2378 diff changeset	112
4902 03bbd33bc084 docs: rework stuff Mads Kiilerich <madski@unity3d.com> parents: 4879 diff changeset	113 API methods
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	114 +++++++++++
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	115
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	116
1446 eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	117 pull
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	118 ----
eab0cf9ab8bf API docs Marcin Kuzminski <marcin@python-works.com> parents: diff changeset	119
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	120 Pull the given repo from remote location. Can be used to automatically keep
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	121 remote repos up to date.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	122 This command can only be executed using the api_key of a user with admin rights.
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	123
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	124 INPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	125
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	126 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	127 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	128 method : "pull"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	129 args : {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	130 "repoid" : "<reponame or repo_id>"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	131 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	132
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	133 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	134
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	135 id : <id_given_in_input>
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	136 result : "Pulled from `<reponame>`"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	137 error : null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	138
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	139
2697 4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	140 rescan_repos
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	141 ------------
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	142
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	143 Rescan repositories. If ``remove_obsolete`` is set,
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	144 Kallithea will delete repos that are in the database but not in the filesystem.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	145 This command can only be executed using the api_key of a user with admin rights.
2697 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 INPUT::
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_for_response>
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	150 api_key : "<api_key>"
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	151 method : "rescan_repos"
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	152 args : {
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	153 "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	154 }
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	155
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	156 OUTPUT::
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	157
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	158 id : <id_given_in_input>
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	159 result : "{'added': [<list of names of added repos>],
2697 4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	160 '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	161 error : null
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	162
4565e655ea2a API: Added option to rescann repositories via api call Marcin Kuzminski <marcin@python-works.com> parents: 2531 diff changeset	163
3235 d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	164 invalidate_cache
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	165 ----------------
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	166
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	167 Invalidate the cache for a repository.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	168 This command can only be executed using the api_key of a user with admin rights,
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	169 or that of a regular user with admin or write access to the repository.
3235 d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	170
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	171 INPUT::
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	172
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	173 id : <id_for_response>
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	174 api_key : "<api_key>"
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	175 method : "invalidate_cache"
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	176 args : {
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	177 "repoid" : "<reponame or repo_id>"
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	178 }
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	179
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	180 OUTPUT::
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	181
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	182 id : <id_given_in_input>
3759 12ca667b69b6 api: don't report invalidated cache_keys after invalidating a repo Mads Kiilerich <madski@unity3d.com> parents: 3714 diff changeset	183 result : "Caches of repository `<reponame>`"
3235 d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	184 error : null
d6029dacbcc4 API invalidate_cache function ref #733 Marcin Kuzminski <marcin@python-works.com> parents: 3224 diff changeset	185
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	186
2737 e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	187 lock
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	188 ----
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	189
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	190 Set the locking state on the given repository by the given user.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	191 If the param ``userid`` is skipped, it is set to the ID of the user who is calling this method.
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	192 If param ``locked`` is skipped, the current lock state of the repository is returned.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	193 This command can only be executed using the api_key of a user with admin rights, or that of a regular user with admin or write access to the repository.
2737 e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	194
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	195 INPUT::
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	196
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	197 id : <id_for_response>
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	198 api_key : "<api_key>"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	199 method : "lock"
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	200 args : {
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	201 "repoid" : "<reponame or repo_id>"
3161 3563c47e52fd Implemented API calls for non-admin users for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 3127 diff changeset	202 "userid" : "<user_id or username = Optional(=apiuser)>",
3457 08e8115585bd calling lock function without lock attribute, will return lock state Marcin Kuzminski <marcin@python-works.com> parents: 3410 diff changeset	203 "locked" : "<bool true\|false = Optional(=None)>"
2737 e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	204 }
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	205
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	206 OUTPUT::
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	207
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	208 id : <id_given_in_input>
3809 647fb653048e make the password optional in API calls Marcin Kuzminski <marcin@python-works.com> parents: 3808 diff changeset	209 result : {
3808 2feb58495f34 locking API returns objects instead of string messages. Marcin Kuzminski <marcin@python-works.com> parents: 3777 diff changeset	210 "repo": "<reponame>",
2feb58495f34 locking API returns objects instead of string messages. Marcin Kuzminski <marcin@python-works.com> parents: 3777 diff changeset	211 "locked": "<bool true\|false>",
2feb58495f34 locking API returns objects instead of string messages. Marcin Kuzminski <marcin@python-works.com> parents: 3777 diff changeset	212 "locked_since": "<float lock_time>",
2feb58495f34 locking API returns objects instead of string messages. Marcin Kuzminski <marcin@python-works.com> parents: 3777 diff changeset	213 "locked_by": "<username>",
2feb58495f34 locking API returns objects instead of string messages. Marcin Kuzminski <marcin@python-works.com> parents: 3777 diff changeset	214 "msg": "User `<username>` set lock state for repo `<reponame>` to `<false\|true>`"
3809 647fb653048e make the password optional in API calls Marcin Kuzminski <marcin@python-works.com> parents: 3808 diff changeset	215 }
2737 e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	216 error : null
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	217
e21cb7b1a4a5 added API call for locking/unlocking repositories Marcin Kuzminski <marcin@python-works.com> parents: 2697 diff changeset	218
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	219 get_ip
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	220 ------
3126 703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	221
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	222 Return IP address as seen from Kallithea server, together with all
3126 703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	223 defined IP addresses for given user.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	224 This command can only be executed using the api_key of a user with admin rights.
3126 703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	225
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	226 INPUT::
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	227
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	228 id : <id_for_response>
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	229 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	230 method : "get_ip"
3126 703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	231 args : {
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	232 "userid" : "<user_id or username>",
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	233 }
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	234
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	235 OUTPUT::
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	236
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	237 id : <id_given_in_input>
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	238 result : {
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	239 "ip_addr_server": <ip_from_clien>",
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	240 "user_ips": [
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	241 {
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	242 "ip_addr": "<ip_with_mask>",
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	243 "ip_range": ["<start_ip>", "<end_ip>"],
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	244 },
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	245 ...
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	246 ]
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	247 }
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	248
3126 703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	249 error : null
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	250
703070153bc1 added API method for checking IP Marcin Kuzminski <marcin@python-works.com> parents: 3122 diff changeset	251
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	252 get_user
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	253 --------
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	254
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	255 Get a user by username or userid. The result is empty if user can't be found.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	256 If userid param is skipped, it is set to id of user who is calling this method.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	257 Any userid can be specified when the command is executed using the api_key of a user with admin rights.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	258 Regular users can only speicy their own userid.
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	259
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	260
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	261 INPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	262
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	263 id : <id_for_response>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	264 api_key : "<api_key>"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	265 method : "get_user"
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	266 args : {
3162 a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	267 "userid" : "<username or user_id Optional(=apiuser)>"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	268 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	269
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	270 OUTPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	271
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	272 id : <id_given_in_input>
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	273 result: None if user does not exist or
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	274 {
3127 71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	275 "user_id" : "<user_id>",
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	276 "api_key" : "<api_key>",
3127 71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	277 "username" : "<username>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	278 "firstname": "<firstname>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	279 "lastname" : "<lastname>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	280 "email" : "<email>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	281 "emails": "<list_of_all_additional_emails>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	282 "ip_addresses": "<list_of_ip_addresses_for_user>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	283 "active" : "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	284 "admin" : "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	285 "ldap_dn" : "<ldap_dn>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	286 "last_login": "<last_login>",
2151 12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	287 "permissions": {
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	288 "global": ["hg.create.repository",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	289 "repository.read",
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	290 "hg.register.manual_activate"],
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	291 "repositories": {"repo1": "repository.none"},
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	292 "repositories_groups": {"Group1": "group.read"}
12ceeda33339 #404 API extensions for showing permission for users Marcin Kuzminski <marcin@python-works.com> parents: 2146 diff changeset	293 },
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	294 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	295 error: null
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	296
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	297
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	298 get_users
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	299 ---------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	300
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	301 List all existing users.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	302 This command can only be executed using the api_key of a user with admin rights.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	303
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	304
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	305 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	306
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	307 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	308 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	309 method : "get_users"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	310 args : { }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	311
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	312 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	313
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	314 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	315 result: [
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	316 {
3127 71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	317 "user_id" : "<user_id>",
3940 3a608d72a86f api.rst edited online with Bitbucket Ton Plomp <tcplomp@gmail.com> parents: 3809 diff changeset	318 "api_key" : "<api_key>",
3127 71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	319 "username" : "<username>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	320 "firstname": "<firstname>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	321 "lastname" : "<lastname>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	322 "email" : "<email>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	323 "emails": "<list_of_all_additional_emails>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	324 "ip_addresses": "<list_of_ip_addresses_for_user>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	325 "active" : "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	326 "admin" : "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	327 "ldap_dn" : "<ldap_dn>",
71ce052f8b6b add ipaddresses to repo data on API calls Marcin Kuzminski <marcin@python-works.com> parents: 3126 diff changeset	328 "last_login": "<last_login>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	329 },
3267 7b74079beec9 coding style: fix trailing and leading spaces and tabs Mads Kiilerich <madski@unity3d.com> parents: 3235 diff changeset	330 …
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	331 ]
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	332 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	333
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	334
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	335 create_user
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	336 -----------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	337
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	338 Create new user.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	339 This command can only be executed using the api_key of a user with admin rights.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	340
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	341
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	342 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	343
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	344 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	345 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	346 method : "create_user"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	347 args : {
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	348 "username" : "<username>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	349 "email" : "<useremail>",
3809 647fb653048e make the password optional in API calls Marcin Kuzminski <marcin@python-works.com> parents: 3808 diff changeset	350 "password" : "<password = Optional(None)>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	351 "firstname" : "<firstname> = Optional(None)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	352 "lastname" : "<lastname> = Optional(None)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	353 "active" : "<bool> = Optional(True)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	354 "admin" : "<bool> = Optional(False)",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	355 "ldap_dn" : "<ldap_dn> = Optional(None)"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	356 }
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	357
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	358 OUTPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	359
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	360 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	361 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	362 "msg" : "created new user `<username>`",
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	363 "user": {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	364 "user_id" : "<user_id>",
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	365 "username" : "<username>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	366 "firstname": "<firstname>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	367 "lastname" : "<lastname>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	368 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	369 "emails": "<list_of_all_additional_emails>",
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	370 "active" : "<bool>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	371 "admin" : "<bool>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	372 "ldap_dn" : "<ldap_dn>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	373 "last_login": "<last_login>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	374 },
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	375 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	376 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	377
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	378
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	379 update_user
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	380 -----------
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	381
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	382 Update the given user if such user exists.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	383 This command can only be executed using the api_key of a user with admin rights.
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	384
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	385
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	386 INPUT::
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	387
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	388 id : <id_for_response>
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	389 api_key : "<api_key>"
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	390 method : "update_user"
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	391 args : {
2009 b63adad7c4af API updates Marcin Kuzminski <marcin@python-works.com> parents: 2006 diff changeset	392 "userid" : "<user_id or username>",
3162 a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	393 "username" : "<username> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	394 "email" : "<useremail> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	395 "password" : "<password> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	396 "firstname" : "<firstname> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	397 "lastname" : "<lastname> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	398 "active" : "<bool> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	399 "admin" : "<bool> = Optional(None)",
a0a8f38e8fb8 API method get_user can be executed by non-admin users ref #539 Marcin Kuzminski <marcin@python-works.com> parents: 3161 diff changeset	400 "ldap_dn" : "<ldap_dn> = Optional(None)"
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	401 }
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	402
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	403 OUTPUT::
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	404
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	405 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	406 result: {
2507 374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	407 "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	408 "user": {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	409 "user_id" : "<user_id>",
3940 3a608d72a86f api.rst edited online with Bitbucket Ton Plomp <tcplomp@gmail.com> parents: 3809 diff changeset	410 "api_key" : "<api_key>",
2507 374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	411 "username" : "<username>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	412 "firstname": "<firstname>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	413 "lastname" : "<lastname>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	414 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	415 "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	416 "active" : "<bool>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	417 "admin" : "<bool>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	418 "ldap_dn" : "<ldap_dn>",
374693af2849 API: update_user returns new updated user data Marcin Kuzminski <marcin@python-works.com> parents: 2506 diff changeset	419 "last_login": "<last_login>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	420 },
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	421 }
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	422 error: null
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	423
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	424
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	425 delete_user
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	426 -----------
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	427
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	428 Delete the given user if such a user exists.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	429 This command can only be executed using the api_key of a user with admin rights.
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	430
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	431
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	432 INPUT::
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	433
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	434 id : <id_for_response>
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	435 api_key : "<api_key>"
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	436 method : "delete_user"
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	437 args : {
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	438 "userid" : "<user_id or username>",
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	439 }
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	440
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	441 OUTPUT::
b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	442
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	443 id : <id_given_in_input>
2365 b902baeaa494 API, added delete_user method. Marcin Kuzminski <marcin@python-works.com> parents: 2338 diff changeset	444 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	445 "msg" : "deleted user ID:<userid> <username>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	446 "user": null
2002 bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	447 }
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	448 error: null
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	449
bdc0ad168006 API added explicit method for updating user account Marcin Kuzminski <marcin@python-works.com> parents: 1989 diff changeset	450
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	451 get_user_group
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	452 --------------
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	453
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	454 Get an existing user group.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	455 This command can only be executed using the api_key of a user with admin rights.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	456
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	457
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	458 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	459
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	460 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	461 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	462 method : "get_user_group"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	463 args : {
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	464 "usergroupid" : "<user group id or name>"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	465 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	466
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	467 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	468
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	469 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	470 result : None if group not exist
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	471 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	472 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	473 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	474 "active": "<bool>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	475 "members" : [
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	476 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	477 "user_id" : "<user_id>",
3940 3a608d72a86f api.rst edited online with Bitbucket Ton Plomp <tcplomp@gmail.com> parents: 3809 diff changeset	478 "api_key" : "<api_key>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	479 "username" : "<username>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	480 "firstname": "<firstname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	481 "lastname" : "<lastname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	482 "email" : "<email>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	483 "emails": "<list_of_all_additional_emails>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	484 "active" : "<bool>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	485 "admin" : "<bool>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	486 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	487 "last_login": "<last_login>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	488 },
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	489 …
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	490 ]
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	491 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	492 error : null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	493
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	494
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	495 get_user_groups
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	496 ---------------
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	497
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	498 List all existing user groups.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	499 This command can only be executed using the api_key of a user with admin rights.
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	500
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	501
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	502 INPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	503
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	504 id : <id_for_response>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	505 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	506 method : "get_user_groups"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	507 args : { }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	508
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	509 OUTPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	510
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	511 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	512 result : [
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	513 {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	514 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	515 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	516 "active": "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	517 },
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	518 …
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	519 ]
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	520 error : null
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	521
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	522
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	523 create_user_group
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	524 -----------------
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	525
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	526 Create a new user group.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	527 This command can only be executed using the api_key of a user with admin rights.
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	528
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	529
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	530 INPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	531
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	532 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	533 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	534 method : "create_user_group"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	535 args: {
3714 7e3d89d9d3a2 - Manage User’s Groups: create, delete, rename, add/remove users inside. Marcin Kuzminski <marcin@python-works.com> parents: 3641 diff changeset	536 "group_name": "<groupname>",
5274 e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	537 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
3714 7e3d89d9d3a2 - Manage User’s Groups: create, delete, rename, add/remove users inside. Marcin Kuzminski <marcin@python-works.com> parents: 3641 diff changeset	538 "active": "<bool> = Optional(True)"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	539 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	540
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	541 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	542
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	543 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	544 result: {
3410 5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups" Mads Kiilerich <madski@unity3d.com> parents: 3267 diff changeset	545 "msg": "created new user group `<groupname>`",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	546 "users_group": {
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	547 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	548 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	549 "active": "<bool>",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	550 },
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	551 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	552 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	553
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	554
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	555 add_user_to_user_group
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	556 ----------------------
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	557
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	558 Adds a user to a user group. If the user already is in that group, success will be
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	559 ``false``.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	560 This command can only be executed using the api_key of a user with admin rights.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	561
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	562
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	563 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	564
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	565 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	566 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	567 method : "add_user_user_group"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	568 args: {
3410 5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups" Mads Kiilerich <madski@unity3d.com> parents: 3267 diff changeset	569 "usersgroupid" : "<user group id or name>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	570 "userid" : "<user_id or username>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	571 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	572
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	573 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	574
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	575 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	576 result: {
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	577 "success": True\|False # depends on if member is in group
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	578 "msg": "added member `<username>` to a user group `<groupname>` \|
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	579 User is already in that group"
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	580 }
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	581 error: null
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	582
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	583
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	584 remove_user_from_user_group
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	585 ---------------------------
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	586
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	587 Remove a user from a user group. If the user isn't in the given group, success will
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	588 be ``false``.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	589 This command can only be executed using the api_key of a user with admin rights.
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	590
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	591
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	592 INPUT::
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	593
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	594 id : <id_for_response>
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	595 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	596 method : "remove_user_from_user_group"
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	597 args: {
3410 5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups" Mads Kiilerich <madski@unity3d.com> parents: 3267 diff changeset	598 "usersgroupid" : "<user group id or name>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	599 "userid" : "<user_id or username>",
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	600 }
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	601
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	602 OUTPUT::
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	603
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	604 id : <id_given_in_input>
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	605 result: {
0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	606 "success": True\|False, # depends on if member is in group
3410 5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups" Mads Kiilerich <madski@unity3d.com> parents: 3267 diff changeset	607 "msg": "removed member <username> from user group <groupname> \|
1989 0f87c784756e API changes Marcin Kuzminski <marcin@python-works.com> parents: 1982 diff changeset	608 User wasn't in group"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	609 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	610 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	611
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	612
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	613 get_repo
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	614 --------
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	615
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	616 Get an existing repository by its name or repository_id. Members will contain
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	617 either users_group or users associated to that repository.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	618 This command can only be executed using the api_key of a user with admin rights,
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	619 or that of a regular user with at least read access to the repository.
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	620
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	621 INPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	622
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	623 id : <id_for_response>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	624 api_key : "<api_key>"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	625 method : "get_repo"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	626 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	627 "repoid" : "<reponame or repo_id>"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	628 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	629
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	630 OUTPUT::
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	631
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	632 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	633 result: None if repository does not exist or
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	634 {
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	635 "repo_id" : "<repo_id>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	636 "repo_name" : "<reponame>"
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	637 "repo_type" : "<repo_type>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	638 "clone_uri" : "<clone_uri>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	639 "enable_downloads": "<bool>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	640 "enable_locking": "<bool>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	641 "enable_statistics": "<bool>",
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	642 "private": "<bool>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	643 "created_on" : "<date_time_created>",
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	644 "description" : "<description>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	645 "landing_rev": "<landing_rev>",
3174 37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	646 "last_changeset": {
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	647 "author": "<full_author>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	648 "date": "<date_time_of_commit>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	649 "message": "<commit_message>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	650 "raw_id": "<raw_id>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	651 "revision": "<numeric_revision>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	652 "short_id": "<short_id>"
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	653 }
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	654 "owner": "<repo_owner>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	655 "fork_of": "<name_of_fork_parent>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	656 "members" : [
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	657 {
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	658 "type": "user",
3174 37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	659 "user_id" : "<user_id>",
3940 3a608d72a86f api.rst edited online with Bitbucket Ton Plomp <tcplomp@gmail.com> parents: 3809 diff changeset	660 "api_key" : "<api_key>",
3174 37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	661 "username" : "<username>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	662 "firstname": "<firstname>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	663 "lastname" : "<lastname>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	664 "email" : "<email>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	665 "emails": "<list_of_all_additional_emails>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	666 "active" : "<bool>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	667 "admin" : "<bool>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	668 "ldap_dn" : "<ldap_dn>",
37c0ac5fe42f added last_changeset information in get_repo API function Marcin Kuzminski <marcin@python-works.com> parents: 3163 diff changeset	669 "last_login": "<last_login>",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	670 "permission" : "repository.(read\|write\|admin)"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	671 },
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	672 …
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	673 {
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	674 "type": "users_group",
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	675 "id" : "<usersgroupid>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	676 "name" : "<usersgroupname>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	677 "active": "<bool>",
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	678 "permission" : "repository.(read\|write\|admin)"
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	679 },
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	680 …
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	681 ]
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	682 "followers": [
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	683 {
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	684 "user_id" : "<user_id>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	685 "username" : "<username>",
3940 3a608d72a86f api.rst edited online with Bitbucket Ton Plomp <tcplomp@gmail.com> parents: 3809 diff changeset	686 "api_key" : "<api_key>",
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	687 "firstname": "<firstname>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	688 "lastname" : "<lastname>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	689 "email" : "<email>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	690 "emails": "<list_of_all_additional_emails>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	691 "ip_addresses": "<list_of_ip_addresses_for_user>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	692 "active" : "<bool>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	693 "admin" : "<bool>",
f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	694 "ldap_dn" : "<ldap_dn>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	695 "last_login": "<last_login>",
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	696 },
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	697 …
3213 f5dcee2b3153 updated api docs Marcin Kuzminski <marcin@python-works.com> parents: 3174 diff changeset	698 ]
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	699 }
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	700 error: null
0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	701
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	702
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	703 get_repos
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	704 ---------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	705
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	706 List all existing repositories.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	707 This command can only be executed using the api_key of a user with admin rights,
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	708 or that of a regular user with at least read access to the repository.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	709
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	710
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	711 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	712
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	713 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	714 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	715 method : "get_repos"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	716 args: { }
1500 256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	717
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	718 OUTPUT::
256e729a94cd Extended API Marcin Kuzminski <marcin@python-works.com> parents: 1491 diff changeset	719
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	720 id : <id_given_in_input>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	721 result: [
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	722 {
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	723 "repo_id" : "<repo_id>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	724 "repo_name" : "<reponame>"
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	725 "repo_type" : "<repo_type>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	726 "clone_uri" : "<clone_uri>",
5274 e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	727 "private" : "<bool>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	728 "created_on" : "<datetimecreated>",
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	729 "description" : "<description>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	730 "landing_rev": "<landing_rev>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	731 "owner": "<repo_owner>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	732 "fork_of": "<name_of_fork_parent>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	733 "enable_downloads": "<bool>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	734 "enable_locking": "<bool>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	735 "enable_statistics": "<bool>",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	736 },
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	737 …
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	738 ]
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
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	741
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	742 get_repo_nodes
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	743 --------------
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	744
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	745 Return a list of files and directories for a given path at the given revision.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	746 It is possible to specify ret_type to show only ``files`` or ``dirs``.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	747 This command can only be executed using the api_key of a user with admin rights.
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	748
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	749
1810 203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	750 INPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	751
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	752 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	753 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	754 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	755 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	756 "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	757 "revision" : "<revision>",
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	758 "root_path" : "<root_path>",
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	759 "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	760 }
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	761
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	762 OUTPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	763
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	764 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	765 result: [
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	766 {
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	767 "name" : "<name>"
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	768 "type" : "<type>",
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	769 },
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	770 …
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	771 ]
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	772 error: null
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	773
203af05539e0 implements #330 api method for listing nodes at particular revision Marcin Kuzminski <marcin@python-works.com> parents: 1793 diff changeset	774
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	775 create_repo
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	776 -----------
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	777
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	778 Create a repository. If the repository name contains "/", all needed repository
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	779 groups will be created. For example "foo/bar/baz" will create repository groups
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	780 "foo", "bar" (with "foo" as parent), and create "baz" repository with
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	781 "bar" as group.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	782 This command can only be executed using the api_key of a user with admin rights,
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	783 or that of a regular user with create repository permission.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	784 Regular users cannot specify owner parameter.
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	785
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	786
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	787 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	788
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	789 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	790 api_key : "<api_key>"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	791 method : "create_repo"
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	792 args: {
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	793 "repo_name" : "<reponame>",
5274 e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	794 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	795 "repo_type" : "<repo_type> = Optional('hg')",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	796 "description" : "<description> = Optional('')",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	797 "private" : "<bool> = Optional(False)",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	798 "clone_uri" : "<clone_uri> = Optional(None)",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	799 "landing_rev" : "<landing_rev> = Optional('tip')",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	800 "enable_downloads": "<bool> = Optional(False)",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	801 "enable_locking": "<bool> = Optional(False)",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	802 "enable_statistics": "<bool> = Optional(False)",
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	803 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	804
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	805 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	806
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	807 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	808 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	809 "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	810 "repo": {
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	811 "repo_id" : "<repo_id>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	812 "repo_name" : "<reponame>"
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	813 "repo_type" : "<repo_type>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	814 "clone_uri" : "<clone_uri>",
5274 e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	815 "private" : "<bool>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	816 "created_on" : "<datetimecreated>",
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	817 "description" : "<description>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	818 "landing_rev": "<landing_rev>",
3122 4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	819 "owner": "<username or user_id>",
3115 ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	820 "fork_of": "<name_of_fork_parent>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	821 "enable_downloads": "<bool>",
ebd76deee70d Default parameters are now also used for creating repos using API calls, and initial repo scanner Marcin Kuzminski <marcin@python-works.com> parents: 2903 diff changeset	822 "enable_locking": "<bool>",
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	823 "enable_statistics": "<bool>",
2378 04ef27ce939e API: create_repo returns now repo object after creation Marcin Kuzminski <marcin@python-works.com> parents: 2365 diff changeset	824 },
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	825 }
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	826 error: null
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	827
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	828
5274 e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	829 update_repo
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	830 -----------
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	831
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	832 Update a repository.
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	833 This command can only be executed using the api_key of a user with admin rights,
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	834 or that of a regular user with create repository permission.
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	835 Regular users cannot specify owner parameter.
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	836
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	837
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	838 INPUT::
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	839
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	840 id : <id_for_response>
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	841 api_key : "<api_key>"
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	842 method : "update_repo"
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	843 args: {
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	844 "repoid" : "<reponame or repo_id>"
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	845 "name" : "<reponame> = Optional('')",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	846 "group" : "<group_id> = Optional(None)",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	847 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	848 "description" : "<description> = Optional('')",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	849 "private" : "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	850 "clone_uri" : "<clone_uri> = Optional(None)",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	851 "landing_rev" : "<landing_rev> = Optional('tip')",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	852 "enable_downloads": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	853 "enable_locking": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	854 "enable_statistics": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	855 }
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	856
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	857 OUTPUT::
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	858
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	859 id : <id_given_in_input>
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	860 result: {
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	861 "msg": "updated repo ID:repo_id `<reponame>`",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	862 "repository": {
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	863 "repo_id" : "<repo_id>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	864 "repo_name" : "<reponame>"
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	865 "repo_type" : "<repo_type>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	866 "clone_uri" : "<clone_uri>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	867 "private": "<bool>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	868 "created_on" : "<datetimecreated>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	869 "description" : "<description>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	870 "landing_rev": "<landing_rev>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	871 "owner": "<username or user_id>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	872 "fork_of": "<name_of_fork_parent>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	873 "enable_downloads": "<bool>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	874 "enable_locking": "<bool>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	875 "enable_statistics": "<bool>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	876 "last_changeset": {
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	877 "author": "<full_author>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	878 "date": "<date_time_of_commit>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	879 "message": "<commit_message>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	880 "raw_id": "<raw_id>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	881 "revision": "<numeric_revision>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	882 "short_id": "<short_id>"
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	883 }
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	884 "locked_by": "<username>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	885 "locked_date": "<float lock_time>",
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	886 },
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	887 }
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	888 error: null
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	889
e268da9b748f docs: add documentation for update_repo API Mads Kiilerich <madski@unity3d.com> parents: 5222 diff changeset	890
3122 4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	891 fork_repo
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	892 ---------
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	893
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	894 Create a fork of the given repo. If using Celery, this will
4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	895 return success message immediately and a fork will be created
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	896 asynchronously.
5222 6620542597d3 api: check repo create permissions for update_repo and fork_repo as for create-repo Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	897 This command can only be executed using the api_key of a user with admin
6620542597d3 api: check repo create permissions for update_repo and fork_repo as for create-repo Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	898 rights, or with the global fork permission, by a regular user with create
6620542597d3 api: check repo create permissions for update_repo and fork_repo as for create-repo Mads Kiilerich <madski@unity3d.com> parents: 4955 diff changeset	899 repository permission and at least read access to the repository.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	900 Regular users cannot specify owner parameter.
3122 4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	901
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	902
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	903 INPUT::
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	904
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	905 id : <id_for_response>
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	906 api_key : "<api_key>"
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	907 method : "fork_repo"
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	908 args: {
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	909 "repoid" : "<reponame or repo_id>",
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	910 "fork_name": "<forkname>",
3163 28571535dd61 API methods create_repo, fork_repo, delete_repo, get_repo, get_repos Marcin Kuzminski <marcin@python-works.com> parents: 3162 diff changeset	911 "owner": "<username or user_id = Optional(=apiuser)>",
3122 4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	912 "description": "<description>",
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	913 "copy_permissions": "<bool>",
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	914 "private": "<bool>",
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	915 "landing_rev": "<landing_rev>"
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	916
3122 4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	917 }
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	918
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	919 OUTPUT::
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	920
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	921 id : <id_given_in_input>
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	922 result: {
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	923 "msg": "Created fork of `<reponame>` as `<forkname>`",
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	924 "success": true
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	925 }
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	926 error: null
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	927
4ef6a7ed5e3e #699: fix missing fork docs for API Marcin Kuzminski <marcin@python-works.com> parents: 3115 diff changeset	928
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	929 delete_repo
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	930 -----------
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	931
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	932 Delete a repository.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	933 This command can only be executed using the api_key of a user with admin rights,
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	934 or that of a regular user with admin access to the repository.
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	935 When ``forks`` param is set it is possible to detach or delete forks of the deleted repository.
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	936
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	937
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	938 INPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	939
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	940 id : <id_for_response>
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	941 api_key : "<api_key>"
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	942 method : "delete_repo"
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	943 args: {
3641 b44979649915 recursive forks detach Marcin Kuzminski <marcin@python-works.com> parents: 3457 diff changeset	944 "repoid" : "<reponame or repo_id>",
b44979649915 recursive forks detach Marcin Kuzminski <marcin@python-works.com> parents: 3457 diff changeset	945 "forks" : "`delete` or `detach` = Optional(None)"
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	946 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	947
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	948 OUTPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	949
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	950 id : <id_given_in_input>
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	951 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	952 "msg": "Deleted repository `<reponame>`",
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	953 "success": true
2003 7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	954 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	955 error: null
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	956
7dfcdf4c7dd2 implements #361 API method for deleting repositories Marcin Kuzminski <marcin@python-works.com> parents: 2002 diff changeset	957
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	958 grant_user_permission
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	959 ---------------------
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	960
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	961 Grant permission for a user on the given repository, or update the existing one if found.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	962 This command can only be executed using the api_key of a user with admin rights.
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	963
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	964
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	965 INPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	966
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	967 id : <id_for_response>
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	968 api_key : "<api_key>"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	969 method : "grant_user_permission"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	970 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	971 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	972 "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	973 "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	974 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	975
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	976 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	977
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	978 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	979 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	980 "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	981 "success": true
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	982 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	983 error: null
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	984
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	985
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	986 revoke_user_permission
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	987 ----------------------
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	988
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	989 Revoke permission for a user on the given repository.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	990 This command can only be executed using the api_key of a user with admin rights.
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	991
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	992
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	993 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	994
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	995 id : <id_for_response>
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	996 api_key : "<api_key>"
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	997 method : "revoke_user_permission"
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	998 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	999 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1000 "userid" : "<username or user_id>"
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	1001 }
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	1002
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	1003 OUTPUT::
8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	1004
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1005 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	1006 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1007 "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	1008 "success": true
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	1009 }
1592 8628c8706bf8 [API] Update doc Nicolas VINOT <aeris@imirhil.fr> parents: 1500 diff changeset	1010 error: null
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1011
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1012
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	1013 grant_user_group_permission
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	1014 ---------------------------
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1015
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	1016 Grant permission for a user group on the given repository, or update the
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	1017 existing one if found.
599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	1018 This command can only be executed using the api_key of a user with admin rights.
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1019
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1020
631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1021 INPUT::
631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1022
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	1023 id : <id_for_response>
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1024 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	1025 method : "grant_user_group_permission"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1026 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1027 "repoid" : "<reponame or repo_id>"
3410 5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups" Mads Kiilerich <madski@unity3d.com> parents: 3267 diff changeset	1028 "usersgroupid" : "<user group id or name>"
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1029 "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	1030 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1031
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1032 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1033
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1034 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	1035 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1036 "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	1037 "success": true
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1038 }
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1039 error: null
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	1040
8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	1041
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	1042 revoke_user_group_permission
88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	1043 ----------------------------
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1044
4955 4e6dfdb3fa01 docs: English and consistency corrections Michael V. DePalatis <mike@depalatis.net> parents: 4902 diff changeset	1045 Revoke permission for a user group on the given repository.
4879 599fba9967a4 docs: improve the API documentation Mads Kiilerich <madski@unity3d.com> parents: 4493 diff changeset	1046 This command can only be executed using the api_key of a user with admin rights.
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1047
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1048 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1049
2143 c1f1f0661090 API docs improvement. Marcin Kuzminski <marcin@python-works.com> parents: 2095 diff changeset	1050 id : <id_for_response>
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1051 api_key : "<api_key>"
4493 88b9cc4ba52f Corrected method names in documentation, to match API Rasmus Selsmark <rasmuss@unity3d.com> parents: 4192 diff changeset	1052 method : "revoke_user_group_permission"
1793 631caf880b87 implements #329 Marcin Kuzminski <marcin@python-works.com> parents: 1708 diff changeset	1053 args: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1054 "repoid" : "<reponame or repo_id>"
3410 5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups" Mads Kiilerich <madski@unity3d.com> parents: 3267 diff changeset	1055 "usersgroupid" : "<user group id or name>"
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	1056 }
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1057
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	1058 OUTPUT::
1982 87f0800abc7b #227 Initial version of repository groups permissions system Marcin Kuzminski <marcin@python-works.com> parents: 1950 diff changeset	1059
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1060 id : <id_given_in_input>
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	1061 result: {
2531 d80a68e2ebcc return proper id from users_group Marcin Kuzminski <marcin@python-works.com> parents: 2507 diff changeset	1062 "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	1063 "success": true
1843 0771f0f5ab28 api review Marcin Kuzminski <marcin@python-works.com> parents: 1839 diff changeset	1064 }
3224 8b8edfc25856 whitespace cleanup Marcin Kuzminski <marcin@python-works.com> parents: 3213 diff changeset	1065 error: null

Mercurial > kallithea

annotate docs/api/api.rst @ 5274:e268da9b748f