##// END OF EJS Templates
upstream » kallithea
RSS

Clone from https://kallithea-scm.org/repos/kallithea

api docs: make examples use comma more like json does
Mads Kiilerich -
r8724:2dd317e9 stable
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -175,7 +175,7 b' INPUT::'
175 175 api_key : "<api_key>"
176 176 method : "get_ip"
177 177 args : {
178 "userid" : "<user_id or username>",
178 "userid" : "<user_id or username>"
179 179 }
180 180
181 181 OUTPUT::
@@ -186,7 +186,7 b' OUTPUT::'
186 186 "user_ips" : [
187 187 {
188 188 "ip_addr" : "<ip_with_mask>",
189 "ip_range" : ["<start_ip>", "<end_ip>"],
189 "ip_range" : ["<start_ip>", "<end_ip>"]
190 190 },
191 191 ...
192 192 ]
@@ -233,7 +233,7 b' OUTPUT::'
233 233 "hg.register.manual_activate"],
234 234 "repositories" : {"repo1" : "repository.none"},
235 235 "repositories_groups" : {"Group1" : "group.read"}
236 },
236 }
237 237 }
238 238 error : null
239 239
@@ -266,7 +266,7 b' OUTPUT::'
266 266 "active" : "<bool>",
267 267 "admin" : "<bool>",
268 268 "ldap_dn" : "<ldap_dn>",
269 "last_login" : "<last_login>",
269 "last_login" : "<last_login>"
270 270 },
271 271 …
272 272 ]
@@ -311,8 +311,8 b' OUTPUT::'
311 311 "active" : "<bool>",
312 312 "admin" : "<bool>",
313 313 "ldap_dn" : "<ldap_dn>",
314 "last_login": "<last_login>",
315 },
314 "last_login": "<last_login>"
315 }
316 316 }
317 317 error : null
318 318
@@ -359,8 +359,8 b' OUTPUT::'
359 359 "active" : "<bool>",
360 360 "admin" : "<bool>",
361 361 "ldap_dn" : "<ldap_dn>",
362 "last_login": "<last_login>",
363 },
362 "last_login": "<last_login>"
363 }
364 364 }
365 365 error : null
366 366
@@ -376,7 +376,7 b' INPUT::'
376 376 api_key : "<api_key>"
377 377 method : "delete_user"
378 378 args : {
379 "userid" : "<user_id or username>",
379 "userid" : "<user_id or username>"
380 380 }
381 381
382 382 OUTPUT::
@@ -423,7 +423,7 b' OUTPUT::'
423 423 "active" : "<bool>",
424 424 "admin" : "<bool>",
425 425 "ldap_dn" : "<ldap_dn>",
426 "last_login": "<last_login>",
426 "last_login": "<last_login>"
427 427 },
428 428 …
429 429 ]
@@ -450,7 +450,7 b' OUTPUT::'
450 450 {
451 451 "users_group_id" : "<id>",
452 452 "group_name" : "<groupname>",
453 "active" : "<bool>",
453 "active" : "<bool>"
454 454 },
455 455 …
456 456 ]
@@ -481,8 +481,8 b' OUTPUT::'
481 481 "users_group" : {
482 482 "users_group_id" : "<id>",
483 483 "group_name" : "<groupname>",
484 "active" : "<bool>",
485 },
484 "active" : "<bool>"
485 }
486 486 }
487 487 error : null
488 488
@@ -500,14 +500,14 b' INPUT::'
500 500 method : "add_user_user_group"
501 501 args : {
502 502 "usersgroupid" : "<user group id or name>",
503 "userid" : "<user_id or username>",
503 "userid" : "<user_id or username>"
504 504 }
505 505
506 506 OUTPUT::
507 507
508 508 id : <id_given_in_input>
509 509 result : {
510 "success" : True|False # depends on if member is in group
510 "success" : True|False, # depends on if member is in group
511 511 "msg" : "added member `<username>` to a user group `<groupname>` |
512 512 User is already in that group"
513 513 }
@@ -527,7 +527,7 b' INPUT::'
527 527 method : "remove_user_from_user_group"
528 528 args : {
529 529 "usersgroupid" : "<user group id or name>",
530 "userid" : "<user_id or username>",
530 "userid" : "<user_id or username>"
531 531 }
532 532
533 533 OUTPUT::
@@ -556,7 +556,7 b' INPUT::'
556 556 args : {
557 557 "repoid" : "<reponame or repo_id>",
558 558 "with_revision_names" : "<bool> = Optional(False)",
559 "with_pullrequests" : "<bool> = Optional(False)",
559 "with_pullrequests" : "<bool> = Optional(False)"
560 560 }
561 561
562 562 OUTPUT::
@@ -565,7 +565,7 b' OUTPUT::'
565 565 result : None if repository does not exist or
566 566 {
567 567 "repo_id" : "<repo_id>",
568 "repo_name" : "<reponame>"
568 "repo_name" : "<reponame>",
569 569 "repo_type" : "<repo_type>",
570 570 "clone_uri" : "<clone_uri>",
571 571 "enable_downloads" : "<bool>",
@@ -623,7 +623,7 b' OUTPUT::'
623 623 "active" : "<bool>",
624 624 "admin" : "<bool>",
625 625 "ldap_dn" : "<ldap_dn>",
626 "last_login" : "<last_login>",
626 "last_login" : "<last_login>"
627 627 },
628 628 …
629 629 ],
@@ -650,7 +650,7 b' OUTPUT::'
650 650 "url" : "<pull_request_url>",
651 651 "reviewers" : [
652 652 {
653 "username" : "<user_id>",
653 "username" : "<user_id>"
654 654 },
655 655 ...
656 656 ],
@@ -669,7 +669,7 b' OUTPUT::'
669 669 {
670 670 "username" : "<user_id>",
671 671 "text" : "<comment text>",
672 "comment_id" : "<comment_id>",
672 "comment_id" : "<comment_id>"
673 673 },
674 674 ...
675 675 ],
@@ -712,7 +712,7 b' OUTPUT::'
712 712 result : [
713 713 {
714 714 "repo_id" : "<repo_id>",
715 "repo_name" : "<reponame>"
715 "repo_name" : "<reponame>",
716 716 "repo_type" : "<repo_type>",
717 717 "clone_uri" : "<clone_uri>",
718 718 "private" : "<bool>",
@@ -722,7 +722,7 b' OUTPUT::'
722 722 "owner" : "<repo_owner>",
723 723 "fork_of" : "<name_of_fork_parent>",
724 724 "enable_downloads" : "<bool>",
725 "enable_statistics": "<bool>",
725 "enable_statistics": "<bool>"
726 726 },
727 727 …
728 728 ]
@@ -741,7 +741,7 b' INPUT::'
741 741 api_key : "<api_key>"
742 742 method : "get_repo_nodes"
743 743 args : {
744 "repoid" : "<reponame or repo_id>"
744 "repoid" : "<reponame or repo_id>",
745 745 "revision" : "<revision>",
746 746 "root_path" : "<root_path>",
747 747 "ret_type" : "<ret_type> = Optional('all')"
@@ -752,8 +752,8 b' OUTPUT::'
752 752 id : <id_given_in_input>
753 753 result : [
754 754 {
755 "name" : "<name>"
756 "type" : "<type>",
755 "name" : "<name>",
756 "type" : "<type>"
757 757 },
758 758 …
759 759 ]
@@ -786,7 +786,7 b' INPUT::'
786 786 "clone_uri" : "<clone_uri> = Optional(None)",
787 787 "landing_rev" : "<landing_rev> = Optional('tip')",
788 788 "enable_downloads" : "<bool> = Optional(False)",
789 "enable_statistics": "<bool> = Optional(False)",
789 "enable_statistics": "<bool> = Optional(False)"
790 790 }
791 791
792 792 OUTPUT::
@@ -796,7 +796,7 b' OUTPUT::'
796 796 "msg" : "Created new repository `<reponame>`",
797 797 "repo" : {
798 798 "repo_id" : "<repo_id>",
799 "repo_name" : "<reponame>"
799 "repo_name" : "<reponame>",
800 800 "repo_type" : "<repo_type>",
801 801 "clone_uri" : "<clone_uri>",
802 802 "private" : "<bool>",
@@ -806,8 +806,8 b' OUTPUT::'
806 806 "owner" : "<username or user_id>",
807 807 "fork_of" : "<name_of_fork_parent>",
808 808 "enable_downloads" : "<bool>",
809 "enable_statistics": "<bool>",
810 },
809 "enable_statistics": "<bool>"
810 }
811 811 }
812 812 error : null
813 813
@@ -825,7 +825,7 b' INPUT::'
825 825 api_key : "<api_key>"
826 826 method : "update_repo"
827 827 args : {
828 "repoid" : "<reponame or repo_id>"
828 "repoid" : "<reponame or repo_id>",
829 829 "name" : "<reponame> = Optional('')",
830 830 "group" : "<group_id> = Optional(None)",
831 831 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
@@ -834,7 +834,7 b' INPUT::'
834 834 "clone_uri" : "<clone_uri> = Optional(None)",
835 835 "landing_rev" : "<landing_rev> = Optional('tip')",
836 836 "enable_downloads" : "<bool> = Optional(False)",
837 "enable_statistics": "<bool> = Optional(False)",
837 "enable_statistics": "<bool> = Optional(False)"
838 838 }
839 839
840 840 OUTPUT::
@@ -844,7 +844,7 b' OUTPUT::'
844 844 "msg" : "updated repo ID:repo_id `<reponame>`",
845 845 "repository" : {
846 846 "repo_id" : "<repo_id>",
847 "repo_name" : "<reponame>"
847 "repo_name" : "<reponame>",
848 848 "repo_type" : "<repo_type>",
849 849 "clone_uri" : "<clone_uri>",
850 850 "private" : "<bool>",
@@ -863,7 +863,7 b' OUTPUT::'
863 863 "revision": "<numeric_revision>",
864 864 "short_id": "<short_id>"
865 865 }
866 },
866 }
867 867 }
868 868 error : null
869 869
@@ -941,9 +941,9 b' INPUT::'
941 941 api_key : "<api_key>"
942 942 method : "grant_user_permission"
943 943 args : {
944 "repoid" : "<reponame or repo_id>"
945 "userid" : "<username or user_id>"
946 "perm" : "(repository.(none|read|write|admin))",
944 "repoid" : "<reponame or repo_id>",
945 "userid" : "<username or user_id>",
946 "perm" : "(repository.(none|read|write|admin))"
947 947 }
948 948
949 949 OUTPUT::
@@ -967,7 +967,7 b' INPUT::'
967 967 api_key : "<api_key>"
968 968 method : "revoke_user_permission"
969 969 args : {
970 "repoid" : "<reponame or repo_id>"
970 "repoid" : "<reponame or repo_id>",
971 971 "userid" : "<username or user_id>"
972 972 }
973 973
@@ -993,9 +993,9 b' INPUT::'
993 993 api_key : "<api_key>"
994 994 method : "grant_user_group_permission"
995 995 args : {
996 "repoid" : "<reponame or repo_id>"
997 "usersgroupid" : "<user group id or name>"
998 "perm" : "(repository.(none|read|write|admin))",
996 "repoid" : "<reponame or repo_id>",
997 "usersgroupid" : "<user group id or name>",
998 "perm" : "(repository.(none|read|write|admin))"
999 999 }
1000 1000
1001 1001 OUTPUT::
@@ -1019,7 +1019,7 b' INPUT::'
1019 1019 api_key : "<api_key>"
1020 1020 method : "revoke_user_group_permission"
1021 1021 args : {
1022 "repoid" : "<reponame or repo_id>"
1022 "repoid" : "<reponame or repo_id>",
1023 1023 "usersgroupid" : "<user group id or name>"
1024 1024 }
1025 1025
@@ -1155,7 +1155,7 b' INPUT::'
1155 1155 api_key : "<api_key>"
1156 1156 method : "get_pullrequest"
1157 1157 args : {
1158 "pullrequest_id" : "<pullrequest_id>",
1158 "pullrequest_id" : "<pullrequest_id>"
1159 1159 }
1160 1160
1161 1161 OUTPUT::
@@ -1169,7 +1169,7 b' OUTPUT::'
1169 1169 "url" : "<pull_request_url>",
1170 1170 "reviewers" : [
1171 1171 {
1172 "username" : "<user_name>",
1172 "username" : "<user_name>"
1173 1173 },
1174 1174 ...
1175 1175 ],
@@ -1188,7 +1188,7 b' OUTPUT::'
1188 1188 {
1189 1189 "username" : "<user_name>",
1190 1190 "text" : "<comment text>",
1191 "comment_id" : "<comment_id>",
1191 "comment_id" : "<comment_id>"
1192 1192 },
1193 1193 ...
1194 1194 ],
@@ -1223,7 +1223,7 b' INPUT::'
1223 1223 "pull_request_id" : "<pull_request_id>",
1224 1224 "comment_msg" : Optional(''),
1225 1225 "status" : Optional(None), # "under_review", "approved" or "rejected"
1226 "close_pr" : Optional(False)",
1226 "close_pr" : Optional(False)"
1227 1227 }
1228 1228
1229 1229 OUTPUT::
Show file before | Show file after | Hide comments
@@ -174,7 +174,7 b' class ApiController(JSONRPCController):'
174 174
175 175 id : <id_given_in_input>
176 176 result : {
177 "msg" : "Pulled from `<repository name>`"
177 "msg" : "Pulled from `<repository name>`",
178 178 "repository" : "<repository name>"
179 179 }
180 180 error : null
@@ -307,7 +307,7 b' class ApiController(JSONRPCController):'
307 307 "user_ips" : [
308 308 {
309 309 "ip_addr" : "<ip_with_mask>",
310 "ip_range" : ["<start_ip>", "<end_ip>"],
310 "ip_range" : ["<start_ip>", "<end_ip>"]
311 311 },
312 312 ...
313 313 ]
@@ -377,7 +377,7 b' class ApiController(JSONRPCController):'
377 377 "repositories" : {"repo1" : "repository.none"},
378 378 "repositories_groups" : {"Group1" : "group.read"},
379 379 "user_groups" : { "usrgrp1" : "usergroup.admin" }
380 },
380 }
381 381 }
382 382 error : null
383 383 """
@@ -529,7 +529,7 b' class ApiController(JSONRPCController):'
529 529 id : <id_given_in_input>
530 530 result : {
531 531 "msg" : "updated user ID:<userid> <username>",
532 "user" : <user_object>,
532 "user" : <user_object>
533 533 }
534 534 error : null
535 535
@@ -629,9 +629,9 b' class ApiController(JSONRPCController):'
629 629 {
630 630 "users_group_id" : "<id>",
631 631 "group_name" : "<groupname>",
632 "group_description" : "<description>"
632 "group_description" : "<description>",
633 633 "active" : "<bool>",
634 "owner" : "<username>"
634 "owner" : "<username>",
635 635 "members" : [<user_obj>,...]
636 636 }
637 637 error : null
@@ -946,7 +946,7 b' class ApiController(JSONRPCController):'
946 946 id : <id_given_in_input>
947 947 result : {
948 948 "repo_id" : "<repo_id>",
949 "repo_name" : "<reponame>"
949 "repo_name" : "<reponame>",
950 950 "repo_type" : "<repo_type>",
951 951 "clone_uri" : "<clone_uri>",
952 952 "enable_downloads" : "<bool>",
@@ -962,7 +962,7 b' class ApiController(JSONRPCController):'
962 962 "raw_id" : "<raw_id>",
963 963 "revision": "<numeric_revision>",
964 964 "short_id": "<short_id>"
965 }
965 },
966 966 "owner" : "<repo_owner>",
967 967 "fork_of" : "<name_of_fork_parent>",
968 968 "members" : [
@@ -978,7 +978,7 b' class ApiController(JSONRPCController):'
978 978 "permission" : "usergroup.(read|write|admin)"
979 979 },
980 980 …
981 ]
981 ],
982 982 "followers" : [<user_obj>, ...],
983 983 <if with_revision_names == True>
984 984 "tags" : {
@@ -992,7 +992,7 b' class ApiController(JSONRPCController):'
992 992 "bookmarks" : {
993 993 "<bookmarkname>" : "<raw_id>",
994 994 ...
995 },
995 }
996 996 }
997 997 error : null
998 998 """
@@ -1047,7 +1047,7 b' class ApiController(JSONRPCController):'
1047 1047 result : [
1048 1048 {
1049 1049 "repo_id" : "<repo_id>",
1050 "repo_name" : "<reponame>"
1050 "repo_name" : "<reponame>",
1051 1051 "repo_type" : "<repo_type>",
1052 1052 "clone_uri" : "<clone_uri>",
1053 1053 "private" : "<bool>",
@@ -1057,7 +1057,7 b' class ApiController(JSONRPCController):'
1057 1057 "owner" : "<repo_owner>",
1058 1058 "fork_of" : "<name_of_fork_parent>",
1059 1059 "enable_downloads" : "<bool>",
1060 "enable_statistics": "<bool>",
1060 "enable_statistics": "<bool>"
1061 1061 },
1062 1062 …
1063 1063 ]
@@ -1096,8 +1096,8 b' class ApiController(JSONRPCController):'
1096 1096 id : <id_given_in_input>
1097 1097 result : [
1098 1098 {
1099 "name" : "<name>"
1100 "type" : "<type>",
1099 "name" : "<name>",
1100 "type" : "<type>"
1101 1101 },
1102 1102 …
1103 1103 ]
@@ -1744,7 +1744,7 b' class ApiController(JSONRPCController):'
1744 1744
1745 1745 id : <id_given_in_input>
1746 1746 result : {
1747 "msg" : "created new repo group `<repo_group_name>`"
1747 "msg" : "created new repo group `<repo_group_name>`",
1748 1748 "repo_group" : <repogroup_object>
1749 1749 }
1750 1750 error : null
General Comments 0
You need to be logged in to leave comments. Login now