##// END OF EJS Templates
docs: first pass of introducing documentation of repo groups API
Louis Bertrand -
r8755:3c55f6f1 stable
parent child Browse files
Show More
@@ -4,6 +4,7 b' List of contributors to Kallithea projec'
4 Asterios Dimitriou <steve@pci.gr> 2016-2017 2020 2022
4 Asterios Dimitriou <steve@pci.gr> 2016-2017 2020 2022
5 Manuel Jacob <me@manueljacob.de> 2019-2020 2022
5 Manuel Jacob <me@manueljacob.de> 2019-2020 2022
6 Jaime Marquínez Ferrándiz <weblate@jregistros.fastmail.net> 2022
6 Jaime Marquínez Ferrándiz <weblate@jregistros.fastmail.net> 2022
7 Louis Bertrand <louis.bertrand@durhamcollege.ca> 2022
7 toras9000 <toras9000@gmail.com> 2022
8 toras9000 <toras9000@gmail.com> 2022
8 yzqzss <yzqzss@othing.xyz> 2022
9 yzqzss <yzqzss@othing.xyz> 2022
9 МАН69К <weblate@mah69k.net> 2022
10 МАН69К <weblate@mah69k.net> 2022
@@ -540,6 +540,167 b' OUTPUT::'
540 }
540 }
541 error : null
541 error : null
542
542
543 get_repo_group
544 ^^^^^^^^^^^^^^
545
546 Get an existing repository group.
547 This command can only be executed using the api_key of a user with admin rights.
548
549 INPUT::
550
551 id : <id_for_response>
552 api_key : "<api_key>"
553 method : "get_repo_group"
554 args : {
555 "repogroupid" : "<repo group id or name>"
556 }
557
558 OUTPUT::
559
560 id : <id_given_in_input>
561 result :
562 {
563 "group_id" : "<id>",
564 "group_name" : "<groupname>",
565 "group_description" : "<groupdescription>",
566 "parent_group" : "<groupid>"|null,
567 "repositories" : "<list_of_all_repo_names_in_group>",
568 "owner" : "<owner>",
569 "members" : [
570 {
571 "name" : "<name>",
572 "type" : "user",
573 "permission" : "group.(none|read|write|admin)"
574 },
575 {
576 "name" : "<name>",
577 "type" : "user_group",
578 "permission" : "group.(none|read|write|admin)"
579 },
580
581 ]
582
583 },
584 error : null
585
586 get_repo_groups
587 ^^^^^^^^^^^^^^^
588
589 List all existing repository groups.
590 This command can only be executed using the api_key of a user with admin rights.
591
592 INPUT::
593
594 id : <id_for_response>
595 api_key : "<api_key>"
596 method : "get_repo_groups"
597 args : { }
598
599 OUTPUT::
600
601 id : <id_given_in_input>
602 result : [
603 {
604 "group_id" : "<id>",
605 "group_name" : "<groupname>",
606 "group_description" : "<groupdescription>",
607 "parent_group" : "<groupid>"|null,
608 "repositories" : "<list_of_all_repo_names_in_group>",
609 "owner" : "<owner>"
610 },
611
612 ]
613 error : null
614
615 create_repo_group
616 ^^^^^^^^^^^^^^^^^
617
618 Create a new repository group.
619 This command can only be executed using the api_key of a user with admin rights.
620
621 INPUT::
622
623 id : <id_for_response>
624 api_key : "<api_key>"
625 method : "create_repo_group"
626 args : {
627 "group_name" : "<group_name>",
628 "description" : "<description> = Optional("")",
629 "owner" : "<username or user_id> = Optional(None)",
630 "parent" : "<reponame or id> = Optional(None)",
631 "copy_permissions" : "<bool> = Optional(False)"
632 }
633
634 OUTPUT::
635
636 id : <id_given_in_input>
637 result : {
638 "msg" : "created new repo group `<group_name>`",
639 "repo_group" : {
640 "group_id" : <id>,
641 "group_name" : "<parent_group>/<group_name>",
642 "group_description" : "<description>",
643 "parent_group" : <id>|null,
644 "repositories" : <list of repositories>,
645 "owner" : "<user_name>"
646 }
647
648 update_repo_group
649 ^^^^^^^^^^^^^^^^^
650
651 Update a repository group.
652 This command can only be executed using the api_key of a user with admin rights.
653
654 INPUT::
655
656 id : <id_for_response>
657 api_key : "<api_key>"
658 method : "update_repo_group"
659 args : {
660 "repogroupid" : "<id>",
661 "group_name" : "<group_name> = Optional(None)",
662 "description" : "<description> = Optional(None)",
663 "owner" : "<username or user_id> = Optional(None)",
664 "parent" : "<reponame or id> = Optional(None)"
665 }
666
667 OUTPUT::
668
669 id : <id_given_in_input>
670 result : {
671 "msg" : "updated repository group ID:<id> <group_name>",
672 "repo_group" : {
673 "group_id" : <id>,
674 "group_name" : "<parent_group>/<group_name>",
675 "group_description" : "<description>",
676 "parent_group" : <id>|null,
677 "repositories" : <list of repositories>,
678 "owner" : "<user_name>"
679 }
680
681 delete_repo_group
682 ^^^^^^^^^^^^^^^^^
683
684 Delete a repository group.
685 This command can only be executed using the api_key of a user with admin rights.
686
687 INPUT::
688
689 id : <id_for_response>
690 api_key : "<api_key>"
691 method : "delete_repo_group"
692 args : {
693 "repogroupid" : "<id>"
694 }
695
696 OUTPUT::
697
698 id : <id_given_in_input>
699 result : {
700 "msg" : "deleted repo group ID:<id> <group_name>",
701 "repo_group" : null
702 }
703
543 get_repo
704 get_repo
544 ^^^^^^^^
705 ^^^^^^^^
545
706
@@ -28,6 +28,7 b''
28 <li>Copyright &copy; 2016&ndash;2017, 2020, 2022, Asterios Dimitriou</li>
28 <li>Copyright &copy; 2016&ndash;2017, 2020, 2022, Asterios Dimitriou</li>
29 <li>Copyright &copy; 2019&ndash;2020, 2022, Manuel Jacob</li>
29 <li>Copyright &copy; 2019&ndash;2020, 2022, Manuel Jacob</li>
30 <li>Copyright &copy; 2022, Jaime Marquínez Ferrándiz</li>
30 <li>Copyright &copy; 2022, Jaime Marquínez Ferrándiz</li>
31 <li>Copyright &copy; 2022, Louis Bertrand</li>
31 <li>Copyright &copy; 2022, toras9000</li>
32 <li>Copyright &copy; 2022, toras9000</li>
32 <li>Copyright &copy; 2022, yzqzss</li>
33 <li>Copyright &copy; 2022, yzqzss</li>
33 <li>Copyright &copy; 2022, МАН69К</li>
34 <li>Copyright &copy; 2022, МАН69К</li>
General Comments 0
You need to be logged in to leave comments. Login now