docs: update api generated documentation
This commit is contained in:
Marcin Kuzminski
parent
79d2ab8dbd
commit
deae0175dc
5 changed files with 67 additions and 8 deletions
|
|
@ -196,6 +196,7 @@ are not required in args.
|
|||
.. --- API DEFS MARKER ---
|
||||
.. toctree::
|
||||
|
||||
methods/views
|
||||
methods/license-methods
|
||||
methods/deprecated-methods
|
||||
methods/gist-methods
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ changeset_comment
|
|||
|
||||
Example error output:
|
||||
|
||||
.. code-block:: javascript
|
||||
.. code-block:: json
|
||||
|
||||
{
|
||||
"id" : <id_given_in_input>,
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ comment_commit
|
|||
create_repo
|
||||
-----------
|
||||
|
||||
.. 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>)
|
||||
.. 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>)
|
||||
|
||||
Creates a repository.
|
||||
|
||||
|
|
@ -95,6 +95,8 @@ create_repo
|
|||
:type private: bool
|
||||
:param clone_uri: set clone_uri
|
||||
:type clone_uri: str
|
||||
:param push_uri: set push_uri
|
||||
:type push_uri: str
|
||||
:param landing_rev: <rev_type>:<rev>
|
||||
:type landing_rev: str
|
||||
:param enable_locking:
|
||||
|
|
@ -789,7 +791,7 @@ maintenance
|
|||
pull
|
||||
----
|
||||
|
||||
.. py:function:: pull(apiuser, repoid)
|
||||
.. py:function:: pull(apiuser, repoid, remote_uri=<Optional:None>)
|
||||
|
||||
Triggers a pull on the given repository from a remote location. You
|
||||
can use this to keep remote repositories up-to-date.
|
||||
|
|
@ -804,6 +806,8 @@ pull
|
|||
:type apiuser: AuthUser
|
||||
:param repoid: The repository name or repository ID.
|
||||
:type repoid: str or int
|
||||
:param remote_uri: Optional remote URI to pass in for pull
|
||||
:type remote_uri: str
|
||||
|
||||
Example output:
|
||||
|
||||
|
|
@ -811,7 +815,7 @@ pull
|
|||
|
||||
id : <id_given_in_input>
|
||||
result : {
|
||||
"msg": "Pulled from `<repository name>`"
|
||||
"msg": "Pulled from url `<remote_url>` on repo `<repository name>`"
|
||||
"repository": "<repository name>"
|
||||
}
|
||||
error : null
|
||||
|
|
@ -823,7 +827,7 @@ pull
|
|||
id : <id_given_in_input>
|
||||
result : null
|
||||
error : {
|
||||
"Unable to pull changes from `<reponame>`"
|
||||
"Unable to push changes from `<remote_url>`"
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -976,7 +980,7 @@ strip
|
|||
update_repo
|
||||
-----------
|
||||
|
||||
.. 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:''>)
|
||||
.. 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:''>)
|
||||
|
||||
Updates a repository with the given information.
|
||||
|
||||
|
|
|
|||
|
|
@ -51,7 +51,7 @@ add_user_to_user_group
|
|||
create_user_group
|
||||
-----------------
|
||||
|
||||
.. py:function:: create_user_group(apiuser, group_name, description=<Optional:''>, owner=<Optional:<OptionalAttr:apiuser>>, active=<Optional:True>)
|
||||
.. py:function:: create_user_group(apiuser, group_name, description=<Optional:''>, owner=<Optional:<OptionalAttr:apiuser>>, active=<Optional:True>, sync=<Optional:None>)
|
||||
|
||||
Creates a new user group.
|
||||
|
||||
|
|
@ -71,6 +71,9 @@ create_user_group
|
|||
:type owner: Optional(str or int)
|
||||
:param active: Set this group as active.
|
||||
:type active: Optional(``True`` | ``False``)
|
||||
:param sync: Set enabled or disabled the automatically sync from
|
||||
external authentication types like ldap.
|
||||
:type sync: Optional(``True`` | ``False``)
|
||||
|
||||
Example output:
|
||||
|
||||
|
|
@ -368,7 +371,7 @@ revoke_user_permission_from_user_group
|
|||
update_user_group
|
||||
-----------------
|
||||
|
||||
.. py:function:: update_user_group(apiuser, usergroupid, group_name=<Optional:''>, description=<Optional:''>, owner=<Optional:None>, active=<Optional:True>)
|
||||
.. py:function:: update_user_group(apiuser, usergroupid, group_name=<Optional:''>, description=<Optional:''>, owner=<Optional:None>, active=<Optional:True>, sync=<Optional:None>)
|
||||
|
||||
Updates the specified `user group` with the details provided.
|
||||
|
||||
|
|
@ -387,6 +390,9 @@ update_user_group
|
|||
:type owner: Optional(str or int)
|
||||
:param active: Set the group as active.
|
||||
:type active: Optional(``True`` | ``False``)
|
||||
:param sync: Set enabled or disabled the automatically sync from
|
||||
external authentication types like ldap.
|
||||
:type sync: Optional(``True`` | ``False``)
|
||||
|
||||
Example output:
|
||||
|
||||
|
|
|
|||
48
docs/api/methods/views.rst
Normal file
48
docs/api/methods/views.rst
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
.. _views-ref:
|
||||
|
||||
views
|
||||
=====
|
||||
|
||||
push (EE only)
|
||||
--------------
|
||||
|
||||
.. py:function:: push(apiuser, repoid, remote_uri=<Optional:None>)
|
||||
|
||||
Triggers a push on the given repository from a remote location. You
|
||||
can use this to keep remote repositories up-to-date.
|
||||
|
||||
This command can only be run using an |authtoken| with admin
|
||||
rights to the specified repository. For more information,
|
||||
see :ref:`config-token-ref`.
|
||||
|
||||
This command takes the following options:
|
||||
|
||||
:param apiuser: This is filled automatically from the |authtoken|.
|
||||
:type apiuser: AuthUser
|
||||
:param repoid: The repository name or repository ID.
|
||||
:type repoid: str or int
|
||||
:param remote_uri: Optional remote URI to pass in for push
|
||||
:type remote_uri: str
|
||||
|
||||
Example output:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
id : <id_given_in_input>
|
||||
result : {
|
||||
"msg": "Pushed to url `<remote_url>` on repo `<repository name>`"
|
||||
"repository": "<repository name>"
|
||||
}
|
||||
error : null
|
||||
|
||||
Example error output:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
id : <id_given_in_input>
|
||||
result : null
|
||||
error : {
|
||||
"Unable to push changes to `<remote_url>`"
|
||||
}
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue