diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-11-23 17:17:31 +0100 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-11-23 17:17:31 +0100 |
commit | 87a267d7a97bc50d11b2e34dd360c4212de952f6 (patch) | |
tree | e281e43a47d175c422d0644c658f5790b14b2b9a | |
parent | b69c2c11230d274fd9e6228fdcacc514f15b638f (diff) | |
download | gitlab-ce-docs/note-gitlab-com-api.tar.gz |
Add a note that the API of `https://gitlab.com` cannot always be useddocs/note-gitlab-com-api
[ci skip]
47 files changed, 47 insertions, 47 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index d65a9952742..05881082eff 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). Automate GitLab via a simple and powerful API. All definitions can be found under [`/lib/api`](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api). diff --git a/doc/api/access_requests.md b/doc/api/access_requests.md index 49a61c02f16..fd47c29feb4 100644 --- a/doc/api/access_requests.md +++ b/doc/api/access_requests.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). >Introduced in GitLab 8.11. diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 9081820b305..ec6c9c7c8cb 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). >[Introduced][ce-4575] in GitLab 8.9, snippet support in 8.12. diff --git a/doc/api/boards.md b/doc/api/boards.md index fd330b6047f..f893b6723a1 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). Every API call to boards must be authenticated. diff --git a/doc/api/branches.md b/doc/api/branches.md index 35e0918a3a4..85690ebb354 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List repository branches diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index 2729e09c51c..0ce58c3d519 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). >Introduced in GitLab 8.12. diff --git a/doc/api/build_triggers.md b/doc/api/build_triggers.md index c98001b6039..42d3d3e1ccb 100644 --- a/doc/api/build_triggers.md +++ b/doc/api/build_triggers.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). You can read more about [triggering builds through the API](../ci/triggers/README.md). diff --git a/doc/api/build_variables.md b/doc/api/build_variables.md index 46bb21ba31c..63fb6ce8f6c 100644 --- a/doc/api/build_variables.md +++ b/doc/api/build_variables.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List project variables diff --git a/doc/api/builds.md b/doc/api/builds.md index 4072f3ca76f..9a2638db119 100644 --- a/doc/api/builds.md +++ b/doc/api/builds.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List project builds diff --git a/doc/api/ci/README.md b/doc/api/ci/README.md index 5f46f4225ca..b039a930d3e 100644 --- a/doc/api/ci/README.md +++ b/doc/api/ci/README.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## Purpose diff --git a/doc/api/ci/builds.md b/doc/api/ci/builds.md index 4686b95c4f7..0a7db894ac3 100644 --- a/doc/api/ci/builds.md +++ b/doc/api/ci/builds.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). API used by runners to receive and update builds. diff --git a/doc/api/ci/lint.md b/doc/api/ci/lint.md index d377ceabc18..6a29d42896c 100644 --- a/doc/api/ci/lint.md +++ b/doc/api/ci/lint.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). > [Introduced][ce-5953] in GitLab 8.12. diff --git a/doc/api/ci/runners.md b/doc/api/ci/runners.md index b0783aa6cff..4c3fa5a8598 100644 --- a/doc/api/ci/runners.md +++ b/doc/api/ci/runners.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). API used by Runners to register and delete themselves. diff --git a/doc/api/commits.md b/doc/api/commits.md index 13d9cca55d5..43426a652e8 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List repository commits diff --git a/doc/api/deploy_key_multiple_projects.md b/doc/api/deploy_key_multiple_projects.md index e20012d59e4..43cd4aecf64 100644 --- a/doc/api/deploy_key_multiple_projects.md +++ b/doc/api/deploy_key_multiple_projects.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). If you want to easily add the same deploy key to multiple projects in the same group, this can be achieved quite easily with the API. diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md index 8c9f263876a..0cf34b1c83f 100644 --- a/doc/api/deploy_keys.md +++ b/doc/api/deploy_keys.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List all deploy keys diff --git a/doc/api/deployments.md b/doc/api/deployments.md index 3cda1204b00..346ac789151 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List project deployments diff --git a/doc/api/enviroments.md b/doc/api/enviroments.md index cbe98610219..05141ba1064 100644 --- a/doc/api/enviroments.md +++ b/doc/api/enviroments.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List environments diff --git a/doc/api/groups.md b/doc/api/groups.md index 9e5cf60c959..eff110d3bfc 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List groups diff --git a/doc/api/issues.md b/doc/api/issues.md index a83de501f80..bcbe4a84439 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). Every API call to issues must be authenticated. diff --git a/doc/api/keys.md b/doc/api/keys.md index 0e62a6ced3a..f6f278c27c4 100644 --- a/doc/api/keys.md +++ b/doc/api/keys.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## Get SSH key with user by ID of an SSH key diff --git a/doc/api/labels.md b/doc/api/labels.md index ba549e9c0d7..10bbea5ba76 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List labels diff --git a/doc/api/members.md b/doc/api/members.md index ebedfaf6de9..baef85802c6 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). **Valid access levels** diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 8c2e72551c3..b07b3fc1bdf 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List merge requests diff --git a/doc/api/milestones.md b/doc/api/milestones.md index c09971bb8bd..e6b8cd00f34 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List project milestones diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 1bf69db8c3a..1493925f3ba 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). Usernames and groupnames fall under a special category called namespaces. diff --git a/doc/api/notes.md b/doc/api/notes.md index 21faa46f5ee..871356e0223 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). Notes are comments on snippets, issues or merge requests. diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index f366312c1f1..4a7aa65b734 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). >**Note:** This feature was [introduced][ce-5632] in GitLab 8.12. diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index 282aa511634..dd8344e4b39 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). This document covers using the OAuth2 protocol to access GitLab. diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index b2470cec5c0..df856081930 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List project pipelines diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index fd86dcc93bb..6799b11fd1c 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ### Snippet visibility level diff --git a/doc/api/projects.md b/doc/api/projects.md index be82f3505b6..b66348f32e4 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ### Project visibility level diff --git a/doc/api/repositories.md b/doc/api/repositories.md index 9200fa40758..fe9a8f6dc9c 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List repository tree diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 016cdb94edc..eee3346badf 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). **CRUD for repository files** diff --git a/doc/api/runners.md b/doc/api/runners.md index 077088b2b28..cd09af1e77e 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). > [Introduced][ce-2640] in GitLab 8.5 diff --git a/doc/api/services.md b/doc/api/services.md index d67b82ed169..042a514e8fa 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## Asana diff --git a/doc/api/session.md b/doc/api/session.md index 7688527a646..98359d6f88b 100644 --- a/doc/api/session.md +++ b/doc/api/session.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## Deprecation Notice diff --git a/doc/api/settings.md b/doc/api/settings.md index 1785ac11509..253fc8cfe5d 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). These API calls allow you to read and modify GitLab instance application settings as appear in `/admin/application_settings`. You have to be an diff --git a/doc/api/sidekiq_metrics.md b/doc/api/sidekiq_metrics.md index bf9fb0ffc66..7f1e260e28d 100644 --- a/doc/api/sidekiq_metrics.md +++ b/doc/api/sidekiq_metrics.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). >**Note:** This endpoint is only available on GitLab 8.9 and above. diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index 43726a56750..e9780ba8169 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). All methods require administrator authorization. diff --git a/doc/api/tags.md b/doc/api/tags.md index 4647896052c..265c4d7a37b 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List project repository tags diff --git a/doc/api/templates/gitignores.md b/doc/api/templates/gitignores.md index 449cea23f51..abf38084185 100644 --- a/doc/api/templates/gitignores.md +++ b/doc/api/templates/gitignores.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List gitignore templates diff --git a/doc/api/templates/gitlab_ci_ymls.md b/doc/api/templates/gitlab_ci_ymls.md index e86980b8de1..6a719d7f8e9 100644 --- a/doc/api/templates/gitlab_ci_ymls.md +++ b/doc/api/templates/gitlab_ci_ymls.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List GitLab CI YML templates diff --git a/doc/api/templates/licenses.md b/doc/api/templates/licenses.md index b9525e28f65..a655c8ac3a1 100644 --- a/doc/api/templates/licenses.md +++ b/doc/api/templates/licenses.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List license templates diff --git a/doc/api/todos.md b/doc/api/todos.md index 322388cc4ee..cedd7bf039f 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). > [Introduced][ce-3188] in GitLab 8.10. diff --git a/doc/api/users.md b/doc/api/users.md index 0953b82e901..4161a81d1ce 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). ## List users diff --git a/doc/api/version.md b/doc/api/version.md index 368b579c849..6d39133fcbe 100644 --- a/doc/api/version.md +++ b/doc/api/version.md @@ -3,7 +3,7 @@ >**Note:** The `https://gitlab.example.com` URL that is presented in the examples of the API docs is fictional. Replace it with the URL of your GitLab instance, -or in case of GitLab.com, use `https://gitlab.com`. +or in case of GitLab.com, use `https://gitlab.com` (where applicable). >Introduced in GitLab 8.13. |