Mercurial > kallithea

annotate docs/api/api.rst @ 7131:33bd2aa757dd

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
templates: mark site as IE10+ compatible to bypass Compatibility mode Internet Explorer 11 (and probably other versions) seems to ship with the setting "Display intranet sites in Compatibility View" enabled by default. This compatibility view means that modern elements of CSS and JavaScript are not (well) support and makes Kallithea look very bad and become unusable. This is a problem when hosting Kallithea in a corporate environment where its URL is detected as 'the intranet'. Solve the issue by explicitly marking Kallithea to be compatible with IE10, so that Internet Explorer 10 and above will show Kallithea correctly in Intranet environments.
author Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
date Tue, 30 Jan 2018 13:57:26 +0100
parents 19bc05bd8cf7
children caa482f8fb5f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
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
6543
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
12 API keys
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
13 --------
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
14
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
15 Every Kallithea user automatically receives an API key, which they can
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
16 view under "My Account". On this page, API keys can also be revoked, and
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
17 additional API keys can be generated.
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
18
9059da57b431 auth: improve API key documentation for users
Søren Løvborg <sorenl@unity3d.com>
parents: 6384
diff changeset
19
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4879
diff changeset
20 API access
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
21 ----------
1839
9da24750f563 docs update
Marcin Kuzminski <marcin@python-works.com>
parents: 1812
diff changeset
22
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
23 Clients must send JSON encoded JSON-RPC requests::
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
24
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
25 {
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
26 "id: "<id>",
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
27 "api_key": "<api_key>",
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
28 "method": "<method_name>",
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
29 "args": {"<arg_key>": "<arg_val>"}
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
30 }
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
31
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
32 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
33
5497
12b47803189f cleanup: use example.com for tests and examples
Søren Løvborg <sorenl@unity3d.com>
parents: 5496
diff changeset
34 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
35 --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
36
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
37 In general, provide
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
38 - *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
39 - *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
40 - *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
41 - *args*, the arguments to pass to the method.
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
42
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
43 .. note::
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
44
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
45 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
46
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
47 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
48
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
49 {
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
50 "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
51 "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
52 "error": null|<error_message> # JSON formatted error (null on success)
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
53 }
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
54
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
55 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
56 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
57 *result* will be null.
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
58
2379
7ac09514a178 created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents: 2378
diff changeset
59
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4879
diff changeset
60 API client
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
61 ----------
2379
7ac09514a178 created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents: 2378
diff changeset
62
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
63 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
64 way to call the JSON-RPC API.
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
65
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
66 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
67
5496
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
68 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
69
5496
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
70 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
71 Server response
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
72 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
73
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
74 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
75 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
76
5496
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
77 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
78
5496
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
79 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
80 Server response
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
81 {
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
82 "clone_uri": null,
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
83 "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
84 ...
2379
7ac09514a178 created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents: 2378
diff changeset
85
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
86 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
87
5496
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
88 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
89
5496
2b2216e8af36 docs: update example output and example server configs
Søren Løvborg <sorenl@unity3d.com>
parents: 5434
diff changeset
90 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
91 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
92
7ac09514a178 created rhodecode-api binary script for working with api via cli
Marcin Kuzminski <marcin@python-works.com>
parents: 2378
diff changeset
93
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4879
diff changeset
94 API methods
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
95 -----------
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
96
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
97
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
98 pull
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
99 ^^^^
1446
eab0cf9ab8bf API docs
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
100
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
101 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
102 remote repos up to date.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
103 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
104
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
105 INPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
106
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
107 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
108 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
109 method : "pull"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
110 args : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
111 "repoid" : "<reponame or repo_id>"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
112 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
113
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
114 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
115
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
116 id : <id_given_in_input>
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
117 result : "Pulled from `<reponame>`"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
118 error : null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
119
2697
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
120 rescan_repos
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
121 ^^^^^^^^^^^^
2697
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
122
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
123 Rescan repositories. If ``remove_obsolete`` is set,
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
124 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
125 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
126
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
127 INPUT::
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
128
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
129 id : <id_for_response>
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
130 api_key : "<api_key>"
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
131 method : "rescan_repos"
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
132 args : {
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
133 "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
134 }
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
135
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
136 OUTPUT::
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
137
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
138 id : <id_given_in_input>
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
139 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
140 '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
141 error : null
4565e655ea2a API: Added option to rescann repositories via api call
Marcin Kuzminski <marcin@python-works.com>
parents: 2531
diff changeset
142
3235
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
143 invalidate_cache
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
144 ^^^^^^^^^^^^^^^^
3235
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
145
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
146 Invalidate the cache for a repository.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
147 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
148 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
149
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
150 INPUT::
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
151
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
152 id : <id_for_response>
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
153 api_key : "<api_key>"
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
154 method : "invalidate_cache"
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
155 args : {
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
156 "repoid" : "<reponame or repo_id>"
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
157 }
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
158
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
159 OUTPUT::
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
160
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
161 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
162 result : "Caches of repository `<reponame>`"
3235
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
163 error : null
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
164
2737
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
165 lock
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
166 ^^^^
2737
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
167
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
168 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
169 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
170 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
171 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
172
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
173 INPUT::
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
174
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
175 id : <id_for_response>
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
176 api_key : "<api_key>"
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
177 method : "lock"
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
178 args : {
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
179 "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
180 "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
181 "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
182 }
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
183
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
184 OUTPUT::
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
185
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
186 id : <id_given_in_input>
3809
647fb653048e make the password optional in API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3808
diff changeset
187 result : {
3808
2feb58495f34 locking API returns objects instead of string messages.
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
188 "repo": "<reponame>",
2feb58495f34 locking API returns objects instead of string messages.
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
189 "locked": "<bool true|false>",
2feb58495f34 locking API returns objects instead of string messages.
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
190 "locked_since": "<float lock_time>",
2feb58495f34 locking API returns objects instead of string messages.
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
191 "locked_by": "<username>",
2feb58495f34 locking API returns objects instead of string messages.
Marcin Kuzminski <marcin@python-works.com>
parents: 3777
diff changeset
192 "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
193 }
2737
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
194 error : null
e21cb7b1a4a5 added API call for locking/unlocking repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2697
diff changeset
195
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
196 get_ip
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
197 ^^^^^^
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
198
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
199 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
200 defined IP addresses for given user.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
201 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
202
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
203 INPUT::
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
204
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
205 id : <id_for_response>
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
206 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
207 method : "get_ip"
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
208 args : {
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
209 "userid" : "<user_id or username>",
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
210 }
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
211
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
212 OUTPUT::
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
213
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
214 id : <id_given_in_input>
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
215 result : {
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
216 "ip_addr_server": <ip_from_clien>",
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
217 "user_ips": [
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
218 {
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
219 "ip_addr": "<ip_with_mask>",
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
220 "ip_range": ["<start_ip>", "<end_ip>"],
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
221 },
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 ]
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
224 }
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
225
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
226 error : null
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
227
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
228 get_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
229 ^^^^^^^^
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
230
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
231 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
232 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
233 Any userid can be specified when the command is executed using the api_key of a user with admin rights.
5866
379f36491789 spelling: specify
timeless@gmail.com
parents: 5781
diff changeset
234 Regular users can only specify their own userid.
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
235
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
236 INPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
237
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
238 id : <id_for_response>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
239 api_key : "<api_key>"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
240 method : "get_user"
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
241 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
242 "userid" : "<username or user_id Optional(=apiuser)>"
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
243 }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
244
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
245 OUTPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
246
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
247 id : <id_given_in_input>
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
248 result: None if user does not exist or
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
249 {
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
250 "user_id" : "<user_id>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
251 "api_key" : "<api_key>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
252 "username" : "<username>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
253 "firstname": "<firstname>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
254 "lastname" : "<lastname>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
255 "email" : "<email>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
256 "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
257 "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
258 "active" : "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
259 "admin" :  "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
260 "ldap_dn" : "<ldap_dn>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
261 "last_login": "<last_login>",
2151
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
262 "permissions": {
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
263 "global": ["hg.create.repository",
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
264 "repository.read",
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
265 "hg.register.manual_activate"],
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
266 "repositories": {"repo1": "repository.none"},
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
267 "repositories_groups": {"Group1": "group.read"}
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
268 },
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
269 }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
270 error: null
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
271
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
272 get_users
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
273 ^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
274
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
275 List all existing users.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
276 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
277
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
278 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
279
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
280 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
281 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
282 method : "get_users"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
283 args : { }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
284
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
285 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
286
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
287 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
288 result: [
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
289 {
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
290 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
291 "api_key" : "<api_key>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
292 "username" : "<username>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
293 "firstname": "<firstname>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
294 "lastname" : "<lastname>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
295 "email" : "<email>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
296 "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
297 "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
298 "active" : "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
299 "admin" :  "<bool>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
300 "ldap_dn" : "<ldap_dn>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
301 "last_login": "<last_login>",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
302 },
3267
7b74079beec9 coding style: fix trailing and leading spaces and tabs
Mads Kiilerich <madski@unity3d.com>
parents: 3235
diff changeset
303 …
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
304 ]
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
305 error: null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
306
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
307 .. _create-user:
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
308
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
309 create_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
310 ^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
311
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
312 Create new user.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
313 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
314
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
315 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
316
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
317 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
318 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
319 method : "create_user"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
320 args : {
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
321 "username" : "<username>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
322 "email" : "<useremail>",
3809
647fb653048e make the password optional in API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3808
diff changeset
323 "password" : "<password = Optional(None)>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
324 "firstname" : "<firstname> = Optional(None)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
325 "lastname" : "<lastname> = Optional(None)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
326 "active" : "<bool> = Optional(True)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
327 "admin" : "<bool> = Optional(False)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
328 "ldap_dn" : "<ldap_dn> = Optional(None)"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
329 }
1500
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
330
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
331 OUTPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
332
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
333 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
334 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
335 "msg" : "created new user `<username>`",
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
336 "user": {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
337 "user_id" : "<user_id>",
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
338 "username" : "<username>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
339 "firstname": "<firstname>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
340 "lastname" : "<lastname>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
341 "email" : "<email>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
342 "emails": "<list_of_all_additional_emails>",
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
343 "active" : "<bool>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
344 "admin" :  "<bool>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
345 "ldap_dn" : "<ldap_dn>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
346 "last_login": "<last_login>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
347 },
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
348 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
349 error: null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
350
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
351 Example::
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
352
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
353 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
354
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
355 update_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
356 ^^^^^^^^^^^
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
357
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
358 Update the given user if such user exists.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
359 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
360
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
361 INPUT::
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
362
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
363 id : <id_for_response>
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
364 api_key : "<api_key>"
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
365 method : "update_user"
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
366 args : {
2009
b63adad7c4af API updates
Marcin Kuzminski <marcin@python-works.com>
parents: 2006
diff changeset
367 "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
368 "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
369 "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
370 "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
371 "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
372 "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
373 "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
374 "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
375 "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
376 }
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
377
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
378 OUTPUT::
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
379
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
380 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
381 result: {
2507
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
382 "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
383 "user": {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
384 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
385 "api_key" : "<api_key>",
2507
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
386 "username" : "<username>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
387 "firstname": "<firstname>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
388 "lastname" : "<lastname>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
389 "email" : "<email>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
390 "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
391 "active" : "<bool>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
392 "admin" :  "<bool>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
393 "ldap_dn" : "<ldap_dn>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
394 "last_login": "<last_login>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
395 },
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
396 }
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
397 error: null
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
398
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
399 delete_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
400 ^^^^^^^^^^^
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
401
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
402 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
403 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
404
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
405 INPUT::
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
406
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
407 id : <id_for_response>
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
408 api_key : "<api_key>"
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
409 method : "delete_user"
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
410 args : {
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
411 "userid" : "<user_id or username>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
412 }
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
413
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
414 OUTPUT::
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
415
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
416 id : <id_given_in_input>
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
417 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
418 "msg" : "deleted user ID:<userid> <username>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
419 "user": null
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
420 }
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
421 error: null
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
422
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
423 get_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
424 ^^^^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
425
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
426 Get an existing user group.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
427 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
428
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
429 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
430
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
431 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
432 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
433 method : "get_user_group"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
434 args : {
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
435 "usergroupid" : "<user group id or name>"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
436 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
437
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
438 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
439
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
440 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
441 result : None if group not exist
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
442 {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
443 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
444 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
445 "active": "<bool>",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
446 "members" : [
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
447 {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
448 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
449 "api_key" : "<api_key>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
450 "username" : "<username>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
451 "firstname": "<firstname>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
452 "lastname" : "<lastname>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
453 "email" : "<email>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
454 "emails": "<list_of_all_additional_emails>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
455 "active" : "<bool>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
456 "admin" :  "<bool>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
457 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
458 "last_login": "<last_login>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
459 },
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
460 …
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
461 ]
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
462 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
463 error : null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
464
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
465 get_user_groups
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
466 ^^^^^^^^^^^^^^^
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
467
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
468 List all existing user groups.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
469 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
470
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
471 INPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
472
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
473 id : <id_for_response>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
474 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
475 method : "get_user_groups"
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
476 args : { }
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 OUTPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
479
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
480 id : <id_given_in_input>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
481 result : [
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
482 {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
483 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
484 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
485 "active": "<bool>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
486 },
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
487 …
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 error : null
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
490
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
491 create_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
492 ^^^^^^^^^^^^^^^^^
1500
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
493
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
494 Create a new user group.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
495 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
496
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
497 INPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
498
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
499 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
500 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
501 method : "create_user_group"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
502 args: {
3714
7e3d89d9d3a2 - Manage User’s Groups: create, delete, rename, add/remove users inside.
Marcin Kuzminski <marcin@python-works.com>
parents: 3641
diff changeset
503 "group_name": "<groupname>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
504 "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
505 "active": "<bool> = Optional(True)"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
506 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
507
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
508 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
509
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
510 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
511 result: {
3410
5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups"
Mads Kiilerich <madski@unity3d.com>
parents: 3267
diff changeset
512 "msg": "created new user group `<groupname>`",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
513 "users_group": {
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
514 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
515 "group_name" : "<groupname>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
516 "active": "<bool>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
517 },
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
518 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
519 error: null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
520
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
521 add_user_to_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
522 ^^^^^^^^^^^^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
523
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
524 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
525 ``false``.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
526 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
527
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
528 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
529
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
530 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
531 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
532 method : "add_user_user_group"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
533 args: {
3410
5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups"
Mads Kiilerich <madski@unity3d.com>
parents: 3267
diff changeset
534 "usersgroupid" : "<user group id or name>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
535 "userid" : "<user_id or username>",
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
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
538 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
539
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
540 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
541 result: {
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
542 "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
543 "msg": "added member `<username>` to a user group `<groupname>` |
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
544 User is already in that group"
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
545 }
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
546 error: null
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
547
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
548 remove_user_from_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
549 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
550
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
551 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
552 be ``false``.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
553 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
554
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
555 INPUT::
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
556
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
557 id : <id_for_response>
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
558 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
559 method : "remove_user_from_user_group"
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
560 args: {
3410
5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups"
Mads Kiilerich <madski@unity3d.com>
parents: 3267
diff changeset
561 "usersgroupid" : "<user group id or name>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
562 "userid" : "<user_id or username>",
1989
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
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
565 OUTPUT::
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
566
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
567 id : <id_given_in_input>
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
568 result: {
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
569 "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
570 "msg": "removed member <username> from user group <groupname> |
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
571 User wasn't in group"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
572 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
573 error: null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
574
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
575 get_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
576 ^^^^^^^^
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
577
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
578 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
579 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
580 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
581 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
582
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
583 INPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
584
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
585 id : <id_for_response>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
586 api_key : "<api_key>"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
587 method : "get_repo"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
588 args: {
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
589 "repoid" : "<reponame or repo_id>",
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
590 "with_revision_names": "<bool> = Optional(False)",
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
591 "with_pullrequests": "<bool> = Optional(False)",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
592 }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
593
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
594 OUTPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
595
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
596 id : <id_given_in_input>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
597 result: None if repository does not exist or
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
598 {
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
599 "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
600 "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
601 "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
602 "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
603 "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
604 "enable_locking": "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
605 "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
606 "private": "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
607 "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
608 "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
609 "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
610 "last_changeset": {
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
611 "author": "<full_author>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
612 "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
613 "message": "<commit_message>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
614 "raw_id": "<raw_id>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
615 "revision": "<numeric_revision>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
616 "short_id": "<short_id>"
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
617 },
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
618 "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
619 "fork_of": "<name_of_fork_parent>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
620 "members" : [
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
621 {
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
622 "type": "user",
3174
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
623 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
624 "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
625 "username" : "<username>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
626 "firstname": "<firstname>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
627 "lastname" : "<lastname>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
628 "email" : "<email>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
629 "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
630 "active" : "<bool>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
631 "admin" :  "<bool>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
632 "ldap_dn" : "<ldap_dn>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
633 "last_login": "<last_login>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
634 "permission" : "repository.(read|write|admin)"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
635 },
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
636 …
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": "users_group",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
639 "id" : "<usersgroupid>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
640 "name" : "<usersgroupname>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
641 "active": "<bool>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
642 "permission" : "repository.(read|write|admin)"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
643 },
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
644 …
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
645 ],
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
646 "followers": [
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
647 {
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
648 "user_id" : "<user_id>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
649 "username" : "<username>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
650 "api_key" : "<api_key>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
651 "firstname": "<firstname>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
652 "lastname" : "<lastname>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
653 "email" : "<email>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
654 "emails": "<list_of_all_additional_emails>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
655 "ip_addresses": "<list_of_ip_addresses_for_user>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
656 "active" : "<bool>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
657 "admin" :  "<bool>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
658 "ldap_dn" : "<ldap_dn>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
659 "last_login": "<last_login>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
660 },
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
661 …
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
662 ],
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
663 <if with_revision_names == True>
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
664 "tags": {
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
665 "<tagname>": "<raw_id>",
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
666 ...
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
667 },
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
668 "branches": {
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
669 "<branchname>": "<raw_id>",
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
670 ...
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
671 },
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
672 "bookmarks": {
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
673 "<bookmarkname>": "<raw_id>",
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
674 ...
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
675 },
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
676 <if with_pullrequests == True>
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
677 "pull_requests": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
678 {
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
679 "status": "<pull_request_status>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
680 "pull_request_id": <pull_request_id>,
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
681 "description": "<pull_request_description>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
682 "title": "<pull_request_title>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
683 "url": "<pull_request_url>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
684 "reviewers": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
685 {
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
686 "username": "<user_id>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
687 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
688 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
689 ],
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
690 "org_repo_url": "<repo_url>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
691 "org_ref_parts": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
692 "<ref_type>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
693 "<ref_name>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
694 "<raw_id>"
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
695 ],
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
696 "other_ref_parts": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
697 "<ref_type>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
698 "<ref_name>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
699 "<raw_id>"
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
700 ],
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
701 "comments": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
702 {
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
703 "username": "<user_id>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
704 "text": "<comment text>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
705 "comment_id": "<comment_id>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
706 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
707 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
708 ],
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
709 "owner": "<username>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
710 "statuses": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
711 {
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
712 "status": "<status_of_review>", # "under_review", "approved" or "rejected"
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
713 "reviewer": "<user_id>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
714 "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
715 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
716 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
717 ],
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
718 "revisions": [
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
719 "<raw_id>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
720 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
721 ]
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
722 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
723 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
724 ]
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
725 }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
726 error: null
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
727
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
728 get_repos
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
729 ^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
730
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
731 List all existing repositories.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
732 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
733 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
734
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
735 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
736
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
737 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
738 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
739 method : "get_repos"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
740 args: { }
1500
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
741
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
742 OUTPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
743
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
744 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
745 result: [
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
746 {
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
747 "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
748 "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
749 "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
750 "clone_uri" : "<clone_uri>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
751 "private" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
752 "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
753 "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
754 "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
755 "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
756 "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
757 "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
758 "enable_locking": "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
759 "enable_statistics": "<bool>",
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 …
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
762 ]
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
763 error: null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
764
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
765 get_repo_nodes
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
766 ^^^^^^^^^^^^^^
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
767
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
768 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
769 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
770 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
771
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
772 INPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
773
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
774 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
775 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
776 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
777 args: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
778 "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
779 "revision" : "<revision>",
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
780 "root_path" : "<root_path>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
781 "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
782 }
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
783
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
784 OUTPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
785
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
786 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
787 result: [
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
788 {
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
789 "name" : "<name>"
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
790 "type" : "<type>",
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
791 },
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
792 …
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
793 ]
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
794 error: null
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
795
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
796 create_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
797 ^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
798
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
799 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
800 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
801 "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
802 "bar" as group.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
803 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
804 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
805 Regular users cannot specify owner parameter.
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
806
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
807 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
808
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
809 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
810 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
811 method : "create_repo"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
812 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
813 "repo_name" : "<reponame>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
814 "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
815 "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
816 "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
817 "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
818 "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
819 "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
820 "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
821 "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
822 "enable_statistics": "<bool> = Optional(False)",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
823 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
824
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
825 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
826
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
827 id : <id_given_in_input>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
828 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
829 "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
830 "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
831 "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
832 "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
833 "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
834 "clone_uri" : "<clone_uri>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
835 "private" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
836 "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
837 "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
838 "landing_rev": "<landing_rev>",
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
839 "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
840 "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
841 "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
842 "enable_locking": "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
843 "enable_statistics": "<bool>",
2378
04ef27ce939e API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents: 2365
diff changeset
844 },
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
845 }
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
846 error: null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
847
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
848 update_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
849 ^^^^^^^^^^^
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
850
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
851 Update a repository.
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
852 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
853 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
854 Regular users cannot specify owner parameter.
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 INPUT::
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
857
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
858 id : <id_for_response>
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
859 api_key : "<api_key>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
860 method : "update_repo"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
861 args: {
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
862 "repoid" : "<reponame or repo_id>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
863 "name" : "<reponame> = Optional('')",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
864 "group" : "<group_id> = Optional(None)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
865 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
866 "description" : "<description> = Optional('')",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
867 "private" : "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
868 "clone_uri" : "<clone_uri> = Optional(None)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
869 "landing_rev" : "<landing_rev> = Optional('tip')",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
870 "enable_downloads": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
871 "enable_locking": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
872 "enable_statistics": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
873 }
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
874
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
875 OUTPUT::
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
876
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
877 id : <id_given_in_input>
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
878 result: {
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
879 "msg": "updated repo ID:repo_id `<reponame>`",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
880 "repository": {
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
881 "repo_id" : "<repo_id>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
882 "repo_name" : "<reponame>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
883 "repo_type" : "<repo_type>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
884 "clone_uri" : "<clone_uri>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
885 "private": "<bool>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
886 "created_on" : "<datetimecreated>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
887 "description" : "<description>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
888 "landing_rev": "<landing_rev>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
889 "owner": "<username or user_id>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
890 "fork_of": "<name_of_fork_parent>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
891 "enable_downloads": "<bool>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
892 "enable_locking": "<bool>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
893 "enable_statistics": "<bool>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
894 "last_changeset": {
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
895 "author": "<full_author>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
896 "date": "<date_time_of_commit>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
897 "message": "<commit_message>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
898 "raw_id": "<raw_id>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
899 "revision": "<numeric_revision>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
900 "short_id": "<short_id>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
901 }
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
902 "locked_by": "<username>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
903 "locked_date": "<float lock_time>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
904 },
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
905 }
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
906 error: null
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
907
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
908 fork_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
909 ^^^^^^^^^
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
910
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
911 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
912 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
913 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
914 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
915 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
916 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
917 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
918
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
919 INPUT::
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
920
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
921 id : <id_for_response>
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
922 api_key : "<api_key>"
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
923 method : "fork_repo"
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
924 args: {
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
925 "repoid" : "<reponame or repo_id>",
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
926 "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
927 "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
928 "description": "<description>",
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
929 "copy_permissions": "<bool>",
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
930 "private": "<bool>",
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
931 "landing_rev": "<landing_rev>"
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
932
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
933 }
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
934
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
935 OUTPUT::
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
936
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
937 id : <id_given_in_input>
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
938 result: {
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
939 "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
940 "success": true
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
941 }
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
942 error: null
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
943
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
944 delete_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
945 ^^^^^^^^^^^
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
946
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
947 Delete a repository.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
948 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
949 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
950 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
951
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
952 INPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
953
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
954 id : <id_for_response>
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
955 api_key : "<api_key>"
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
956 method : "delete_repo"
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
957 args: {
3641
b44979649915 recursive forks detach
Marcin Kuzminski <marcin@python-works.com>
parents: 3457
diff changeset
958 "repoid" : "<reponame or repo_id>",
b44979649915 recursive forks detach
Marcin Kuzminski <marcin@python-works.com>
parents: 3457
diff changeset
959 "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
960 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
961
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
962 OUTPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
963
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
964 id : <id_given_in_input>
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
965 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
966 "msg": "Deleted repository `<reponame>`",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
967 "success": true
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
968 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
969 error: null
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
970
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
971 grant_user_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
972 ^^^^^^^^^^^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
973
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
974 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
975 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
976
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
977 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
978
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
979 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
980 api_key : "<api_key>"
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
981 method : "grant_user_permission"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
982 args: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
983 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
984 "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
985 "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
986 }
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
987
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
988 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
989
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
990 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
991 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
992 "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
993 "success": true
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
994 }
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
995 error: null
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
996
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
997 revoke_user_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
998 ^^^^^^^^^^^^^^^^^^^^^^
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
999
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
1000 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
1001 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
1002
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1003 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1004
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
1005 id : <id_for_response>
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1006 api_key : "<api_key>"
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1007 method : "revoke_user_permission"
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1008 args: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1009 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1010 "userid" : "<username or user_id>"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
1011 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
1012
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
1013 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
1014
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1015 id : <id_given_in_input>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1016 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1017 "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
1018 "success": true
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1019 }
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
1020 error: null
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
1021
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
1022 grant_user_group_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
1023 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
1024
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
1025 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
1026 existing one if found.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
1027 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
1028
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
1029 INPUT::
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
1030
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
1031 id : <id_for_response>
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
1032 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
1033 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
1034 args: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1035 "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
1036 "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
1037 "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
1038 }
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1039
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1040 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1041
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1042 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
1043 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1044 "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
1045 "success": true
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1046 }
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1047 error: null
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
1048
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
1049 revoke_user_group_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
1050 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1051
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
1052 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
1053 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
1054
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1055 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1056
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
1057 id : <id_for_response>
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1058 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
1059 method : "revoke_user_group_permission"
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
1060 args: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1061 "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
1062 "usersgroupid" : "<user group id or name>"
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1063 }
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1064
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1065 OUTPUT::
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1066
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1067 id : <id_given_in_input>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1068 result: {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1069 "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
1070 "success": true
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1071 }
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
1072 error: null
5781
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1073
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1074 get_changesets
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1075 ^^^^^^^^^^^^^^
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1076
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1077 Get changesets of a given repository. This command can only be executed using the api_key
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1078 of a user with read permissions to the repository.
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1079
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1080 INPUT::
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1081
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1082 id : <id_for_response>
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1083 api_key : "<api_key>"
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1084 method : "get_changesets"
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1085 args: {
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1086 "repoid" : "<reponame or repo_id>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1087 "start": "<revision number> = Optional(None)",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1088 "end": "<revision number> = Optional(None)",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1089 "start_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1090 "end_date": "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1091 "branch_name": "<branch name filter> = Optional(None)",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1092 "reverse": "<bool> = Optional(False)",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1093 "with_file_list": "<bool> = Optional(False)"
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1094 }
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1095
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1096 OUTPUT::
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1097
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1098 id : <id_given_in_input>
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1099 result: [
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1100 {
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1101 "raw_id": "<raw_id>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1102 "short_id": "short_id": "<short_id>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1103 "author": "<full_author>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1104 "date": "<date_time_of_commit>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1105 "message": "<commit_message>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1106 "revision": "<numeric_revision>",
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1107 <if with_file_list == True>
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1108 "added": [<list of added files>],
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1109 "changed": [<list of changed files>],
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1110 "removed": [<list of removed files>]
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1111 },
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1112 ...
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1113 ]
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1114 error: null
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1115
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1116 get_changeset
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1117 ^^^^^^^^^^^^^
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1118
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1119 Get information and review status for a given changeset. This command can only
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1120 be executed using the api_key of a user with read permissions to the
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1121 repository.
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1122
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1123 INPUT::
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1124
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1125 id : <id_for_response>
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1126 api_key : "<api_key>"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1127 method : "get_changeset"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1128 args: {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1129 "repoid" : "<reponame or repo_id>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1130 "raw_id" : "<raw_id>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1131 "with_reviews": "<bool> = Optional(False)"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1132 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1133
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1134 OUTPUT::
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1135
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1136 id : <id_given_in_input>
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1137 result: {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1138 "author": "<full_author>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1139 "date": "<date_time_of_commit>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1140 "message": "<commit_message>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1141 "raw_id": "<raw_id>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1142 "revision": "<numeric_revision>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1143 "short_id": "<short_id>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1144 "reviews": [{
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1145 "reviewer": "<username>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1146 "modified_at": "<date_time_of_review>", # iso 8601 date, server's timezone
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1147 "status": "<status_of_review>", # "under_review", "approved" or "rejected"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1148 },
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1149 ...
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1150 ]
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1151 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1152 error: null
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1153
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1154 Example output::
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1155
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1156 {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1157 "id" : 1,
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1158 "error" : null,
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1159 "result" : {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1160 "author" : {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1161 "email" : "user@example.com",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1162 "name" : "Kallithea Admin"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1163 },
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1164 "changed" : [],
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1165 "short_id" : "e1022d3d28df",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1166 "date" : "2017-03-28T09:09:03",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1167 "added" : [
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1168 "README.rst"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1169 ],
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1170 "removed" : [],
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1171 "revision" : 0,
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1172 "raw_id" : "e1022d3d28dfba02f626cde65dbe08f4ceb0e4e7",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1173 "message" : "Added file via Kallithea",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1174 "id" : "e1022d3d28dfba02f626cde65dbe08f4ceb0e4e7",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1175 "reviews" : [
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1176 {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1177 "status" : "under_review",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1178 "modified_at" : "2017-03-28T09:17:08.618",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1179 "reviewer" : "user"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1180 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1181 ]
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1182 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1183 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1184
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1185 get_pullrequest
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1186 ^^^^^^^^^^^^^^^
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1187
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1188 Get information and review status for a given pull request. This command can only be executed
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1189 using the api_key of a user with read permissions to the original repository.
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1190
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1191 INPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1192
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1193 id : <id_for_response>
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1194 api_key : "<api_key>"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1195 method : "get_pullrequest"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1196 args: {
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1197 "pullrequest_id" : "<pullrequest_id>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1198 }
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1199
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1200 OUTPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1201
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1202 id : <id_given_in_input>
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1203 result: {
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1204 "status": "<pull_request_status>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1205 "pull_request_id": <pull_request_id>,
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1206 "description": "<pull_request_description>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1207 "title": "<pull_request_title>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1208 "url": "<pull_request_url>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1209 "reviewers": [
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1210 {
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1211 "username": "<user_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1212 },
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1213 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1214 ],
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1215 "org_repo_url": "<repo_url>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1216 "org_ref_parts": [
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1217 "<ref_type>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1218 "<ref_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1219 "<raw_id>"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1220 ],
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1221 "other_ref_parts": [
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1222 "<ref_type>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1223 "<ref_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1224 "<raw_id>"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1225 ],
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1226 "comments": [
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1227 {
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1228 "username": "<user_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1229 "text": "<comment text>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1230 "comment_id": "<comment_id>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1231 },
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1232 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1233 ],
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1234 "owner": "<username>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1235 "statuses": [
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1236 {
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1237 "status": "<status_of_review>", # "under_review", "approved" or "rejected"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1238 "reviewer": "<user_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1239 "modified_at": "<date_time_of_review>" # iso 8601 date, server's timezone
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1240 },
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1241 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1242 ],
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1243 "revisions": [
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1244 "<raw_id>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1245 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1246 ]
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1247 },
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1248 error: null
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1249
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1250 comment_pullrequest
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1251 ^^^^^^^^^^^^^^^^^^^
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1252
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1253 Add comment, change status or close a given pull request. This command can only be executed
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1254 using the api_key of a user with read permissions to the original repository.
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1255
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1256 INPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1257
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1258 id : <id_for_response>
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1259 api_key : "<api_key>"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1260 method : "comment_pullrequest"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1261 args: {
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1262 "pull_request_id": "<pull_request_id>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1263 "comment_msg": Optional(''),
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1264 "status": Optional(None), # "under_review", "approved" or "rejected"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1265 "close_pr": Optional(False)",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1266 }
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1267
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1268 OUTPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1269
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1270 id : <id_given_in_input>
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1271 result: True
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1272 error: null
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1273
5781
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1274
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1275 API access for web views
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1276 ------------------------
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1277
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1278 API access can also be turned on for each web view in Kallithea that is
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1279 decorated with the ``@LoginRequired`` decorator. Some views use
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1280 ``@LoginRequired(api_access=True)`` and are always available. By default only
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1281 RSS/Atom feed views are enabled. Other views are
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1282 only available if they have been whitelisted. Edit the
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1283 ``api_access_controllers_whitelist`` option in your .ini file and define views
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1284 that should have API access enabled.
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1285
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1286 For example, to enable API access to patch/diff, raw file and archive::
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1287
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1288 api_access_controllers_whitelist =
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1289 ChangesetController:changeset_patch,
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1290 ChangesetController:changeset_raw,
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1291 FilesController:raw,
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1292 FilesController:archivefile
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1293
6384
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1294 After this change, a Kallithea view can be accessed without login using
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1295 bearer authentication, by including this header with the request::
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1296
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1297 Authentication: Bearer <api_key>
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1298
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1299 Alternatively, the API key can be passed in the URL query string using
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1300 ``?api_key=<api_key>``, though this is not recommended due to the increased
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1301 risk of API key leaks, and support will likely be removed in the future.
5781
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1302
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1303 Exposing raw diffs is a good way to integrate with
2824cb8bcc0e docs: make 'API access for web views' less prominent - the official API should come first
Mads Kiilerich <madski@unity3d.com>
parents: 5575
diff changeset
1304 third-party services like code review, or build farms that can download archives.