Show More
@@ -0,0 +1,48 b'' | |||
|
1 | .. _views-ref: | |
|
2 | ||
|
3 | views | |
|
4 | ===== | |
|
5 | ||
|
6 | push (EE only) | |
|
7 | -------------- | |
|
8 | ||
|
9 | .. py:function:: push(apiuser, repoid, remote_uri=<Optional:None>) | |
|
10 | ||
|
11 | Triggers a push on the given repository from a remote location. You | |
|
12 | can use this to keep remote repositories up-to-date. | |
|
13 | ||
|
14 | This command can only be run using an |authtoken| with admin | |
|
15 | rights to the specified repository. For more information, | |
|
16 | see :ref:`config-token-ref`. | |
|
17 | ||
|
18 | This command takes the following options: | |
|
19 | ||
|
20 | :param apiuser: This is filled automatically from the |authtoken|. | |
|
21 | :type apiuser: AuthUser | |
|
22 | :param repoid: The repository name or repository ID. | |
|
23 | :type repoid: str or int | |
|
24 | :param remote_uri: Optional remote URI to pass in for push | |
|
25 | :type remote_uri: str | |
|
26 | ||
|
27 | Example output: | |
|
28 | ||
|
29 | .. code-block:: bash | |
|
30 | ||
|
31 | id : <id_given_in_input> | |
|
32 | result : { | |
|
33 | "msg": "Pushed to url `<remote_url>` on repo `<repository name>`" | |
|
34 | "repository": "<repository name>" | |
|
35 | } | |
|
36 | error : null | |
|
37 | ||
|
38 | Example error output: | |
|
39 | ||
|
40 | .. code-block:: bash | |
|
41 | ||
|
42 | id : <id_given_in_input> | |
|
43 | result : null | |
|
44 | error : { | |
|
45 | "Unable to push changes to `<remote_url>`" | |
|
46 | } | |
|
47 | ||
|
48 |
@@ -196,6 +196,7 b' are not required in args.' | |||
|
196 | 196 | .. --- API DEFS MARKER --- |
|
197 | 197 | .. toctree:: |
|
198 | 198 | |
|
199 | methods/views | |
|
199 | 200 | methods/license-methods |
|
200 | 201 | methods/deprecated-methods |
|
201 | 202 | methods/gist-methods |
@@ -38,7 +38,7 b' changeset_comment' | |||
|
38 | 38 | |
|
39 | 39 | Example error output: |
|
40 | 40 | |
|
41 |
.. code-block:: j |
|
|
41 | .. code-block:: json | |
|
42 | 42 | |
|
43 | 43 | { |
|
44 | 44 | "id" : <id_given_in_input>, |
@@ -66,7 +66,7 b' comment_commit' | |||
|
66 | 66 | create_repo |
|
67 | 67 | ----------- |
|
68 | 68 | |
|
69 | .. py:function:: create_repo(apiuser, repo_name, repo_type, owner=<Optional:<OptionalAttr:apiuser>>, description=<Optional:''>, private=<Optional:False>, clone_uri=<Optional:None>, landing_rev=<Optional:'rev:tip'>, enable_statistics=<Optional:False>, enable_locking=<Optional:False>, enable_downloads=<Optional:False>, copy_permissions=<Optional:False>) | |
|
69 | .. py:function:: create_repo(apiuser, repo_name, repo_type, owner=<Optional:<OptionalAttr:apiuser>>, description=<Optional:''>, private=<Optional:False>, clone_uri=<Optional:None>, push_uri=<Optional:None>, landing_rev=<Optional:'rev:tip'>, enable_statistics=<Optional:False>, enable_locking=<Optional:False>, enable_downloads=<Optional:False>, copy_permissions=<Optional:False>) | |
|
70 | 70 | |
|
71 | 71 | Creates a repository. |
|
72 | 72 | |
@@ -95,6 +95,8 b' create_repo' | |||
|
95 | 95 | :type private: bool |
|
96 | 96 | :param clone_uri: set clone_uri |
|
97 | 97 | :type clone_uri: str |
|
98 | :param push_uri: set push_uri | |
|
99 | :type push_uri: str | |
|
98 | 100 | :param landing_rev: <rev_type>:<rev> |
|
99 | 101 | :type landing_rev: str |
|
100 | 102 | :param enable_locking: |
@@ -789,7 +791,7 b' maintenance' | |||
|
789 | 791 | pull |
|
790 | 792 | ---- |
|
791 | 793 | |
|
792 | .. py:function:: pull(apiuser, repoid) | |
|
794 | .. py:function:: pull(apiuser, repoid, remote_uri=<Optional:None>) | |
|
793 | 795 | |
|
794 | 796 | Triggers a pull on the given repository from a remote location. You |
|
795 | 797 | can use this to keep remote repositories up-to-date. |
@@ -804,6 +806,8 b' pull' | |||
|
804 | 806 | :type apiuser: AuthUser |
|
805 | 807 | :param repoid: The repository name or repository ID. |
|
806 | 808 | :type repoid: str or int |
|
809 | :param remote_uri: Optional remote URI to pass in for pull | |
|
810 | :type remote_uri: str | |
|
807 | 811 | |
|
808 | 812 | Example output: |
|
809 | 813 | |
@@ -811,7 +815,7 b' pull' | |||
|
811 | 815 | |
|
812 | 816 | id : <id_given_in_input> |
|
813 | 817 | result : { |
|
814 | "msg": "Pulled from `<repository name>`" | |
|
818 | "msg": "Pulled from url `<remote_url>` on repo `<repository name>`" | |
|
815 | 819 | "repository": "<repository name>" |
|
816 | 820 | } |
|
817 | 821 | error : null |
@@ -823,7 +827,7 b' pull' | |||
|
823 | 827 | id : <id_given_in_input> |
|
824 | 828 | result : null |
|
825 | 829 | error : { |
|
826 |
"Unable to pu |
|
|
830 | "Unable to push changes from `<remote_url>`" | |
|
827 | 831 | } |
|
828 | 832 | |
|
829 | 833 | |
@@ -976,7 +980,7 b' strip' | |||
|
976 | 980 | update_repo |
|
977 | 981 | ----------- |
|
978 | 982 | |
|
979 | .. py:function:: update_repo(apiuser, repoid, repo_name=<Optional:None>, owner=<Optional:<OptionalAttr:apiuser>>, description=<Optional:''>, private=<Optional:False>, clone_uri=<Optional:None>, landing_rev=<Optional:'rev:tip'>, fork_of=<Optional:None>, enable_statistics=<Optional:False>, enable_locking=<Optional:False>, enable_downloads=<Optional:False>, fields=<Optional:''>) | |
|
983 | .. py:function:: update_repo(apiuser, repoid, repo_name=<Optional:None>, owner=<Optional:<OptionalAttr:apiuser>>, description=<Optional:''>, private=<Optional:False>, clone_uri=<Optional:None>, push_uri=<Optional:None>, landing_rev=<Optional:'rev:tip'>, fork_of=<Optional:None>, enable_statistics=<Optional:False>, enable_locking=<Optional:False>, enable_downloads=<Optional:False>, fields=<Optional:''>) | |
|
980 | 984 | |
|
981 | 985 | Updates a repository with the given information. |
|
982 | 986 |
@@ -51,7 +51,7 b' add_user_to_user_group' | |||
|
51 | 51 | create_user_group |
|
52 | 52 | ----------------- |
|
53 | 53 | |
|
54 | .. py:function:: create_user_group(apiuser, group_name, description=<Optional:''>, owner=<Optional:<OptionalAttr:apiuser>>, active=<Optional:True>) | |
|
54 | .. py:function:: create_user_group(apiuser, group_name, description=<Optional:''>, owner=<Optional:<OptionalAttr:apiuser>>, active=<Optional:True>, sync=<Optional:None>) | |
|
55 | 55 | |
|
56 | 56 | Creates a new user group. |
|
57 | 57 | |
@@ -71,6 +71,9 b' create_user_group' | |||
|
71 | 71 | :type owner: Optional(str or int) |
|
72 | 72 | :param active: Set this group as active. |
|
73 | 73 | :type active: Optional(``True`` | ``False``) |
|
74 | :param sync: Set enabled or disabled the automatically sync from | |
|
75 | external authentication types like ldap. | |
|
76 | :type sync: Optional(``True`` | ``False``) | |
|
74 | 77 | |
|
75 | 78 | Example output: |
|
76 | 79 | |
@@ -368,7 +371,7 b' revoke_user_permission_from_user_group' | |||
|
368 | 371 | update_user_group |
|
369 | 372 | ----------------- |
|
370 | 373 | |
|
371 | .. py:function:: update_user_group(apiuser, usergroupid, group_name=<Optional:''>, description=<Optional:''>, owner=<Optional:None>, active=<Optional:True>) | |
|
374 | .. py:function:: update_user_group(apiuser, usergroupid, group_name=<Optional:''>, description=<Optional:''>, owner=<Optional:None>, active=<Optional:True>, sync=<Optional:None>) | |
|
372 | 375 | |
|
373 | 376 | Updates the specified `user group` with the details provided. |
|
374 | 377 | |
@@ -387,6 +390,9 b' update_user_group' | |||
|
387 | 390 | :type owner: Optional(str or int) |
|
388 | 391 | :param active: Set the group as active. |
|
389 | 392 | :type active: Optional(``True`` | ``False``) |
|
393 | :param sync: Set enabled or disabled the automatically sync from | |
|
394 | external authentication types like ldap. | |
|
395 | :type sync: Optional(``True`` | ``False``) | |
|
390 | 396 | |
|
391 | 397 | Example output: |
|
392 | 398 |
General Comments 0
You need to be logged in to leave comments.
Login now