kallithea: docs/api/api.rst annotate

annotate docs/api/api.rst @ 5619:6353b5e87091

ini: specify utf8 for sample MySQL connection strings By default, the MySQL stack will store unicode as UTF-8 encoded data in string fields, thus without using any unicode capabilities in the database. As described in http://docs.sqlalchemy.org/en/latest/dialects/mysql.html#mysql-unicode , set charset=utf8 to actually put unicode in the database. Existing databases that already store utf8 in the database should keep using the old url. This will only support 16 bit code points, but utf8mb4 will double the key size and make them too big for MySQL.

author	Mads Kiilerich <madski@unity3d.com>
date	Tue, 05 Jan 2016 16:30:11 +0100
parents	ed2fb6e84a02
children	2824cb8bcc0e

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

Mercurial > kallithea

annotate docs/api/api.rst @ 5619:6353b5e87091