Mercurial > kallithea

annotate docs/api/api.rst @ 8936:ac5525c48f0a stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
api docs: more consistent use of space around ":" in examples The examples are informal pseudo code - not json and not python. But let's try to be consistent anyway.
author Mads Kiilerich <mads@kiilerich.com>
date Fri, 14 Oct 2022 14:25:12 +0200
parents ba64339f7937
children 2dd317e9cc4b
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 --------
3769
6a820dcbcb99 update docs about the API access whitelist option
Marcin Kuzminski <marcin@python-works.com>
parents: 3759
diff changeset
14
6543
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.
1812
320dec24fb9a Added instruction on enabling the API access to web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1810
diff changeset
18
320dec24fb9a Added instruction on enabling the API access to web views
Marcin Kuzminski <marcin@python-works.com>
parents: 1810
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' \
7890
ae155f6a99ad docs: fix curl example
Mads Kiilerich <mads@kiilerich.com>
parents: 7692
diff changeset
35 --data-binary '{"id":1,"api_key":"xe7cdb2v278e4evbdf5vs04v832v0efvcbcve4a3","method":"pull","args":{"repoid":"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>`"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
118 error : null
1592
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>]}"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
141 error : null
2697
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>`"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
163 error : null
3235
d6029dacbcc4 API invalidate_cache function ref #733
Marcin Kuzminski <marcin@python-works.com>
parents: 3224
diff changeset
164
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
165 get_ip
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
166 ^^^^^^
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
167
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
168 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
169 defined IP addresses for given user.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
170 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
171
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
172 INPUT::
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
173
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
174 id : <id_for_response>
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
175 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
176 method : "get_ip"
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
177 args : {
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
178 "userid" : "<user_id or username>",
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
179 }
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
180
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
181 OUTPUT::
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
182
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
183 id : <id_given_in_input>
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
184 result : {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
185 "ip_addr_server" : <ip_from_client>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
186 "user_ips" : [
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
187 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
188 "ip_addr" : "<ip_with_mask>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
189 "ip_range" : ["<start_ip>", "<end_ip>"],
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
190 },
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
191 ...
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
192 ]
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
193 }
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
194 error : null
3126
703070153bc1 added API method for checking IP
Marcin Kuzminski <marcin@python-works.com>
parents: 3122
diff changeset
195
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
196 get_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
197 ^^^^^^^^
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
198
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
199 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
200 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
201 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
202 Regular users can only specify their own userid.
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
203
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
204 INPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
205
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
206 id : <id_for_response>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
207 api_key : "<api_key>"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
208 method : "get_user"
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
209 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
210 "userid" : "<username or user_id Optional(=apiuser)>"
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
211 }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
212
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
213 OUTPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
214
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
215 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
216 result : None if user does not exist or
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
217 {
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
218 "user_id" : "<user_id>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
219 "api_key" : "<api_key>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
220 "username" : "<username>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
221 "firstname" : "<firstname>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
222 "lastname" : "<lastname>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
223 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
224 "emails" : "<list_of_all_additional_emails>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
225 "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
226 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
227 "admin" : "<bool>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
228 "ldap_dn" : "<ldap_dn>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
229 "last_login" : "<last_login>",
2151
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
230 "permissions": {
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
231 "global": ["hg.create.repository",
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
232 "repository.read",
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
233 "hg.register.manual_activate"],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
234 "repositories" : {"repo1" : "repository.none"},
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
235 "repositories_groups" : {"Group1" : "group.read"}
2151
12ceeda33339 #404 API extensions for showing permission for users
Marcin Kuzminski <marcin@python-works.com>
parents: 2146
diff changeset
236 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
237 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
238 error : null
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
239
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
240 get_users
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
241 ^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
242
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
243 List all existing users.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
244 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
245
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
246 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
247
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
248 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
249 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
250 method : "get_users"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
251 args : { }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
252
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
253 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
254
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
255 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
256 result : [
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
257 {
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
258 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
259 "api_key" : "<api_key>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
260 "username" : "<username>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
261 "firstname" : "<firstname>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
262 "lastname" : "<lastname>",
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
263 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
264 "emails" : "<list_of_all_additional_emails>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
265 "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
266 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
267 "admin" : "<bool>",
3127
71ce052f8b6b add ipaddresses to repo data on API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3126
diff changeset
268 "ldap_dn" : "<ldap_dn>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
269 "last_login" : "<last_login>",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
270 },
3267
7b74079beec9 coding style: fix trailing and leading spaces and tabs
Mads Kiilerich <madski@unity3d.com>
parents: 3235
diff changeset
271 …
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
272 ]
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
273 error : null
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
274
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
275 .. _create-user:
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
276
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
277 create_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
278 ^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
279
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
280 Create new user.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
281 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
282
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
283 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
284
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
285 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
286 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
287 method : "create_user"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
288 args : {
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
289 "username" : "<username>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
290 "email" : "<useremail>",
3809
647fb653048e make the password optional in API calls
Marcin Kuzminski <marcin@python-works.com>
parents: 3808
diff changeset
291 "password" : "<password = Optional(None)>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
292 "firstname" : "<firstname> = Optional(None)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
293 "lastname" : "<lastname> = Optional(None)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
294 "active" : "<bool> = Optional(True)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
295 "admin" : "<bool> = Optional(False)",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
296 "ldap_dn" : "<ldap_dn> = Optional(None)"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
297 }
1500
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
298
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
299 OUTPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
300
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
301 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
302 result : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
303 "msg" : "created new user `<username>`",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
304 "user" : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
305 "user_id" : "<user_id>",
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
306 "username" : "<username>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
307 "firstname": "<firstname>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
308 "lastname" : "<lastname>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
309 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
310 "emails" : "<list_of_all_additional_emails>",
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
311 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
312 "admin" : "<bool>",
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
313 "ldap_dn" : "<ldap_dn>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
314 "last_login": "<last_login>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
315 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
316 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
317 error : null
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
318
5425
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
319 Example::
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
320
5ae8e644aa88 docs: spelling, grammar, content and typography
Søren Løvborg <sorenl@unity3d.com>
parents: 5274
diff changeset
321 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
322
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
323 update_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
324 ^^^^^^^^^^^
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
325
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
326 Update the given user if such user exists.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
327 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
328
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
329 INPUT::
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
330
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
331 id : <id_for_response>
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
332 api_key : "<api_key>"
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
333 method : "update_user"
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
334 args : {
2009
b63adad7c4af API updates
Marcin Kuzminski <marcin@python-works.com>
parents: 2006
diff changeset
335 "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
336 "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
337 "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
338 "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
339 "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
340 "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
341 "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
342 "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
343 "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
344 }
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
345
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
346 OUTPUT::
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
347
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
348 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
349 result : {
2507
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
350 "msg" : "updated user ID:<userid> <username>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
351 "user" : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
352 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
353 "api_key" : "<api_key>",
2507
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
354 "username" : "<username>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
355 "firstname": "<firstname>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
356 "lastname" : "<lastname>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
357 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
358 "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
359 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
360 "admin" : "<bool>",
2507
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
361 "ldap_dn" : "<ldap_dn>",
374693af2849 API: update_user returns new updated user data
Marcin Kuzminski <marcin@python-works.com>
parents: 2506
diff changeset
362 "last_login": "<last_login>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
363 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
364 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
365 error : null
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
366
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
367 delete_user
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
368 ^^^^^^^^^^^
2365
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
369
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
370 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
371 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
372
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
373 INPUT::
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
374
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
375 id : <id_for_response>
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
376 api_key : "<api_key>"
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
377 method : "delete_user"
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
378 args : {
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
379 "userid" : "<user_id or username>",
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
380 }
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
381
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
382 OUTPUT::
b902baeaa494 API, added delete_user method.
Marcin Kuzminski <marcin@python-works.com>
parents: 2338
diff changeset
383
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
384 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
385 result : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
386 "msg" : "deleted user ID:<userid> <username>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
387 "user" : null
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
388 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
389 error : null
2002
bdc0ad168006 API added explicit method for updating user account
Marcin Kuzminski <marcin@python-works.com>
parents: 1989
diff changeset
390
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
391 get_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
392 ^^^^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
393
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
394 Get an existing user group.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
395 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
396
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
397 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
398
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
399 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
400 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
401 method : "get_user_group"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
402 args : {
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
403 "usergroupid" : "<user group id or name>"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
404 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
405
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
406 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
407
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
408 id : <id_given_in_input>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
409 result : None if group not exist
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
410 {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
411 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
412 "group_name" : "<groupname>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
413 "active" : "<bool>",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
414 "members" : [
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
415 {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
416 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
417 "api_key" : "<api_key>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
418 "username" : "<username>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
419 "firstname": "<firstname>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
420 "lastname" : "<lastname>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
421 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
422 "emails" : "<list_of_all_additional_emails>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
423 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
424 "admin" : "<bool>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
425 "ldap_dn" : "<ldap_dn>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
426 "last_login": "<last_login>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
427 },
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
428 …
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
429 ]
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
430 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
431 error : null
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
432
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
433 get_user_groups
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
434 ^^^^^^^^^^^^^^^
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
435
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
436 List all existing user groups.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
437 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
438
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
439 INPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
440
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
441 id : <id_for_response>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
442 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
443 method : "get_user_groups"
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
444 args : { }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
445
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
446 OUTPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
447
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
448 id : <id_given_in_input>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
449 result : [
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
450 {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
451 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
452 "group_name" : "<groupname>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
453 "active" : "<bool>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
454 },
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
455 …
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
456 ]
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
457 error : null
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
458
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
459 create_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
460 ^^^^^^^^^^^^^^^^^
1500
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
461
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
462 Create a new user group.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
463 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
464
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
465 INPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
466
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
467 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
468 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
469 method : "create_user_group"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
470 args : {
3714
7e3d89d9d3a2 - Manage User’s Groups: create, delete, rename, add/remove users inside.
Marcin Kuzminski <marcin@python-works.com>
parents: 3641
diff changeset
471 "group_name": "<groupname>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
472 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
473 "active" : "<bool> = Optional(True)"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
474 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
475
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
476 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
477
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
478 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
479 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
480 "msg" : "created new user group `<groupname>`",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
481 "users_group" : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
482 "users_group_id" : "<id>",
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
483 "group_name" : "<groupname>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
484 "active" : "<bool>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
485 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
486 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
487 error : null
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
488
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
489 add_user_to_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
490 ^^^^^^^^^^^^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
491
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
492 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
493 ``false``.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
494 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
495
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
496 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
497
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
498 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
499 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
500 method : "add_user_user_group"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
501 args : {
3410
5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups"
Mads Kiilerich <madski@unity3d.com>
parents: 3267
diff changeset
502 "usersgroupid" : "<user group id or name>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
503 "userid" : "<user_id or username>",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
504 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
505
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
506 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
507
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
508 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
509 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
510 "success" : True|False # depends on if member is in group
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
511 "msg" : "added member `<username>` to a user group `<groupname>` |
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
512 User is already in that group"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
513 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
514 error : null
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
515
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
516 remove_user_from_user_group
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
517 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
518
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
519 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
520 be ``false``.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
521 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
522
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
523 INPUT::
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
524
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
525 id : <id_for_response>
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
526 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
527 method : "remove_user_from_user_group"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
528 args : {
3410
5f1850e4712a "Users groups" is grammatically incorrect English - rename to "user groups"
Mads Kiilerich <madski@unity3d.com>
parents: 3267
diff changeset
529 "usersgroupid" : "<user group id or name>",
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
530 "userid" : "<user_id or username>",
1989
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
531 }
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
532
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
533 OUTPUT::
0f87c784756e API changes
Marcin Kuzminski <marcin@python-works.com>
parents: 1982
diff changeset
534
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
535 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
536 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
537 "success" : True|False, # depends on if member is in group
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
538 "msg" : "removed member <username> from user group <groupname> |
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
539 User wasn't in group"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
540 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
541 error : null
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
542
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
543 get_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
544 ^^^^^^^^
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
545
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
546 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
547 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
548 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
549 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
550
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
551 INPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
552
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
553 id : <id_for_response>
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
554 api_key : "<api_key>"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
555 method : "get_repo"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
556 args : {
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
557 "repoid" : "<reponame or repo_id>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
558 "with_revision_names" : "<bool> = Optional(False)",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
559 "with_pullrequests" : "<bool> = Optional(False)",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
560 }
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
561
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
562 OUTPUT::
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
563
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
564 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
565 result : None if repository does not exist or
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
566 {
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
567 "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
568 "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
569 "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
570 "clone_uri" : "<clone_uri>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
571 "enable_downloads" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
572 "enable_statistics": "<bool>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
573 "private" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
574 "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
575 "description" : "<description>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
576 "landing_rev" : "<landing_rev>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
577 "last_changeset" : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
578 "author" : "<full_author>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
579 "date" : "<date_time_of_commit>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
580 "message" : "<commit_message>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
581 "raw_id" : "<raw_id>",
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
582 "revision": "<numeric_revision>",
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
583 "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
584 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
585 "owner" : "<repo_owner>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
586 "fork_of" : "<name_of_fork_parent>",
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
587 "members" : [
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
588 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
589 "type" : "user",
3174
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
590 "user_id" : "<user_id>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
591 "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
592 "username" : "<username>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
593 "firstname" : "<firstname>",
3174
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
594 "lastname" : "<lastname>",
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
595 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
596 "emails" : "<list_of_all_additional_emails>",
3174
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
597 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
598 "admin" : "<bool>",
3174
37c0ac5fe42f added last_changeset information in get_repo API function
Marcin Kuzminski <marcin@python-works.com>
parents: 3163
diff changeset
599 "ldap_dn" : "<ldap_dn>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
600 "last_login" : "<last_login>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
601 "permission" : "repository.(read|write|admin)"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
602 },
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
603 …
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
604 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
605 "type" : "users_group",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
606 "id" : "<usersgroupid>",
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
607 "name" : "<usersgroupname>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
608 "active" : "<bool>",
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
609 "permission" : "repository.(read|write|admin)"
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
610 },
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
611 …
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
612 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
613 "followers" : [
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
614 {
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
615 "user_id" : "<user_id>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
616 "username" : "<username>",
3940
3a608d72a86f api.rst edited online with Bitbucket
Ton Plomp <tcplomp@gmail.com>
parents: 3809
diff changeset
617 "api_key" : "<api_key>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
618 "firstname" : "<firstname>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
619 "lastname" : "<lastname>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
620 "email" : "<email>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
621 "emails" : "<list_of_all_additional_emails>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
622 "ip_addresses": "<list_of_ip_addresses_for_user>",
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
623 "active" : "<bool>",
8933
379392017b6e api docs: various minor changes
Mads Kiilerich <mads@kiilerich.com>
parents: 7890
diff changeset
624 "admin" : "<bool>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
625 "ldap_dn" : "<ldap_dn>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
626 "last_login" : "<last_login>",
3213
f5dcee2b3153 updated api docs
Marcin Kuzminski <marcin@python-works.com>
parents: 3174
diff changeset
627 },
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
628 …
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
629 ],
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
630 <if with_revision_names == True>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
631 "tags" : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
632 "<tagname>" : "<raw_id>",
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
633 ...
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
634 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
635 "branches" : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
636 "<branchname>" : "<raw_id>",
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
637 ...
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
638 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
639 "bookmarks" : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
640 "<bookmarkname>" : "<raw_id>",
6653
98d26beb0965 api: add optional branches, tags and bookmarks information to get_repo API data
domruf <dominikruf@gmail.com>
parents: 6652
diff changeset
641 ...
8935
ba64339f7937 api docs: make examples more like 4 space indented
Mads Kiilerich <mads@kiilerich.com>
parents: 8934
diff changeset
642 },
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
643 <if with_pullrequests == True>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
644 "pull_requests" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
645 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
646 "status" : "<pull_request_status>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
647 "pull_request_id" : <pull_request_id>,
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
648 "description" : "<pull_request_description>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
649 "title" : "<pull_request_title>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
650 "url" : "<pull_request_url>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
651 "reviewers" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
652 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
653 "username" : "<user_id>",
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
654 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
655 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
656 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
657 "org_repo_url" : "<repo_url>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
658 "org_ref_parts" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
659 "<ref_type>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
660 "<ref_name>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
661 "<raw_id>"
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
662 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
663 "other_ref_parts" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
664 "<ref_type>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
665 "<ref_name>",
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
666 "<raw_id>"
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
667 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
668 "comments" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
669 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
670 "username" : "<user_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
671 "text" : "<comment text>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
672 "comment_id" : "<comment_id>",
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
673 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
674 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
675 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
676 "owner" : "<username>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
677 "statuses" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
678 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
679 "status" : "<status_of_review>", # "under_review", "approved" or "rejected"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
680 "reviewer" : "<user_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
681 "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
682 },
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
683 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
684 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
685 "revisions" : [
6654
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
686 "<raw_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 ...
bf9900e6e177 api: add option to get pullrequests for get_repo
domruf <dominikruf@gmail.com>
parents: 6653
diff changeset
691 ]
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
692 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
693 error : null
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
694
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
695 get_repos
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
696 ^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
697
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
698 List all existing repositories.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
699 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
700 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
701
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
702 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
703
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
704 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
705 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
706 method : "get_repos"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
707 args : { }
1500
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
708
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
709 OUTPUT::
256e729a94cd Extended API
Marcin Kuzminski <marcin@python-works.com>
parents: 1491
diff changeset
710
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
711 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
712 result : [
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
713 {
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
714 "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
715 "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
716 "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
717 "clone_uri" : "<clone_uri>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
718 "private" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
719 "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
720 "description" : "<description>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
721 "landing_rev" : "<landing_rev>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
722 "owner" : "<repo_owner>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
723 "fork_of" : "<name_of_fork_parent>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
724 "enable_downloads" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
725 "enable_statistics": "<bool>",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
726 },
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
727 …
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
728 ]
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
729 error : null
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
730
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
731 get_repo_nodes
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
732 ^^^^^^^^^^^^^^
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
733
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
734 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
735 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
736 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
737
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
738 INPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
739
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
740 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
741 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
742 method : "get_repo_nodes"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
743 args : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
744 "repoid" : "<reponame or repo_id>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
745 "revision" : "<revision>",
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
746 "root_path" : "<root_path>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
747 "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
748 }
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
749
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
750 OUTPUT::
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
751
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
752 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
753 result : [
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
754 {
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
755 "name" : "<name>"
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
756 "type" : "<type>",
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
757 },
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
758 …
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
759 ]
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
760 error : null
1810
203af05539e0 implements #330 api method for listing nodes at particular revision
Marcin Kuzminski <marcin@python-works.com>
parents: 1793
diff changeset
761
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
762 create_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
763 ^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
764
7314
083fbf531a5d repos: only allow api repo creation in existing groups
Mads Kiilerich <mads@kiilerich.com>
parents: 5497
diff changeset
765 Create a repository. If the repository name contains "/", the repository will be
083fbf531a5d repos: only allow api repo creation in existing groups
Mads Kiilerich <mads@kiilerich.com>
parents: 5497
diff changeset
766 created in the repository group indicated by that path. Any such repository
083fbf531a5d repos: only allow api repo creation in existing groups
Mads Kiilerich <mads@kiilerich.com>
parents: 5497
diff changeset
767 groups need to exist before calling this method, or the call will fail.
083fbf531a5d repos: only allow api repo creation in existing groups
Mads Kiilerich <mads@kiilerich.com>
parents: 5497
diff changeset
768 For example "foo/bar/baz" will create a repository "baz" inside the repository
083fbf531a5d repos: only allow api repo creation in existing groups
Mads Kiilerich <mads@kiilerich.com>
parents: 5497
diff changeset
769 group "bar" which itself is in a repository group "foo", but both "foo" and
083fbf531a5d repos: only allow api repo creation in existing groups
Mads Kiilerich <mads@kiilerich.com>
parents: 5497
diff changeset
770 "bar" already need to exist before calling this method.
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
771 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
772 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
773 Regular users cannot specify owner parameter.
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
774
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
775 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
776
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
777 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
778 api_key : "<api_key>"
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
779 method : "create_repo"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
780 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
781 "repo_name" : "<reponame>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
782 "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
783 "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
784 "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
785 "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
786 "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
787 "landing_rev" : "<landing_rev> = Optional('tip')",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
788 "enable_downloads" : "<bool> = Optional(False)",
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
789 "enable_statistics": "<bool> = Optional(False)",
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
790 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
791
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
792 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
793
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
794 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
795 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
796 "msg" : "Created new repository `<reponame>`",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
797 "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
798 "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
799 "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
800 "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
801 "clone_uri" : "<clone_uri>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
802 "private" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
803 "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
804 "description" : "<description>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
805 "landing_rev" : "<landing_rev>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
806 "owner" : "<username or user_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
807 "fork_of" : "<name_of_fork_parent>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
808 "enable_downloads" : "<bool>",
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
809 "enable_statistics": "<bool>",
2378
04ef27ce939e API: create_repo returns now repo object after creation
Marcin Kuzminski <marcin@python-works.com>
parents: 2365
diff changeset
810 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
811 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
812 error : null
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
813
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
814 update_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
815 ^^^^^^^^^^^
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
816
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
817 Update a repository.
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
818 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
819 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
820 Regular users cannot specify owner parameter.
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
821
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
822 INPUT::
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
823
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
824 id : <id_for_response>
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
825 api_key : "<api_key>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
826 method : "update_repo"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
827 args : {
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
828 "repoid" : "<reponame or repo_id>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
829 "name" : "<reponame> = Optional('')",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
830 "group" : "<group_id> = Optional(None)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
831 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
832 "description" : "<description> = Optional('')",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
833 "private" : "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
834 "clone_uri" : "<clone_uri> = Optional(None)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
835 "landing_rev" : "<landing_rev> = Optional('tip')",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
836 "enable_downloads" : "<bool> = Optional(False)",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
837 "enable_statistics": "<bool> = Optional(False)",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
838 }
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
839
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
840 OUTPUT::
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
841
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
842 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
843 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
844 "msg" : "updated repo ID:repo_id `<reponame>`",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
845 "repository" : {
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
846 "repo_id" : "<repo_id>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
847 "repo_name" : "<reponame>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
848 "repo_type" : "<repo_type>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
849 "clone_uri" : "<clone_uri>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
850 "private" : "<bool>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
851 "created_on" : "<datetimecreated>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
852 "description" : "<description>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
853 "landing_rev" : "<landing_rev>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
854 "owner" : "<username or user_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
855 "fork_of" : "<name_of_fork_parent>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
856 "enable_downloads" : "<bool>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
857 "enable_statistics": "<bool>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
858 "last_changeset" : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
859 "author" : "<full_author>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
860 "date" : "<date_time_of_commit>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
861 "message" : "<commit_message>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
862 "raw_id" : "<raw_id>",
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
863 "revision": "<numeric_revision>",
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
864 "short_id": "<short_id>"
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
865 }
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
866 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
867 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
868 error : null
5274
e268da9b748f docs: add documentation for update_repo API
Mads Kiilerich <madski@unity3d.com>
parents: 5222
diff changeset
869
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
870 fork_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
871 ^^^^^^^^^
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
872
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
873 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
874 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
875 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
876 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
877 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
878 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
879 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
880
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
881 INPUT::
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
882
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
883 id : <id_for_response>
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
884 api_key : "<api_key>"
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
885 method : "fork_repo"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
886 args : {
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
887 "repoid" : "<reponame or repo_id>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
888 "fork_name" : "<forkname>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
889 "owner" : "<username or user_id = Optional(=apiuser)>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
890 "description" : "<description>",
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
891 "copy_permissions": "<bool>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
892 "private" : "<bool>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
893 "landing_rev" : "<landing_rev>"
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
894 }
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
895
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
896 OUTPUT::
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
897
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
898 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
899 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
900 "msg" : "Created fork of `<reponame>` as `<forkname>`",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
901 "success" : true
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
902 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
903 error : null
3122
4ef6a7ed5e3e #699: fix missing fork docs for API
Marcin Kuzminski <marcin@python-works.com>
parents: 3115
diff changeset
904
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
905 delete_repo
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
906 ^^^^^^^^^^^
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
907
4879
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
908 Delete a repository.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
909 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
910 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
911 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
912
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
913 INPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
914
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
915 id : <id_for_response>
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
916 api_key : "<api_key>"
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
917 method : "delete_repo"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
918 args : {
3641
b44979649915 recursive forks detach
Marcin Kuzminski <marcin@python-works.com>
parents: 3457
diff changeset
919 "repoid" : "<reponame or repo_id>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
920 "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
921 }
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
922
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
923 OUTPUT::
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
924
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
925 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
926 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
927 "msg" : "Deleted repository `<reponame>`",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
928 "success" : true
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
929 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
930 error : null
2003
7dfcdf4c7dd2 implements #361 API method for deleting repositories
Marcin Kuzminski <marcin@python-works.com>
parents: 2002
diff changeset
931
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
932 grant_user_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
933 ^^^^^^^^^^^^^^^^^^^^^
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
934
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
935 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
936 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
937
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
938 INPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
939
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
940 id : <id_for_response>
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
941 api_key : "<api_key>"
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
942 method : "grant_user_permission"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
943 args : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
944 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
945 "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
946 "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
947 }
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
948
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
949 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
950
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
951 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
952 result : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
953 "msg" : "Granted perm: `<perm>` for user: `<username>` in repo: `<reponame>`",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
954 "success" : true
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
955 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
956 error : null
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
957
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
958 revoke_user_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
959 ^^^^^^^^^^^^^^^^^^^^^^
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
960
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
961 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
962 This command can only be executed using the api_key of a user with admin rights.
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
963
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
964 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
965
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
966 id : <id_for_response>
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
967 api_key : "<api_key>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
968 method : "revoke_user_permission"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
969 args : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
970 "repoid" : "<reponame or repo_id>"
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
971 "userid" : "<username or user_id>"
1592
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
972 }
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
973
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
974 OUTPUT::
8628c8706bf8 [API] Update doc
Nicolas VINOT <aeris@imirhil.fr>
parents: 1500
diff changeset
975
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
976 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
977 result : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
978 "msg" : "Revoked perm for user: `<username>` in repo: `<reponame>`",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
979 "success" : true
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
980 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
981 error : null
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
982
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
983 grant_user_group_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
984 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
985
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
986 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
987 existing one if found.
599fba9967a4 docs: improve the API documentation
Mads Kiilerich <madski@unity3d.com>
parents: 4493
diff changeset
988 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
989
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
990 INPUT::
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
991
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
992 id : <id_for_response>
1793
631caf880b87 implements #329
Marcin Kuzminski <marcin@python-works.com>
parents: 1708
diff changeset
993 api_key : "<api_key>"
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
994 method : "grant_user_group_permission"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
995 args : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
996 "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
997 "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
998 "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
999 }
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1000
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1001 OUTPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1002
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1003 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1004 result : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1005 "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1006 "success" : true
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1007 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1008 error : null
3224
8b8edfc25856 whitespace cleanup
Marcin Kuzminski <marcin@python-works.com>
parents: 3213
diff changeset
1009
4493
88b9cc4ba52f Corrected method names in documentation, to match API
Rasmus Selsmark <rasmuss@unity3d.com>
parents: 4192
diff changeset
1010 revoke_user_group_permission
5575
ed2fb6e84a02 docs: use consistent style for section titles
Mads Kiilerich <madski@unity3d.com>
parents: 5497
diff changeset
1011 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1012
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
1013 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
1014 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
1015
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1016 INPUT::
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1017
2143
c1f1f0661090 API docs improvement.
Marcin Kuzminski <marcin@python-works.com>
parents: 2095
diff changeset
1018 id : <id_for_response>
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1019 api_key : "<api_key>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1020 method : "revoke_user_group_permission"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1021 args : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1022 "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
1023 "usersgroupid" : "<user group id or name>"
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1024 }
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1025
1843
0771f0f5ab28 api review
Marcin Kuzminski <marcin@python-works.com>
parents: 1839
diff changeset
1026 OUTPUT::
1982
87f0800abc7b #227 Initial version of repository groups permissions system
Marcin Kuzminski <marcin@python-works.com>
parents: 1950
diff changeset
1027
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1028 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1029 result : {
2531
d80a68e2ebcc return proper id from users_group
Marcin Kuzminski <marcin@python-works.com>
parents: 2507
diff changeset
1030 "msg" : "Revoked perm for group: `<usersgroupname>` in repo: `<reponame>`",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1031 "success" : true
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1032 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1033 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
1034
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1035 get_changesets
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1036 ^^^^^^^^^^^^^^
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1037
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1038 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
1039 of a user with read permissions to the repository.
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1040
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1041 INPUT::
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1042
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1043 id : <id_for_response>
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1044 api_key : "<api_key>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1045 method : "get_changesets"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1046 args : {
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1047 "repoid" : "<reponame or repo_id>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1048 "start" : "<revision number> = Optional(None)",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1049 "end" : "<revision number> = Optional(None)",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1050 "start_date" : "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1051 "end_date" : "<date> = Optional(None)", # in "%Y-%m-%dT%H:%M:%S" format
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1052 "branch_name" : "<branch name filter> = Optional(None)",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1053 "reverse" : "<bool> = Optional(False)",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1054 "with_file_list" : "<bool> = Optional(False)"
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1055 }
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1056
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1057 OUTPUT::
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1058
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1059 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1060 result : [
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1061 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1062 "raw_id" : "<raw_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1063 "short_id" : "<short_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1064 "author" : "<full_author>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1065 "date" : "<date_time_of_commit>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1066 "message" : "<commit_message>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1067 "revision" : "<numeric_revision>",
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1068 <if with_file_list == True>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1069 "added" : [<list of added files>],
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1070 "changed" : [<list of changed files>],
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1071 "removed" : [<list of removed files>]
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1072 },
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1073 ...
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1074 ]
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1075 error : null
6683
19bc05bd8cf7 api: add get_changesets
domruf <dominikruf@gmail.com>
parents: 6655
diff changeset
1076
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1077 get_changeset
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1078 ^^^^^^^^^^^^^
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1079
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1080 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
1081 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
1082 repository.
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1083
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1084 INPUT::
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1085
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1086 id : <id_for_response>
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1087 api_key : "<api_key>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1088 method : "get_changeset"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1089 args : {
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1090 "repoid" : "<reponame or repo_id>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1091 "raw_id" : "<raw_id>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1092 "with_reviews" : "<bool> = Optional(False)"
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1093 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1094
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1095 OUTPUT::
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1096
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1097 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1098 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1099 "author" : "<full_author>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1100 "date" : "<date_time_of_commit>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1101 "message" : "<commit_message>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1102 "raw_id" : "<raw_id>",
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1103 "revision": "<numeric_revision>",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1104 "short_id": "<short_id>",
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1105 "reviews" : [{
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1106 "reviewer" : "<username>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1107 "modified_at" : "<date_time_of_review>", # iso 8601 date, server's timezone
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1108 "status" : "<status_of_review>", # "under_review", "approved" or "rejected"
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1109 },
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1110 ...
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1111 ]
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1112 }
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1113 error : null
6652
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1114
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1115 Example output::
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1116
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 "id" : 1,
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1119 "error" : null,
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1120 "result" : {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1121 "author" : {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1122 "email" : "user@example.com",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1123 "name" : "Kallithea Admin"
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 "changed" : [],
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1126 "short_id" : "e1022d3d28df",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1127 "date" : "2017-03-28T09:09:03",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1128 "added" : [
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1129 "README.rst"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1130 ],
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1131 "removed" : [],
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1132 "revision" : 0,
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1133 "raw_id" : "e1022d3d28dfba02f626cde65dbe08f4ceb0e4e7",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1134 "message" : "Added file via Kallithea",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1135 "id" : "e1022d3d28dfba02f626cde65dbe08f4ceb0e4e7",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1136 "reviews" : [
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1137 {
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1138 "status" : "under_review",
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1139 "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
1140 "reviewer" : "user"
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1141 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1142 ]
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1143 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1144 }
b60fb9461b18 Add JSON-RPC API for reading changeset status
Eivind Tagseth <eivindt@gmail.com>
parents: 6543
diff changeset
1145
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1146 get_pullrequest
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1147 ^^^^^^^^^^^^^^^
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1148
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1149 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
1150 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
1151
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1152 INPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1153
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1154 id : <id_for_response>
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1155 api_key : "<api_key>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1156 method : "get_pullrequest"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1157 args : {
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1158 "pullrequest_id" : "<pullrequest_id>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1159 }
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1160
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1161 OUTPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1162
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1163 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1164 result : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1165 "status" : "<pull_request_status>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1166 "pull_request_id" : <pull_request_id>,
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1167 "description" : "<pull_request_description>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1168 "title" : "<pull_request_title>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1169 "url" : "<pull_request_url>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1170 "reviewers" : [
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1171 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1172 "username" : "<user_name>",
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1173 },
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1174 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1175 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1176 "org_repo_url" : "<repo_url>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1177 "org_ref_parts" : [
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1178 "<ref_type>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1179 "<ref_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1180 "<raw_id>"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1181 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1182 "other_ref_parts" : [
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1183 "<ref_type>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1184 "<ref_name>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1185 "<raw_id>"
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1186 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1187 "comments" : [
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1188 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1189 "username" : "<user_name>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1190 "text" : "<comment text>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1191 "comment_id" : "<comment_id>",
6655
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 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1194 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1195 "owner" : "<username>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1196 "statuses" : [
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1197 {
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1198 "status" : "<status_of_review>", # "under_review", "approved" or "rejected"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1199 "reviewer" : "<user_name>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1200 "modified_at" : "<date_time_of_review>" # iso 8601 date, server's timezone
6655
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 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1203 ],
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1204 "revisions" : [
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1205 "<raw_id>",
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1206 ...
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1207 ]
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1208 },
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1209 error : null
6655
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 comment_pullrequest
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 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
1215 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
1216
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1217 INPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1218
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1219 id : <id_for_response>
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1220 api_key : "<api_key>"
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1221 method : "comment_pullrequest"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1222 args : {
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1223 "pull_request_id" : "<pull_request_id>",
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1224 "comment_msg" : Optional(''),
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1225 "status" : Optional(None), # "under_review", "approved" or "rejected"
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1226 "close_pr" : Optional(False)",
6655
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
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1229 OUTPUT::
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1230
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1231 id : <id_given_in_input>
8936
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1232 result : True
ac5525c48f0a api docs: more consistent use of space around ":" in examples
Mads Kiilerich <mads@kiilerich.com>
parents: 8935
diff changeset
1233 error : null
6655
6452215a54ee api: add get_pullrequest and comment_pullrequest methods
domruf <dominikruf@gmail.com>
parents: 6654
diff changeset
1234
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
1235
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
1236 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
1237 ------------------------
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
1238
7692
0e3e0864f210 auth: drop api_access_controllers_whitelist and give API key auth same access as other kinds of auth
Mads Kiilerich <mads@kiilerich.com>
parents: 7672
diff changeset
1239 Kallithea HTTP entry points can also be accessed without login using bearer
0e3e0864f210 auth: drop api_access_controllers_whitelist and give API key auth same access as other kinds of auth
Mads Kiilerich <mads@kiilerich.com>
parents: 7672
diff changeset
1240 authentication by including this header with the request::
6384
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1241
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1242 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
1243
9cf90371d0f1 auth: add support for "Bearer" auth scheme (API key variant)
Søren Løvborg <sorenl@unity3d.com>
parents: 5866
diff changeset
1244 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
1245 ``?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
1246 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
1247
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
1248 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
1249 third-party services like code review, or build farms that can download archives.