Show More
@@ -1,77 +1,77 b'' | |||
|
1 | 1 | .. _deprecated-methods-ref: |
|
2 | 2 | |
|
3 | 3 | deprecated methods |
|
4 | 4 | ================== |
|
5 | 5 | |
|
6 | 6 | changeset_comment |
|
7 | 7 | ----------------- |
|
8 | 8 | |
|
9 | 9 | .. py:function:: changeset_comment(apiuser, repoid, revision, message, userid=<Optional:<OptionalAttr:apiuser>>, status=<Optional:None>) |
|
10 | 10 | |
|
11 | 11 | .. deprecated:: 3.4.0 |
|
12 | 12 | |
|
13 | 13 | Please use method `comment_commit` instead. |
|
14 | 14 | |
|
15 | 15 | |
|
16 | 16 | Set a changeset comment, and optionally change the status of the |
|
17 | 17 | changeset. |
|
18 | 18 | |
|
19 | 19 | This command can only be run using an |authtoken| with admin |
|
20 | 20 | permissions on the |repo|. |
|
21 | 21 | |
|
22 | 22 | :param apiuser: This is filled automatically from the |authtoken|. |
|
23 | 23 | :type apiuser: AuthUser |
|
24 | 24 | :param repoid: Set the repository name or repository ID. |
|
25 | 25 | :type repoid: str or int |
|
26 | 26 | :param revision: Specify the revision for which to set a comment. |
|
27 | 27 | :type revision: str |
|
28 | 28 | :param message: The comment text. |
|
29 | 29 | :type message: str |
|
30 | 30 | :param userid: Set the user name of the comment creator. |
|
31 | 31 | :type userid: Optional(str or int) |
|
32 | 32 | :param status: Set the comment status. The following are valid options: |
|
33 | 33 | * not_reviewed |
|
34 | 34 | * approved |
|
35 | 35 | * rejected |
|
36 | 36 | * under_review |
|
37 | 37 | :type status: str |
|
38 | 38 | |
|
39 | 39 | Example error output: |
|
40 | 40 | |
|
41 |
.. code-block:: j |
|
|
41 | .. code-block:: javascript | |
|
42 | 42 | |
|
43 | 43 | { |
|
44 | 44 | "id" : <id_given_in_input>, |
|
45 | 45 | "result" : { |
|
46 | 46 | "msg": "Commented on commit `<revision>` for repository `<repoid>`", |
|
47 | 47 | "status_change": null or <status>, |
|
48 | 48 | "success": true |
|
49 | 49 | }, |
|
50 | 50 | "error" : null |
|
51 | 51 | } |
|
52 | 52 | |
|
53 | 53 | |
|
54 | 54 | get_locks |
|
55 | 55 | --------- |
|
56 | 56 | |
|
57 | 57 | .. py:function:: get_locks(apiuser, userid=<Optional:<OptionalAttr:apiuser>>) |
|
58 | 58 | |
|
59 | 59 | .. deprecated:: 4.0.0 |
|
60 | 60 | |
|
61 | 61 | Please use method `get_user_locks` instead. |
|
62 | 62 | |
|
63 | 63 | None |
|
64 | 64 | |
|
65 | 65 | |
|
66 | 66 | show_ip |
|
67 | 67 | ------- |
|
68 | 68 | |
|
69 | 69 | .. py:function:: show_ip(apiuser, userid=<Optional:<OptionalAttr:apiuser>>) |
|
70 | 70 | |
|
71 | 71 | .. deprecated:: 4.0.0 |
|
72 | 72 | |
|
73 | 73 | Please use method `get_ip` instead. |
|
74 | 74 | |
|
75 | 75 | None |
|
76 | 76 | |
|
77 | 77 |
@@ -1,102 +1,102 b'' | |||
|
1 | 1 | # -*- coding: utf-8 -*- |
|
2 | 2 | |
|
3 | 3 | # Copyright (C) 2011-2018 RhodeCode GmbH |
|
4 | 4 | # |
|
5 | 5 | # This program is free software: you can redistribute it and/or modify |
|
6 | 6 | # it under the terms of the GNU Affero General Public License, version 3 |
|
7 | 7 | # (only), as published by the Free Software Foundation. |
|
8 | 8 | # |
|
9 | 9 | # This program is distributed in the hope that it will be useful, |
|
10 | 10 | # but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
11 | 11 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
12 | 12 | # GNU General Public License for more details. |
|
13 | 13 | # |
|
14 | 14 | # You should have received a copy of the GNU Affero General Public License |
|
15 | 15 | # along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
16 | 16 | # |
|
17 | 17 | # This program is dual-licensed. If you wish to learn more about the |
|
18 | 18 | # RhodeCode Enterprise Edition, including its added features, Support services, |
|
19 | 19 | # and proprietary license terms, please see https://rhodecode.com/licenses/ |
|
20 | 20 | |
|
21 | 21 | |
|
22 | 22 | """ |
|
23 | 23 | NOTE: |
|
24 | 24 | Place for deprecated APIs here, if a call needs to be deprecated, please |
|
25 | 25 | put it here, and point to a new version |
|
26 | 26 | """ |
|
27 | 27 | import logging |
|
28 | 28 | |
|
29 | 29 | from rhodecode.api import jsonrpc_method, jsonrpc_deprecated_method |
|
30 | 30 | from rhodecode.api.utils import Optional, OAttr |
|
31 | 31 | |
|
32 | 32 | |
|
33 | 33 | log = logging.getLogger(__name__) |
|
34 | 34 | |
|
35 | 35 | |
|
36 | 36 | # permission check inside |
|
37 | 37 | @jsonrpc_method() |
|
38 | 38 | @jsonrpc_deprecated_method( |
|
39 | 39 | use_method='comment_commit', deprecated_at_version='3.4.0') |
|
40 | 40 | def changeset_comment(request, apiuser, repoid, revision, message, |
|
41 | 41 | userid=Optional(OAttr('apiuser')), |
|
42 | 42 | status=Optional(None)): |
|
43 | 43 | """ |
|
44 | 44 | Set a changeset comment, and optionally change the status of the |
|
45 | 45 | changeset. |
|
46 | 46 | |
|
47 | 47 | This command can only be run using an |authtoken| with admin |
|
48 | 48 | permissions on the |repo|. |
|
49 | 49 | |
|
50 | 50 | :param apiuser: This is filled automatically from the |authtoken|. |
|
51 | 51 | :type apiuser: AuthUser |
|
52 | 52 | :param repoid: Set the repository name or repository ID. |
|
53 | 53 | :type repoid: str or int |
|
54 | 54 | :param revision: Specify the revision for which to set a comment. |
|
55 | 55 | :type revision: str |
|
56 | 56 | :param message: The comment text. |
|
57 | 57 | :type message: str |
|
58 | 58 | :param userid: Set the user name of the comment creator. |
|
59 | 59 | :type userid: Optional(str or int) |
|
60 | 60 | :param status: Set the comment status. The following are valid options: |
|
61 | 61 | * not_reviewed |
|
62 | 62 | * approved |
|
63 | 63 | * rejected |
|
64 | 64 | * under_review |
|
65 | 65 | :type status: str |
|
66 | 66 | |
|
67 | 67 | Example error output: |
|
68 | 68 | |
|
69 |
.. code-block:: j |
|
|
69 | .. code-block:: javascript | |
|
70 | 70 | |
|
71 | 71 | { |
|
72 | 72 | "id" : <id_given_in_input>, |
|
73 | 73 | "result" : { |
|
74 | 74 | "msg": "Commented on commit `<revision>` for repository `<repoid>`", |
|
75 | 75 | "status_change": null or <status>, |
|
76 | 76 | "success": true |
|
77 | 77 | }, |
|
78 | 78 | "error" : null |
|
79 | 79 | } |
|
80 | 80 | |
|
81 | 81 | """ |
|
82 | 82 | from .repo_api import comment_commit |
|
83 | 83 | |
|
84 | 84 | return comment_commit(request=request, |
|
85 | 85 | apiuser=apiuser, repoid=repoid, commit_id=revision, |
|
86 | 86 | message=message, userid=userid, status=status) |
|
87 | 87 | |
|
88 | 88 | |
|
89 | 89 | @jsonrpc_method() |
|
90 | 90 | @jsonrpc_deprecated_method( |
|
91 | 91 | use_method='get_ip', deprecated_at_version='4.0.0') |
|
92 | 92 | def show_ip(request, apiuser, userid=Optional(OAttr('apiuser'))): |
|
93 | 93 | from .server_api import get_ip |
|
94 | 94 | return get_ip(request=request, apiuser=apiuser, userid=userid) |
|
95 | 95 | |
|
96 | 96 | |
|
97 | 97 | @jsonrpc_method() |
|
98 | 98 | @jsonrpc_deprecated_method( |
|
99 | 99 | use_method='get_user_locks', deprecated_at_version='4.0.0') |
|
100 | 100 | def get_locks(request, apiuser, userid=Optional(OAttr('apiuser'))): |
|
101 | 101 | from .user_api import get_user_locks |
|
102 | 102 | return get_user_locks(request=request, apiuser=apiuser, userid=userid) No newline at end of file |
General Comments 0
You need to be logged in to leave comments.
Login now