##// END OF EJS Templates
api docs: drop extra newlines in docstrings
Mads Kiilerich -
r8721:6f9dec22 stable
parent child Browse files
Show More
@@ -191,7 +191,6 b' OUTPUT::'
191 ...
191 ...
192 ]
192 ]
193 }
193 }
194
195 error : null
194 error : null
196
195
197 get_user
196 get_user
@@ -892,7 +891,6 b' INPUT::'
892 "copy_permissions": "<bool>",
891 "copy_permissions": "<bool>",
893 "private": "<bool>",
892 "private": "<bool>",
894 "landing_rev": "<landing_rev>"
893 "landing_rev": "<landing_rev>"
895
896 }
894 }
897
895
898 OUTPUT::
896 OUTPUT::
@@ -186,9 +186,7 b' class ApiController(JSONRPCController):'
186 error : {
186 error : {
187 "Unable to pull changes from `<reponame>`"
187 "Unable to pull changes from `<reponame>`"
188 }
188 }
189
190 """
189 """
191
192 repo = get_repo_or_error(repoid)
190 repo = get_repo_or_error(repoid)
193
191
194 try:
192 try:
@@ -234,9 +232,7 b' class ApiController(JSONRPCController):'
234 error : {
232 error : {
235 'Error occurred during rescan repositories action'
233 'Error occurred during rescan repositories action'
236 }
234 }
237
238 """
235 """
239
240 try:
236 try:
241 rm_obsolete = remove_obsolete
237 rm_obsolete = remove_obsolete
242 added, removed = repo2db_mapper(ScmModel().repo_scan(),
238 added, removed = repo2db_mapper(ScmModel().repo_scan(),
@@ -273,7 +269,6 b' class ApiController(JSONRPCController):'
273 error : {
269 error : {
274 'Error occurred during cache invalidation action'
270 'Error occurred during cache invalidation action'
275 }
271 }
276
277 """
272 """
278 repo = get_repo_or_error(repoid)
273 repo = get_repo_or_error(repoid)
279 if not HasPermissionAny('hg.admin')():
274 if not HasPermissionAny('hg.admin')():
@@ -336,7 +331,6 b' class ApiController(JSONRPCController):'
336 """
331 """
337 return server info, including Kallithea version and installed packages
332 return server info, including Kallithea version and installed packages
338
333
339
340 OUTPUT::
334 OUTPUT::
341
335
342 id : <id_given_in_input>
336 id : <id_given_in_input>
@@ -385,9 +379,7 b' class ApiController(JSONRPCController):'
385 "user_groups": { "usrgrp1": "usergroup.admin" }
379 "user_groups": { "usrgrp1": "usergroup.admin" }
386 },
380 },
387 }
381 }
388
389 error: null
382 error: null
390
391 """
383 """
392 if not HasPermissionAny('hg.admin')():
384 if not HasPermissionAny('hg.admin')():
393 # make sure normal user does not pass someone else userid,
385 # make sure normal user does not pass someone else userid,
@@ -411,14 +403,12 b' class ApiController(JSONRPCController):'
411 Lists all existing users. This command can be executed only using api_key
403 Lists all existing users. This command can be executed only using api_key
412 belonging to user with admin rights.
404 belonging to user with admin rights.
413
405
414
415 OUTPUT::
406 OUTPUT::
416
407
417 id : <id_given_in_input>
408 id : <id_given_in_input>
418 result: [<user_object>, ...]
409 result: [<user_object>, ...]
419 error: null
410 error: null
420 """
411 """
421
422 return [
412 return [
423 user.get_api_data()
413 user.get_api_data()
424 for user in db.User.query()
414 for user in db.User.query()
@@ -455,7 +445,6 b' class ApiController(JSONRPCController):'
455 :param extern_type: extern_type
445 :param extern_type: extern_type
456 :type extern_type: Optional(str)
446 :type extern_type: Optional(str)
457
447
458
459 OUTPUT::
448 OUTPUT::
460
449
461 id : <id_given_in_input>
450 id : <id_given_in_input>
@@ -476,9 +465,7 b' class ApiController(JSONRPCController):'
476 or
465 or
477 "failed to create user `<username>`"
466 "failed to create user `<username>`"
478 }
467 }
479
480 """
468 """
481
482 if db.User.get_by_username(username):
469 if db.User.get_by_username(username):
483 raise JSONRPCError("user `%s` already exist" % (username,))
470 raise JSONRPCError("user `%s` already exist" % (username,))
484
471
@@ -537,7 +524,6 b' class ApiController(JSONRPCController):'
537 :param extern_type:
524 :param extern_type:
538 :type extern_type: Optional(str)
525 :type extern_type: Optional(str)
539
526
540
541 OUTPUT::
527 OUTPUT::
542
528
543 id : <id_given_in_input>
529 id : <id_given_in_input>
@@ -554,9 +540,7 b' class ApiController(JSONRPCController):'
554 error : {
540 error : {
555 "failed to update user `<username>`"
541 "failed to update user `<username>`"
556 }
542 }
557
558 """
543 """
559
560 user = get_user_or_error(userid)
544 user = get_user_or_error(userid)
561
545
562 # only non optional arguments will be stored in updates
546 # only non optional arguments will be stored in updates
@@ -612,7 +596,6 b' class ApiController(JSONRPCController):'
612 error : {
596 error : {
613 "failed to delete user ID:<userid> <username>"
597 "failed to delete user ID:<userid> <username>"
614 }
598 }
615
616 """
599 """
617 user = get_user_or_error(userid)
600 user = get_user_or_error(userid)
618
601
@@ -652,7 +635,6 b' class ApiController(JSONRPCController):'
652 "members" : [<user_obj>,...]
635 "members" : [<user_obj>,...]
653 }
636 }
654 error : null
637 error : null
655
656 """
638 """
657 user_group = get_user_group_or_error(usergroupid)
639 user_group = get_user_group_or_error(usergroupid)
658 if not HasPermissionAny('hg.admin')():
640 if not HasPermissionAny('hg.admin')():
@@ -669,14 +651,12 b' class ApiController(JSONRPCController):'
669 api_key belonging to user with admin rights or user who has at least
651 api_key belonging to user with admin rights or user who has at least
670 read access to user group.
652 read access to user group.
671
653
672
673 OUTPUT::
654 OUTPUT::
674
655
675 id : <id_given_in_input>
656 id : <id_given_in_input>
676 result : [<user_group_obj>,...]
657 result : [<user_group_obj>,...]
677 error : null
658 error : null
678 """
659 """
679
680 return [
660 return [
681 user_group.get_api_data()
661 user_group.get_api_data()
682 for user_group in UserGroupList(db.UserGroup.query().all(), perm_level='read')
662 for user_group in UserGroupList(db.UserGroup.query().all(), perm_level='read')
@@ -717,9 +697,7 b' class ApiController(JSONRPCController):'
717 or
697 or
718 "failed to create group `<group name>`"
698 "failed to create group `<group name>`"
719 }
699 }
720
721 """
700 """
722
723 if UserGroupModel().get_by_name(group_name):
701 if UserGroupModel().get_by_name(group_name):
724 raise JSONRPCError("user group `%s` already exist" % (group_name,))
702 raise JSONRPCError("user group `%s` already exist" % (group_name,))
725
703
@@ -774,7 +752,6 b' class ApiController(JSONRPCController):'
774 error : {
752 error : {
775 "failed to update user group `<user group name>`"
753 "failed to update user group `<user group name>`"
776 }
754 }
777
778 """
755 """
779 user_group = get_user_group_or_error(usergroupid)
756 user_group = get_user_group_or_error(usergroupid)
780 if not HasPermissionAny('hg.admin')():
757 if not HasPermissionAny('hg.admin')():
@@ -828,7 +805,6 b' class ApiController(JSONRPCController):'
828 or
805 or
829 "RepoGroup assigned to <repo_groups_list>"
806 "RepoGroup assigned to <repo_groups_list>"
830 }
807 }
831
832 """
808 """
833 user_group = get_user_group_or_error(usergroupid)
809 user_group = get_user_group_or_error(usergroupid)
834 if not HasPermissionAny('hg.admin')():
810 if not HasPermissionAny('hg.admin')():
@@ -872,7 +848,6 b' class ApiController(JSONRPCController):'
872 "success": True|False # depends on if member is in group
848 "success": True|False # depends on if member is in group
873 "msg": "added member `<username>` to a user group `<groupname>` |
849 "msg": "added member `<username>` to a user group `<groupname>` |
874 User is already in that group"
850 User is already in that group"
875
876 }
851 }
877 error : null
852 error : null
878
853
@@ -883,7 +858,6 b' class ApiController(JSONRPCController):'
883 error : {
858 error : {
884 "failed to add member to user group `<user_group_name>`"
859 "failed to add member to user group `<user_group_name>`"
885 }
860 }
886
887 """
861 """
888 user = get_user_or_error(userid)
862 user = get_user_or_error(userid)
889 user_group = get_user_group_or_error(usergroupid)
863 user_group = get_user_group_or_error(usergroupid)
@@ -922,7 +896,6 b' class ApiController(JSONRPCController):'
922 :param usergroupid:
896 :param usergroupid:
923 :param userid:
897 :param userid:
924
898
925
926 OUTPUT::
899 OUTPUT::
927
900
928 id : <id_given_in_input>
901 id : <id_given_in_input>
@@ -932,7 +905,6 b' class ApiController(JSONRPCController):'
932 User wasn't in group"
905 User wasn't in group"
933 }
906 }
934 error: null
907 error: null
935
936 """
908 """
937 user = get_user_or_error(userid)
909 user = get_user_or_error(userid)
938 user_group = get_user_group_or_error(usergroupid)
910 user_group = get_user_group_or_error(usergroupid)
@@ -1023,7 +995,6 b' class ApiController(JSONRPCController):'
1023 },
995 },
1024 }
996 }
1025 error : null
997 error : null
1026
1027 """
998 """
1028 repo = get_repo_or_error(repoid)
999 repo = get_repo_or_error(repoid)
1029
1000
@@ -1070,7 +1041,6 b' class ApiController(JSONRPCController):'
1070 api_key belonging to user with admin rights or regular user that have
1041 api_key belonging to user with admin rights or regular user that have
1071 admin, write or read access to repository.
1042 admin, write or read access to repository.
1072
1043
1073
1074 OUTPUT::
1044 OUTPUT::
1075
1045
1076 id : <id_given_in_input>
1046 id : <id_given_in_input>
@@ -1121,7 +1091,6 b' class ApiController(JSONRPCController):'
1121 :param ret_type: return type 'all|files|dirs' nodes
1091 :param ret_type: return type 'all|files|dirs' nodes
1122 :type ret_type: Optional(str)
1092 :type ret_type: Optional(str)
1123
1093
1124
1125 OUTPUT::
1094 OUTPUT::
1126
1095
1127 id : <id_given_in_input>
1096 id : <id_given_in_input>
@@ -1213,7 +1182,6 b' class ApiController(JSONRPCController):'
1213 error : {
1182 error : {
1214 'failed to create repository `<repo_name>`
1183 'failed to create repository `<repo_name>`
1215 }
1184 }
1216
1217 """
1185 """
1218 group_name = None
1186 group_name = None
1219 repo_name_parts = repo_name.split('/')
1187 repo_name_parts = repo_name.split('/')
@@ -1287,7 +1255,6 b' class ApiController(JSONRPCController):'
1287 clone_uri=None, landing_rev=None,
1255 clone_uri=None, landing_rev=None,
1288 enable_statistics=None,
1256 enable_statistics=None,
1289 enable_downloads=None):
1257 enable_downloads=None):
1290
1291 """
1258 """
1292 Updates repo
1259 Updates repo
1293
1260
@@ -1393,7 +1360,6 b' class ApiController(JSONRPCController):'
1393 "success": true
1360 "success": true
1394 }
1361 }
1395 error: null
1362 error: null
1396
1397 """
1363 """
1398 repo = get_repo_or_error(repoid)
1364 repo = get_repo_or_error(repoid)
1399 repo_name = repo.repo_name
1365 repo_name = repo.repo_name
@@ -1481,7 +1447,6 b' class ApiController(JSONRPCController):'
1481 "success": true
1447 "success": true
1482 }
1448 }
1483 error: null
1449 error: null
1484
1485 """
1450 """
1486 repo = get_repo_or_error(repoid)
1451 repo = get_repo_or_error(repoid)
1487
1452
@@ -1578,9 +1543,7 b' class ApiController(JSONRPCController):'
1578 "success": true
1543 "success": true
1579 }
1544 }
1580 error: null
1545 error: null
1581
1582 """
1546 """
1583
1584 repo = get_repo_or_error(repoid)
1547 repo = get_repo_or_error(repoid)
1585 user = get_user_or_error(userid)
1548 user = get_user_or_error(userid)
1586 try:
1549 try:
@@ -1620,7 +1583,6 b' class ApiController(JSONRPCController):'
1620 result : {
1583 result : {
1621 "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
1584 "msg" : "Granted perm: `<perm>` for group: `<usersgroupname>` in repo: `<reponame>`",
1622 "success": true
1585 "success": true
1623
1624 }
1586 }
1625 error : null
1587 error : null
1626
1588
@@ -1631,7 +1593,6 b' class ApiController(JSONRPCController):'
1631 error : {
1593 error : {
1632 "failed to edit permission for user group: `<usergroup>` in repo `<repo>`'
1594 "failed to edit permission for user group: `<usergroup>` in repo `<repo>`'
1633 }
1595 }
1634
1635 """
1596 """
1636 repo = get_repo_or_error(repoid)
1597 repo = get_repo_or_error(repoid)
1637 perm = get_perm_or_error(perm)
1598 perm = get_perm_or_error(perm)
@@ -1753,7 +1714,6 b' class ApiController(JSONRPCController):'
1753 def get_repo_groups(self):
1714 def get_repo_groups(self):
1754 """
1715 """
1755 Returns all repository groups
1716 Returns all repository groups
1756
1757 """
1717 """
1758 return [
1718 return [
1759 repo_group.get_api_data()
1719 repo_group.get_api_data()
@@ -1796,7 +1756,6 b' class ApiController(JSONRPCController):'
1796 error : {
1756 error : {
1797 failed to create repo group `<repogroupid>`
1757 failed to create repo group `<repogroupid>`
1798 }
1758 }
1799
1800 """
1759 """
1801 if db.RepoGroup.get_by_group_name(group_name):
1760 if db.RepoGroup.get_by_group_name(group_name):
1802 raise JSONRPCError("repo group `%s` already exist" % (group_name,))
1761 raise JSONRPCError("repo group `%s` already exist" % (group_name,))
@@ -1854,7 +1813,6 b' class ApiController(JSONRPCController):'
1854 @HasPermissionAnyDecorator('hg.admin')
1813 @HasPermissionAnyDecorator('hg.admin')
1855 def delete_repo_group(self, repogroupid):
1814 def delete_repo_group(self, repogroupid):
1856 """
1815 """
1857
1858 :param repogroupid: name or id of repository group
1816 :param repogroupid: name or id of repository group
1859 :type repogroupid: str or int
1817 :type repogroupid: str or int
1860
1818
@@ -1874,7 +1832,6 b' class ApiController(JSONRPCController):'
1874 error : {
1832 error : {
1875 "failed to delete repo group ID:<repogroupid> <repogroupname>"
1833 "failed to delete repo group ID:<repogroupid> <repogroupname>"
1876 }
1834 }
1877
1878 """
1835 """
1879 repo_group = get_repo_group_or_error(repogroupid)
1836 repo_group = get_repo_group_or_error(repogroupid)
1880
1837
@@ -1925,9 +1882,7 b' class ApiController(JSONRPCController):'
1925 error : {
1882 error : {
1926 "failed to edit permission for user: `<userid>` in repo group: `<repo_group_name>`"
1883 "failed to edit permission for user: `<userid>` in repo group: `<repo_group_name>`"
1927 }
1884 }
1928
1929 """
1885 """
1930
1931 repo_group = get_repo_group_or_error(repogroupid)
1886 repo_group = get_repo_group_or_error(repogroupid)
1932
1887
1933 if not HasPermissionAny('hg.admin')():
1888 if not HasPermissionAny('hg.admin')():
@@ -1987,9 +1942,7 b' class ApiController(JSONRPCController):'
1987 error : {
1942 error : {
1988 "failed to edit permission for user: `<userid>` in repo group: `<repo_group_name>`"
1943 "failed to edit permission for user: `<userid>` in repo group: `<repo_group_name>`"
1989 }
1944 }
1990
1991 """
1945 """
1992
1993 repo_group = get_repo_group_or_error(repogroupid)
1946 repo_group = get_repo_group_or_error(repogroupid)
1994
1947
1995 if not HasPermissionAny('hg.admin')():
1948 if not HasPermissionAny('hg.admin')():
@@ -2042,7 +1995,6 b' class ApiController(JSONRPCController):'
2042 result : {
1995 result : {
2043 "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`",
1996 "msg" : "Granted perm: `<perm>` (recursive:<apply_to_children>) for user group: `<usersgroupname>` in repo group: `<repo_group_name>`",
2044 "success": true
1997 "success": true
2045
2046 }
1998 }
2047 error : null
1999 error : null
2048
2000
@@ -2053,7 +2005,6 b' class ApiController(JSONRPCController):'
2053 error : {
2005 error : {
2054 "failed to edit permission for user group: `<usergroup>` in repo group: `<repo_group_name>`"
2006 "failed to edit permission for user group: `<usergroup>` in repo group: `<repo_group_name>`"
2055 }
2007 }
2056
2057 """
2008 """
2058 repo_group = get_repo_group_or_error(repogroupid)
2009 repo_group = get_repo_group_or_error(repogroupid)
2059 perm = get_perm_or_error(perm, prefix='group.')
2010 perm = get_perm_or_error(perm, prefix='group.')
@@ -2121,8 +2072,6 b' class ApiController(JSONRPCController):'
2121 error : {
2072 error : {
2122 "failed to edit permission for user group: `<usergroup>` in repo group: `<repo_group_name>`"
2073 "failed to edit permission for user group: `<usergroup>` in repo group: `<repo_group_name>`"
2123 }
2074 }
2124
2125
2126 """
2075 """
2127 repo_group = get_repo_group_or_error(repogroupid)
2076 repo_group = get_repo_group_or_error(repogroupid)
2128 user_group = get_user_group_or_error(usergroupid)
2077 user_group = get_user_group_or_error(usergroupid)
@@ -2200,7 +2149,6 b' class ApiController(JSONRPCController):'
2200 def create_gist(self, files, owner=None,
2149 def create_gist(self, files, owner=None,
2201 gist_type=db.Gist.GIST_PUBLIC, lifetime=-1,
2150 gist_type=db.Gist.GIST_PUBLIC, lifetime=-1,
2202 description=''):
2151 description=''):
2203
2204 """
2152 """
2205 Creates new Gist
2153 Creates new Gist
2206
2154
@@ -2233,7 +2181,6 b' class ApiController(JSONRPCController):'
2233 error : {
2181 error : {
2234 "failed to create gist"
2182 "failed to create gist"
2235 }
2183 }
2236
2237 """
2184 """
2238 try:
2185 try:
2239 if owner is None:
2186 if owner is None:
@@ -2280,7 +2227,6 b' class ApiController(JSONRPCController):'
2280 error : {
2227 error : {
2281 "failed to delete gist ID:<gist_id>"
2228 "failed to delete gist ID:<gist_id>"
2282 }
2229 }
2283
2284 """
2230 """
2285 gist = get_gist_or_error(gistid)
2231 gist = get_gist_or_error(gistid)
2286 if not HasPermissionAny('hg.admin')():
2232 if not HasPermissionAny('hg.admin')():
General Comments 0
You need to be logged in to leave comments. Login now