Skip to content

Commit f55fa15

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

Some content is hidden

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

72 files changed

+169
-169
lines changed

‎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
---------

‎docs/gl_objects/cluster_agents.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Reference
1717
+ :class:`gitlab.v4.objects.ProjectClusterAgentManager`
1818
+ :attr:`gitlab.v4.objects.Project.cluster_agents`
1919

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

2222
Examples
2323
--------

‎docs/gl_objects/clusters.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Reference
1919
+ :class:`gitlab.v4.objects.GroupClusterManager`
2020
+ :attr:`gitlab.v4.objects.Group.clusters`
2121

22-
* GitLab API: https://docs.gitlab.com/ee/api/project_clusters.html
23-
* GitLab API: https://docs.gitlab.com/ee/api/group_clusters.html
22+
* GitLab API: https://docs.gitlab.com/api/project_clusters
23+
* GitLab API: https://docs.gitlab.com/api/group_clusters
2424

2525
Examples
2626
--------

‎docs/gl_objects/commits.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ List all commits for a project (see :ref:`pagination`) on all branches:
3333

3434
Create a commit::
3535

36-
# See https://docs.gitlab.com/ce/api/commits.html#create-a-commit-with-multiple-files-and-actions
36+
# See https://docs.gitlab.com/api/commits#create-a-commit-with-multiple-files-and-actions
3737
# for actions detail
3838
data = {
3939
'branch': 'main',
@@ -98,7 +98,7 @@ Reference
9898
+ :class:`gitlab.v4.objects.ProjectCommitCommentManager`
9999
+ :attr:`gitlab.v4.objects.ProjectCommit.comments`
100100

101-
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
101+
* GitLab API: https://docs.gitlab.com/api/commits
102102

103103
Examples
104104
--------
@@ -129,7 +129,7 @@ Reference
129129
+ :class:`gitlab.v4.objects.ProjectCommitStatusManager`
130130
+ :attr:`gitlab.v4.objects.ProjectCommit.statuses`
131131

132-
* GitLab API: https://docs.gitlab.com/ce/api/commits.html
132+
* GitLab API: https://docs.gitlab.com/api/commits
133133

134134
Examples
135135
--------

‎docs/gl_objects/deploy_keys.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Reference
1414
+ :class:`gitlab.v4.objects.DeployKeyManager`
1515
+ :attr:`gitlab.Gitlab.deploykeys`
1616

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

1919
Examples
2020
--------
@@ -41,7 +41,7 @@ Reference
4141
+ :class:`gitlab.v4.objects.ProjectKeyManager`
4242
+ :attr:`gitlab.v4.objects.Project.keys`
4343

44-
* GitLab API: https://docs.gitlab.com/ce/api/deploy_keys.html
44+
* GitLab API: https://docs.gitlab.com/api/deploy_keys
4545

4646
Examples
4747
--------

‎docs/gl_objects/deploy_tokens.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Reference
1919
+ :class:`gitlab.v4.objects.DeployTokenManager`
2020
+ :attr:`gitlab.Gitlab.deploytokens`
2121

22-
* GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html
22+
* GitLab API: https://docs.gitlab.com/api/deploy_tokens
2323

2424
Examples
2525
--------
@@ -45,7 +45,7 @@ Reference
4545
+ :class:`gitlab.v4.objects.ProjectDeployTokenManager`
4646
+ :attr:`gitlab.v4.objects.Project.deploytokens`
4747

48-
* GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html#project-deploy-tokens
48+
* GitLab API: https://docs.gitlab.com/api/deploy_tokens#project-deploy-tokens
4949

5050
Examples
5151
--------
@@ -102,7 +102,7 @@ Reference
102102
+ :class:`gitlab.v4.objects.GroupDeployTokenManager`
103103
+ :attr:`gitlab.v4.objects.Group.deploytokens`
104104

105-
* GitLab API: https://docs.gitlab.com/ce/api/deploy_tokens.html#group-deploy-tokens
105+
* GitLab API: https://docs.gitlab.com/api/deploy_tokens#group-deploy-tokens
106106

107107
Examples
108108
--------

‎docs/gl_objects/deployments.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Reference
1111
+ :class:`gitlab.v4.objects.ProjectDeploymentManager`
1212
+ :attr:`gitlab.v4.objects.Project.deployments`
1313

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

1616
Examples
1717
--------
@@ -64,7 +64,7 @@ Reference
6464
+ :class:`gitlab.v4.objects.ProjectDeploymentMergeRequestManager`
6565
+ :attr:`gitlab.v4.objects.ProjectDeployment.mergerequests`
6666

67-
* GitLab API: https://docs.gitlab.com/ee/api/deployments.html#list-of-merge-requests-associated-with-a-deployment
67+
* GitLab API: https://docs.gitlab.com/api/deployments#list-of-merge-requests-associated-with-a-deployment
6868

6969
Examples
7070
--------

‎docs/gl_objects/discussions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Reference
3737
+ :class:`gitlab.v4.objects.ProjectSnippetDiscussionNoteManager`
3838
+ :attr:`gitlab.v4.objects.ProjectSnippet.notes`
3939

40-
* GitLab API: https://docs.gitlab.com/ce/api/discussions.html
40+
* GitLab API: https://docs.gitlab.com/api/discussions
4141

4242
Examples
4343
========

‎docs/gl_objects/draft_notes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Reference
1818
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.draft_notes`
1919

2020

21-
* GitLab API: https://docs.gitlab.com/ee/api/draft_notes.html
21+
* GitLab API: https://docs.gitlab.com/api/draft_notes
2222

2323
Examples
2424
--------

‎docs/gl_objects/emojis.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Reference
2121
+ :class:`gitlab.v4.objects.ProjectSnippetNoteAwardEmojiManager`
2222

2323

24-
* GitLab API: https://docs.gitlab.com/ce/api/award_emoji.html
24+
* GitLab API: https://docs.gitlab.com/api/emoji_reactions/
2525

2626
Examples
2727
--------

‎docs/gl_objects/environments.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.ProjectEnvironmentManager`
1212
+ :attr:`gitlab.v4.objects.Project.environments`
1313

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

1616
Examples
1717
--------

‎docs/gl_objects/epics.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Reference
1414
+ :class:`gitlab.v4.objects.GroupEpicManager`
1515
+ :attr:`gitlab.Gitlab.Group.epics`
1616

17-
* GitLab API: https://docs.gitlab.com/ee/api/epics.html (EE feature)
17+
* GitLab API: https://docs.gitlab.com/api/epics (EE feature)
1818

1919
Examples
2020
--------
@@ -53,7 +53,7 @@ Reference
5353
+ :class:`gitlab.v4.objects.GroupEpicIssueManager`
5454
+ :attr:`gitlab.Gitlab.GroupEpic.issues`
5555

56-
* GitLab API: https://docs.gitlab.com/ee/api/epic_issues.html (EE feature)
56+
* GitLab API: https://docs.gitlab.com/api/epic_issues (EE feature)
5757

5858
Examples
5959
--------

‎docs/gl_objects/events.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Reference
2020
+ :class:`gitlab.v4.objects.UserEventManager`
2121
+ :attr:`gitlab.v4.objects.User.events`
2222

23-
* GitLab API: https://docs.gitlab.com/ce/api/events.html
23+
* GitLab API: https://docs.gitlab.com/api/events/
2424

2525
Examples
2626
--------
@@ -29,7 +29,7 @@ You can list events for an entire Gitlab instance (admin), users and projects.
2929
You can filter you events you want to retrieve using the ``action`` and
3030
``target_type`` attributes. The possible values for these attributes are
3131
available on `the gitlab documentation
32-
<https://docs.gitlab.com/ce/api/events.html>`_.
32+
<https://docs.gitlab.com/api/events/>`_.
3333

3434
List all the events (paginated)::
3535

@@ -58,7 +58,7 @@ Reference
5858
+ :class:`gitlab.v4.objects.ProjectMergeRequestResourceStateEventManager`
5959
+ :attr:`gitlab.v4.objects.ProjectMergeRequest.resourcestateevents`
6060

61-
* GitLab API: https://docs.gitlab.com/ee/api/resource_state_events.html
61+
* GitLab API: https://docs.gitlab.com/api/resource_state_events
6262

6363
Examples
6464
--------

‎docs/gl_objects/features.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.FeatureManager`
1212
+ :attr:`gitlab.Gitlab.features`
1313

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

1616
Examples
1717
--------

‎docs/gl_objects/geo_nodes.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.GeoNodeManager`
1212
+ :attr:`gitlab.Gitlab.geonodes`
1313

14-
* GitLab API: https://docs.gitlab.com/ee/api/geo_nodes.html (EE feature)
14+
* GitLab API: https://docs.gitlab.com/api/geo_nodes (EE feature)
1515

1616
Examples
1717
--------

‎docs/gl_objects/group_access_tokens.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ References
1313
+ :class:`gitlab.v4.objects.GroupAccessTokenManager`
1414
+ :attr:`gitlab.Gitlab.group_access_tokens`
1515

16-
* GitLab API: https://docs.gitlab.com/ee/api/group_access_tokens.html
16+
* GitLab API: https://docs.gitlab.com/api/group_access_tokens
1717

1818
Examples
1919
--------

0 commit comments

Comments
 (0)