summaryrefslogtreecommitdiff
path: root/docs/switching-to-v4.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2019-06-08 09:46:49 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2019-06-08 09:46:49 +0200
commit792766319f7c43004460fc9b975549be55430987 (patch)
tree5d23232c7222828def3da1e0e6016c923a620dc3 /docs/switching-to-v4.rst
parent794d64c8ef8ef0448205b51ff4a25c1589c2b2dd (diff)
downloadgitlab-no-more-v3.tar.gz
docs: remove v3 supportno-more-v3
Diffstat (limited to 'docs/switching-to-v4.rst')
-rw-r--r--docs/switching-to-v4.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/switching-to-v4.rst b/docs/switching-to-v4.rst
index e6490e3..b3de224 100644
--- a/docs/switching-to-v4.rst
+++ b/docs/switching-to-v4.rst
@@ -8,7 +8,7 @@ GitLab provides a new API version (v4) since its 9.0 release. ``python-gitlab``
provides support for this new version, but the python API has been modified to
solve some problems with the existing one.
-GitLab will stop supporting the v3 API soon, and you should consider switching
+GitLab does not support the v3 API anymore, and you should consider switching
to v4 if you use a recent version of GitLab (>= 9.0), or if you use
https://gitlab.com.
@@ -16,16 +16,16 @@ https://gitlab.com.
Using the v4 API
================
-python-gitlab uses the v4 API by default since the 1.3.0 release. To use the
-old v3 API, explicitly define ``api_version`` in the ``Gitlab`` constructor:
+python-gitlab uses the v4 API by default since the 1.3.0 release. If you are
+migrating from an older release, make sure that you remove the ``api_version``
+definition in you constructors and configuration file:
+
+The following examples are **not valid** anymore:
.. code-block:: python
gl = gitlab.Gitlab(..., api_version=3)
-
-If you use the configuration file, also explicitly define the version:
-
.. code-block:: ini
[my_gitlab]