Home Original page

docs(api-usage): fix GitLab API links to the publicly accessible URLs · python-gitlab/python-gitlab@f55fa15

@@ -16,7 +16,7 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab``

1616

access token.

17171818

For the full list of available options and how to obtain these tokens, please see

19-

https://docs.gitlab.com/ee/api/rest/authentication.html.

19+

https://docs.gitlab.com/api/rest/authentication/.

20202121

.. code-block:: python

2222

@@ -39,7 +39,7 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab``

39394040

# job token authentication (to be used in CI)

4141

# bear in mind the limitations of the API endpoints it supports:

42-

# https://docs.gitlab.com/ee/ci/jobs/ci_job_token.html

42+

# https://docs.gitlab.com/ci/jobs/ci_job_token

4343

import os

4444

gl = gitlab.Gitlab('https://gitlab.example.com', job_token=os.environ['CI_JOB_TOKEN'])

4545

@@ -83,7 +83,7 @@ Note on password authentication

8383

-------------------------------

84848585

GitLab has long removed password-based basic authentication. You can currently still use the

86-

`resource owner password credentials <https://docs.gitlab.com/ee/api/oauth2.html#resource-owner-password-credentials-flow>`_

86+

`resource owner password credentials <https://docs.gitlab.com/api/oauth2#resource-owner-password-credentials-flow>`_

8787

flow to obtain an OAuth token.

88888989

However, we do not recommend this as it will not work with 2FA enabled, and GitLab is removing

@@ -364,7 +364,7 @@ order options. At the time of writing, only ``order_by="id"`` works.

364364

gl.projects.list(get_all=True)

365365366366

Reference:

367-

https://docs.gitlab.com/ce/api/README.html#keyset-based-pagination

367+

https://docs.gitlab.com/api/rest/#keyset-based-pagination

368368369369

``list()`` methods can also return a generator object, by passing the argument

370370

``iterator=True``, which will handle the next calls to the API when required. This

@@ -392,7 +392,7 @@ The generator exposes extra listing information as received from the server:

392392

``total_pages`` and ``total`` will have a value of ``None``.

393393394394

For more information see:

395-

https://docs.gitlab.com/ee/user/gitlab_com/index.html#pagination-response-headers

395+

https://docs.gitlab.com/user/gitlab_com/index#pagination-response-headers

396396397397

.. note::

398398

Prior to python-gitlab 3.6.0 the argument ``as_list`` was used instead of