##// END OF EJS Templates
docs: add documentation for update_repo API
Mads Kiilerich -
r5274:e268da9b default
parent child Browse files
Show More
@@ -292,7 +292,6 b' OUTPUT::'
292 "repositories_groups": {"Group1": "group.read"}
292 "repositories_groups": {"Group1": "group.read"}
293 },
293 },
294 }
294 }
295
296 error: null
295 error: null
297
296
298
297
@@ -535,7 +534,7 b' INPUT::'
535 method : "create_user_group"
534 method : "create_user_group"
536 args: {
535 args: {
537 "group_name": "<groupname>",
536 "group_name": "<groupname>",
538 "owner" : "<onwer_name_or_id = Optional(=apiuser)>",
537 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
539 "active": "<bool> = Optional(True)"
538 "active": "<bool> = Optional(True)"
540 }
539 }
541
540
@@ -725,7 +724,7 b' OUTPUT::'
725 "repo_name" : "<reponame>"
724 "repo_name" : "<reponame>"
726 "repo_type" : "<repo_type>",
725 "repo_type" : "<repo_type>",
727 "clone_uri" : "<clone_uri>",
726 "clone_uri" : "<clone_uri>",
728 "private": : "<bool>",
727 "private" : "<bool>",
729 "created_on" : "<datetimecreated>",
728 "created_on" : "<datetimecreated>",
730 "description" : "<description>",
729 "description" : "<description>",
731 "landing_rev": "<landing_rev>",
730 "landing_rev": "<landing_rev>",
@@ -792,7 +791,7 b' INPUT::'
792 method : "create_repo"
791 method : "create_repo"
793 args: {
792 args: {
794 "repo_name" : "<reponame>",
793 "repo_name" : "<reponame>",
795 "owner" : "<onwer_name_or_id = Optional(=apiuser)>",
794 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
796 "repo_type" : "<repo_type> = Optional('hg')",
795 "repo_type" : "<repo_type> = Optional('hg')",
797 "description" : "<description> = Optional('')",
796 "description" : "<description> = Optional('')",
798 "private" : "<bool> = Optional(False)",
797 "private" : "<bool> = Optional(False)",
@@ -813,7 +812,7 b' OUTPUT::'
813 "repo_name" : "<reponame>"
812 "repo_name" : "<reponame>"
814 "repo_type" : "<repo_type>",
813 "repo_type" : "<repo_type>",
815 "clone_uri" : "<clone_uri>",
814 "clone_uri" : "<clone_uri>",
816 "private": : "<bool>",
815 "private" : "<bool>",
817 "created_on" : "<datetimecreated>",
816 "created_on" : "<datetimecreated>",
818 "description" : "<description>",
817 "description" : "<description>",
819 "landing_rev": "<landing_rev>",
818 "landing_rev": "<landing_rev>",
@@ -827,6 +826,68 b' OUTPUT::'
827 error: null
826 error: null
828
827
829
828
829 update_repo
830 -----------
831
832 Update a repository.
833 This command can only be executed using the api_key of a user with admin rights,
834 or that of a regular user with create repository permission.
835 Regular users cannot specify owner parameter.
836
837
838 INPUT::
839
840 id : <id_for_response>
841 api_key : "<api_key>"
842 method : "update_repo"
843 args: {
844 "repoid" : "<reponame or repo_id>"
845 "name" : "<reponame> = Optional('')",
846 "group" : "<group_id> = Optional(None)",
847 "owner" : "<owner_name_or_id = Optional(=apiuser)>",
848 "description" : "<description> = Optional('')",
849 "private" : "<bool> = Optional(False)",
850 "clone_uri" : "<clone_uri> = Optional(None)",
851 "landing_rev" : "<landing_rev> = Optional('tip')",
852 "enable_downloads": "<bool> = Optional(False)",
853 "enable_locking": "<bool> = Optional(False)",
854 "enable_statistics": "<bool> = Optional(False)",
855 }
856
857 OUTPUT::
858
859 id : <id_given_in_input>
860 result: {
861 "msg": "updated repo ID:repo_id `<reponame>`",
862 "repository": {
863 "repo_id" : "<repo_id>",
864 "repo_name" : "<reponame>"
865 "repo_type" : "<repo_type>",
866 "clone_uri" : "<clone_uri>",
867 "private": "<bool>",
868 "created_on" : "<datetimecreated>",
869 "description" : "<description>",
870 "landing_rev": "<landing_rev>",
871 "owner": "<username or user_id>",
872 "fork_of": "<name_of_fork_parent>",
873 "enable_downloads": "<bool>",
874 "enable_locking": "<bool>",
875 "enable_statistics": "<bool>",
876 "last_changeset": {
877 "author": "<full_author>",
878 "date": "<date_time_of_commit>",
879 "message": "<commit_message>",
880 "raw_id": "<raw_id>",
881 "revision": "<numeric_revision>",
882 "short_id": "<short_id>"
883 }
884 "locked_by": "<username>",
885 "locked_date": "<float lock_time>",
886 },
887 }
888 error: null
889
890
830 fork_repo
891 fork_repo
831 ---------
892 ---------
832
893
General Comments 0
You need to be logged in to leave comments. Login now