annotate docs/api/api.rst @ 8163:24e1099e4f29

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