Skip to content

docs: remove v3 support #789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2019
Merged

docs: remove v3 support #789

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions docs/api-usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,7 @@
Getting started with the API
############################

python-gitlab supports both GitLab v3 and v4 APIs.

.. note::

To use the v3 make sure to install python-gitlab 1.4. Only the v4 API is
documented here. See the documentation of earlier versions for the v3 API.
python-gitlab only supports GitLab APIs v4.

``gitlab.Gitlab`` class
=======================
Expand Down
3 changes: 1 addition & 2 deletions docs/gl_objects/commits.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ Create a commit::
# See https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions
# for actions detail
data = {
'branch_name': 'master', # v3
'branch': 'master', # v4
'branch': 'master',
'commit_message': 'blah blah blah',
'actions': [
{
Expand Down
12 changes: 6 additions & 6 deletions docs/switching-to-v4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ 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.


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]
Expand Down