summaryrefslogtreecommitdiff
path: root/docs/api-usage.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-05-24 08:20:41 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2017-05-24 08:20:41 +0200
commitf2b94a7f2cef6ca7d5e6d87494ed3e90426d8d2b (patch)
treec01ea39ab979dd8088737b2ded3806a4d3f71799 /docs/api-usage.rst
parent627a6aa0620ec53dcb24a97c0e584d01dcc4d07f (diff)
downloadgitlab-f2b94a7f2cef6ca7d5e6d87494ed3e90426d8d2b.tar.gz
Add v4 support to docs
Diffstat (limited to 'docs/api-usage.rst')
-rw-r--r--docs/api-usage.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
index 4f78df1..eae26db 100644
--- a/docs/api-usage.rst
+++ b/docs/api-usage.rst
@@ -40,6 +40,20 @@ You can also use configuration files to create ``gitlab.Gitlab`` objects:
See the :ref:`cli_configuration` section for more information about
configuration files.
+**GitLab v4 support**
+
+``python-gitlab`` uses the v3 GitLab API by default. Use the ``api_version``
+parameter to switch to v4:
+
+.. code-block:: python
+
+ import gitlab
+
+ gl = gitlab.Gitlab('http://10.0.0.1', 'JVNSESs8EwWRx5yDxM5q', api_version=4)
+
+.. warning::
+
+ The v4 support is experimental.
Managers
========