← 返回首页
docs(api-usage): fix GitLab API links to the publicly accessible URLs · python-gitlab/python-gitlab@f55fa15 · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

Commit f55fa15

Browse files
allen0099
authored and
nejch
committed
docs(api-usage): fix GitLab API links to the publicly accessible URLs
1 parent 9ba9ac0 commit f55fa15

72 files changed

Lines changed: 169 additions & 169 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api-usage.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab``
1616
access token.
1717

1818
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/.
2020

2121
.. code-block:: python
2222
@@ -39,7 +39,7 @@ To connect to GitLab.com or another GitLab instance, create a ``gitlab.Gitlab``
3939
4040
# 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
-------------------------------
8484

8585
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.
8888

8989
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)
365365
366366
Reference:
367-
https://docs.gitlab.com/ce/api/README.html#keyset-based-pagination
367+
https://docs.gitlab.com/api/rest/#keyset-based-pagination
368368

369369
``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``.
393393

394394
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
396396

397397
.. note::
398398
Prior to python-gitlab 3.6.0 the argument ``as_list`` was used instead of

‎docs/cli-usage.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,14 +165,14 @@ We recommend that you use `Credential helpers`_ to securely store your tokens.
165165
* - ``private_token``
166166
- Your user token. Login/password is not supported. Refer to `the
167167
official documentation
168-
<https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html>`__
168+
<https://docs.gitlab.com/user/profile/personal_access_tokens>`__
169169
to learn how to obtain a token.
170170
* - ``oauth_token``
171171
- An Oauth token for authentication. The Gitlab server must be configured
172172
to support this authentication method.
173173
* - ``job_token``
174174
- Your job token. See `the official documentation
175-
<https://docs.gitlab.com/ce/api/jobs.html#get-job-artifacts>`__
175+
<https://docs.gitlab.com/api/jobs#get-job-artifacts>`__
176176
to learn how to obtain a token.
177177
* - ``api_version``
178178
- GitLab API version to use. Only ``4`` is available since 1.5.0.

‎docs/gl_objects/access_requests.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ References
2525
+ :class:`gitlab.v4.objects.GroupAccessRequestManager`
2626
+ :attr:`gitlab.v4.objects.Group.accessrequests`
2727

28-
* GitLab API: https://docs.gitlab.com/ce/api/access_requests.html
28+
* GitLab API: https://docs.gitlab.com/api/access_requests
2929

3030
Examples
3131
--------

‎docs/gl_objects/appearance.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Reference
1111
+ :class:`gitlab.v4.objects.ApplicationAppearanceManager`
1212
+ :attr:`gitlab.Gitlab.appearance`
1313

14-
* GitLab API: https://docs.gitlab.com/ce/api/appearance.html
14+
* GitLab API: https://docs.gitlab.com/api/appearance
1515

1616
Examples
1717
--------

‎docs/gl_objects/applications.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Reference
1111
+ :class:`gitlab.v4.objects.ApplicationManager`
1212
+ :attr:`gitlab.Gitlab.applications`
1313

14-
* GitLab API: https://docs.gitlab.com/ce/api/applications.html
14+
* GitLab API: https://docs.gitlab.com/api/applications
1515

1616
Examples
1717
--------

‎docs/gl_objects/badges.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ Reference
1818

1919
* GitLab API:
2020

21-
+ https://docs.gitlab.com/ce/api/group_badges.html
22-
+ https://docs.gitlab.com/ce/api/project_badges.html
21+
+ https://docs.gitlab.com/api/group_badges
22+
+ https://docs.gitlab.com/api/project_badges
2323

2424
Examples
2525
--------

‎docs/gl_objects/boards.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Reference
2323

2424
* GitLab API:
2525

26-
+ https://docs.gitlab.com/ce/api/boards.html
27-
+ https://docs.gitlab.com/ce/api/group_boards.html
26+
+ https://docs.gitlab.com/api/boards
27+
+ https://docs.gitlab.com/api/group_boards
2828

2929
Examples
3030
--------
@@ -72,8 +72,8 @@ Reference
7272

7373
* GitLab API:
7474

75-
+ https://docs.gitlab.com/ce/api/boards.html
76-
+ https://docs.gitlab.com/ce/api/group_boards.html
75+
+ https://docs.gitlab.com/api/boards
76+
+ https://docs.gitlab.com/api/group_boards
7777

7878
Examples
7979
--------

‎docs/gl_objects/branches.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ References
1111
+ :class:`gitlab.v4.objects.ProjectBranchManager`
1212
+ :attr:`gitlab.v4.objects.Project.branches`
1313

14-
* GitLab API: https://docs.gitlab.com/ce/api/branches.html
14+
* GitLab API: https://docs.gitlab.com/api/branches
1515

1616
Examples
1717
--------

‎docs/gl_objects/bulk_imports.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ References
1717
+ :class:`gitlab.v4.objects.BulkImportEntityManager`
1818
+ :attr:`gitlab.v4.objects.BulkImport.entities`
1919

20-
* GitLab API: https://docs.gitlab.com/ee/api/bulk_imports.html
20+
* GitLab API: https://docs.gitlab.com/api/bulk_imports
2121

2222
Examples
2323
--------

‎docs/gl_objects/ci_lint.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Reference
1414
+ :class:`gitlab.v4.objects.ProjectCiLintManager`
1515
+ :attr:`gitlab.v4.objects.Project.ci_lint`
1616

17-
* GitLab API: https://docs.gitlab.com/ee/api/lint.html
17+
* GitLab API: https://docs.gitlab.com/api/lint
1818

1919
Examples
2020
---------

0 commit comments

Comments
 (0)

Footer

© 2026 GitHub, Inc.