Mercurial > kallithea

comparison docs/api/api.rst @ 5434:8867673c8192

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: consistent spacing between text
author Mads Kiilerich <madski@unity3d.com>
date Wed, 26 Aug 2015 17:28:58 +0200
parents fbbe80e3322b
children 2b2216e8af36
comparison
equal deleted inserted replaced
5433:fbbe80e3322b 5434:8867673c8192
249 249
250 Get a user by username or userid. The result is empty if user can't be found. 250 Get a user by username or userid. The result is empty if user can't be found.
251 If userid param is skipped, it is set to id of user who is calling this method. 251 If userid param is skipped, it is set to id of user who is calling this method.
252 Any userid can be specified when the command is executed using the api_key of a user with admin rights. 252 Any userid can be specified when the command is executed using the api_key of a user with admin rights.
253 Regular users can only speicy their own userid. 253 Regular users can only speicy their own userid.
254
255 254
256 INPUT:: 255 INPUT::
257 256
258 id : <id_for_response> 257 id : <id_for_response>
259 api_key : "<api_key>" 258 api_key : "<api_key>"
293 --------- 292 ---------
294 293
295 List all existing users. 294 List all existing users.
296 This command can only be executed using the api_key of a user with admin rights. 295 This command can only be executed using the api_key of a user with admin rights.
297 296
298
299 INPUT:: 297 INPUT::
300 298
301 id : <id_for_response> 299 id : <id_for_response>
302 api_key : "<api_key>" 300 api_key : "<api_key>"
303 method : "get_users" 301 method : "get_users"
323 }, 321 },
324 … 322 …
325 ] 323 ]
326 error: null 324 error: null
327 325
328
329 .. _create-user: 326 .. _create-user:
330 327
331 create_user 328 create_user
332 ----------- 329 -----------
333 330
334 Create new user. 331 Create new user.
335 This command can only be executed using the api_key of a user with admin rights. 332 This command can only be executed using the api_key of a user with admin rights.
336
337 333
338 INPUT:: 334 INPUT::
339 335
340 id : <id_for_response> 336 id : <id_for_response>
341 api_key : "<api_key>" 337 api_key : "<api_key>"
378 update_user 374 update_user
379 ----------- 375 -----------
380 376
381 Update the given user if such user exists. 377 Update the given user if such user exists.
382 This command can only be executed using the api_key of a user with admin rights. 378 This command can only be executed using the api_key of a user with admin rights.
383
384 379
385 INPUT:: 380 INPUT::
386 381
387 id : <id_for_response> 382 id : <id_for_response>
388 api_key : "<api_key>" 383 api_key : "<api_key>"
424 ----------- 419 -----------
425 420
426 Delete the given user if such a user exists. 421 Delete the given user if such a user exists.
427 This command can only be executed using the api_key of a user with admin rights. 422 This command can only be executed using the api_key of a user with admin rights.
428 423
429
430 INPUT:: 424 INPUT::
431 425
432 id : <id_for_response> 426 id : <id_for_response>
433 api_key : "<api_key>" 427 api_key : "<api_key>"
434 method : "delete_user" 428 method : "delete_user"
448 get_user_group 442 get_user_group
449 -------------- 443 --------------
450 444
451 Get an existing user group. 445 Get an existing user group.
452 This command can only be executed using the api_key of a user with admin rights. 446 This command can only be executed using the api_key of a user with admin rights.
453
454 447
455 INPUT:: 448 INPUT::
456 449
457 id : <id_for_response> 450 id : <id_for_response>
458 api_key : "<api_key>" 451 api_key : "<api_key>"
492 --------------- 485 ---------------
493 486
494 List all existing user groups. 487 List all existing user groups.
495 This command can only be executed using the api_key of a user with admin rights. 488 This command can only be executed using the api_key of a user with admin rights.
496 489
497
498 INPUT:: 490 INPUT::
499 491
500 id : <id_for_response> 492 id : <id_for_response>
501 api_key : "<api_key>" 493 api_key : "<api_key>"
502 method : "get_user_groups" 494 method : "get_user_groups"
519 ----------------- 511 -----------------
520 512
521 Create a new user group. 513 Create a new user group.
522 This command can only be executed using the api_key of a user with admin rights. 514 This command can only be executed using the api_key of a user with admin rights.
523 515
524
525 INPUT:: 516 INPUT::
526 517
527 id : <id_for_response> 518 id : <id_for_response>
528 api_key : "<api_key>" 519 api_key : "<api_key>"
529 method : "create_user_group" 520 method : "create_user_group"
551 542
552 Adds a user to a user group. If the user already is in that group, success will be 543 Adds a user to a user group. If the user already is in that group, success will be
553 ``false``. 544 ``false``.
554 This command can only be executed using the api_key of a user with admin rights. 545 This command can only be executed using the api_key of a user with admin rights.
555 546
556
557 INPUT:: 547 INPUT::
558 548
559 id : <id_for_response> 549 id : <id_for_response>
560 api_key : "<api_key>" 550 api_key : "<api_key>"
561 method : "add_user_user_group" 551 method : "add_user_user_group"
578 --------------------------- 568 ---------------------------
579 569
580 Remove a user from a user group. If the user isn't in the given group, success will 570 Remove a user from a user group. If the user isn't in the given group, success will
581 be ``false``. 571 be ``false``.
582 This command can only be executed using the api_key of a user with admin rights. 572 This command can only be executed using the api_key of a user with admin rights.
583
584 573
585 INPUT:: 574 INPUT::
586 575
587 id : <id_for_response> 576 id : <id_for_response>
588 api_key : "<api_key>" 577 api_key : "<api_key>"
696 685
697 List all existing repositories. 686 List all existing repositories.
698 This command can only be executed using the api_key of a user with admin rights, 687 This command can only be executed using the api_key of a user with admin rights,
699 or that of a regular user with at least read access to the repository. 688 or that of a regular user with at least read access to the repository.
700 689
701
702 INPUT:: 690 INPUT::
703 691
704 id : <id_for_response> 692 id : <id_for_response>
705 api_key : "<api_key>" 693 api_key : "<api_key>"
706 method : "get_repos" 694 method : "get_repos"
734 722
735 Return a list of files and directories for a given path at the given revision. 723 Return a list of files and directories for a given path at the given revision.
736 It is possible to specify ret_type to show only ``files`` or ``dirs``. 724 It is possible to specify ret_type to show only ``files`` or ``dirs``.
737 This command can only be executed using the api_key of a user with admin rights. 725 This command can only be executed using the api_key of a user with admin rights.
738 726
739
740 INPUT:: 727 INPUT::
741 728
742 id : <id_for_response> 729 id : <id_for_response>
743 api_key : "<api_key>" 730 api_key : "<api_key>"
744 method : "get_repo_nodes" 731 method : "get_repo_nodes"
769 "foo", "bar" (with "foo" as parent), and create "baz" repository with 756 "foo", "bar" (with "foo" as parent), and create "baz" repository with
770 "bar" as group. 757 "bar" as group.
771 This command can only be executed using the api_key of a user with admin rights, 758 This command can only be executed using the api_key of a user with admin rights,
772 or that of a regular user with create repository permission. 759 or that of a regular user with create repository permission.
773 Regular users cannot specify owner parameter. 760 Regular users cannot specify owner parameter.
774
775 761
776 INPUT:: 762 INPUT::
777 763
778 id : <id_for_response> 764 id : <id_for_response>
779 api_key : "<api_key>" 765 api_key : "<api_key>"
819 805
820 Update a repository. 806 Update a repository.
821 This command can only be executed using the api_key of a user with admin rights, 807 This command can only be executed using the api_key of a user with admin rights,
822 or that of a regular user with create repository permission. 808 or that of a regular user with create repository permission.
823 Regular users cannot specify owner parameter. 809 Regular users cannot specify owner parameter.
824
825 810
826 INPUT:: 811 INPUT::
827 812
828 id : <id_for_response> 813 id : <id_for_response>
829 api_key : "<api_key>" 814 api_key : "<api_key>"
884 This command can only be executed using the api_key of a user with admin 869 This command can only be executed using the api_key of a user with admin
885 rights, or with the global fork permission, by a regular user with create 870 rights, or with the global fork permission, by a regular user with create
886 repository permission and at least read access to the repository. 871 repository permission and at least read access to the repository.
887 Regular users cannot specify owner parameter. 872 Regular users cannot specify owner parameter.
888 873
889
890 INPUT:: 874 INPUT::
891 875
892 id : <id_for_response> 876 id : <id_for_response>
893 api_key : "<api_key>" 877 api_key : "<api_key>"
894 method : "fork_repo" 878 method : "fork_repo"
918 Delete a repository. 902 Delete a repository.
919 This command can only be executed using the api_key of a user with admin rights, 903 This command can only be executed using the api_key of a user with admin rights,
920 or that of a regular user with admin access to the repository. 904 or that of a regular user with admin access to the repository.
921 When ``forks`` param is set it is possible to detach or delete forks of the deleted repository. 905 When ``forks`` param is set it is possible to detach or delete forks of the deleted repository.
922 906
923
924 INPUT:: 907 INPUT::
925 908
926 id : <id_for_response> 909 id : <id_for_response>
927 api_key : "<api_key>" 910 api_key : "<api_key>"
928 method : "delete_repo" 911 method : "delete_repo"
943 grant_user_permission 926 grant_user_permission
944 --------------------- 927 ---------------------
945 928
946 Grant permission for a user on the given repository, or update the existing one if found. 929 Grant permission for a user on the given repository, or update the existing one if found.
947 This command can only be executed using the api_key of a user with admin rights. 930 This command can only be executed using the api_key of a user with admin rights.
948
949 931
950 INPUT:: 932 INPUT::
951 933
952 id : <id_for_response> 934 id : <id_for_response>
953 api_key : "<api_key>" 935 api_key : "<api_key>"
971 ---------------------- 953 ----------------------
972 954
973 Revoke permission for a user on the given repository. 955 Revoke permission for a user on the given repository.
974 This command can only be executed using the api_key of a user with admin rights. 956 This command can only be executed using the api_key of a user with admin rights.
975 957
976
977 INPUT:: 958 INPUT::
978 959
979 id : <id_for_response> 960 id : <id_for_response>
980 api_key : "<api_key>" 961 api_key : "<api_key>"
981 method : "revoke_user_permission" 962 method : "revoke_user_permission"
997 --------------------------- 978 ---------------------------
998 979
999 Grant permission for a user group on the given repository, or update the 980 Grant permission for a user group on the given repository, or update the
1000 existing one if found. 981 existing one if found.
1001 This command can only be executed using the api_key of a user with admin rights. 982 This command can only be executed using the api_key of a user with admin rights.
1002
1003 983
1004 INPUT:: 984 INPUT::
1005 985
1006 id : <id_for_response> 986 id : <id_for_response>
1007 api_key : "<api_key>" 987 api_key : "<api_key>"