From 4740848a8783d2744a32c506e69face6fef26a64 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 23 Nov 2016 17:02:12 +0100 Subject: [PATCH 1/3] Add a note in all API docs about the API URL --- doc/api/README.md | 5 +++++ doc/api/access_requests.md | 5 +++++ doc/api/award_emoji.md | 5 +++++ doc/api/boards.md | 5 +++++ doc/api/branches.md | 5 +++++ doc/api/broadcast_messages.md | 5 +++++ doc/api/build_triggers.md | 5 +++++ doc/api/build_variables.md | 5 +++++ doc/api/builds.md | 5 +++++ doc/api/ci/README.md | 5 +++++ doc/api/ci/builds.md | 5 +++++ doc/api/ci/lint.md | 5 +++++ doc/api/ci/runners.md | 5 +++++ doc/api/commits.md | 5 +++++ doc/api/deploy_key_multiple_projects.md | 5 +++++ doc/api/deploy_keys.md | 5 +++++ doc/api/deployments.md | 5 +++++ doc/api/enviroments.md | 5 +++++ doc/api/groups.md | 5 +++++ doc/api/issues.md | 5 +++++ doc/api/keys.md | 5 +++++ doc/api/labels.md | 5 +++++ doc/api/members.md | 5 +++++ doc/api/merge_requests.md | 5 +++++ doc/api/milestones.md | 5 +++++ doc/api/namespaces.md | 5 +++++ doc/api/notes.md | 5 +++++ doc/api/notification_settings.md | 5 +++++ doc/api/oauth2.md | 5 +++++ doc/api/pipelines.md | 5 +++++ doc/api/project_snippets.md | 5 +++++ doc/api/projects.md | 5 +++++ doc/api/repositories.md | 5 +++++ doc/api/repository_files.md | 5 +++++ doc/api/runners.md | 5 +++++ doc/api/services.md | 5 +++++ doc/api/session.md | 5 +++++ doc/api/settings.md | 5 +++++ doc/api/sidekiq_metrics.md | 5 +++++ doc/api/system_hooks.md | 5 +++++ doc/api/tags.md | 5 +++++ doc/api/templates/gitignores.md | 5 +++++ doc/api/templates/gitlab_ci_ymls.md | 5 +++++ doc/api/templates/licenses.md | 5 +++++ doc/api/todos.md | 5 +++++ doc/api/users.md | 5 +++++ doc/api/version.md | 5 +++++ 47 files changed, 235 insertions(+) diff --git a/doc/api/README.md b/doc/api/README.md index f65b934b9dbb..d65a99527429 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -1,5 +1,10 @@ # GitLab API +>**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`. + 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 ea308b54d62d..c14a56a5c449 100644 --- a/doc/api/access_requests.md +++ b/doc/api/access_requests.md @@ -1,5 +1,10 @@ # Group and project access requests +>**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`. + >**Note:** This feature was introduced in GitLab 8.11 **Valid access levels** diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 06111f4ab671..2017727ca19b 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -1,5 +1,10 @@ # Award Emoji +>**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`. + > [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 28681719f431..fd330b6047f0 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -1,5 +1,10 @@ # Boards +>**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`. + Every API call to boards must be authenticated. If a user is not a member of a project and the project is private, a `GET` diff --git a/doc/api/branches.md b/doc/api/branches.md index f68eeb9f86bb..35e0918a3a4a 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -1,5 +1,10 @@ # Branches +>**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`. + ## List repository branches Get a list of repository branches from a project, sorted by name alphabetically. diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index c3a9207a3ae5..fb7d1cf5ddd5 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -1,5 +1,10 @@ # Broadcast Messages +>**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`. + > **Note:** This feature was introduced in GitLab 8.12. The broadcast message API is only accessible to administrators. All requests by diff --git a/doc/api/build_triggers.md b/doc/api/build_triggers.md index 1b7a18401384..c98001b6039f 100644 --- a/doc/api/build_triggers.md +++ b/doc/api/build_triggers.md @@ -1,5 +1,10 @@ # Build triggers +>**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`. + You can read more about [triggering builds through the API](../ci/triggers/README.md). ## List project triggers diff --git a/doc/api/build_variables.md b/doc/api/build_variables.md index a21751a49eab..46bb21ba31c8 100644 --- a/doc/api/build_variables.md +++ b/doc/api/build_variables.md @@ -1,5 +1,10 @@ # Build Variables +>**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`. + ## List project variables Get list of a project's build variables. diff --git a/doc/api/builds.md b/doc/api/builds.md index bca2f9e44ef9..4072f3ca76fc 100644 --- a/doc/api/builds.md +++ b/doc/api/builds.md @@ -1,5 +1,10 @@ # Builds API +>**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`. + ## List project builds Get a list of builds in a project. diff --git a/doc/api/ci/README.md b/doc/api/ci/README.md index 96a281e27c8c..5f46f4225ca9 100644 --- a/doc/api/ci/README.md +++ b/doc/api/ci/README.md @@ -1,5 +1,10 @@ # GitLab CI API +>**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`. + ## Purpose The main purpose of GitLab CI API is to provide the necessary data and context diff --git a/doc/api/ci/builds.md b/doc/api/ci/builds.md index b6d79706a843..4686b95c4f71 100644 --- a/doc/api/ci/builds.md +++ b/doc/api/ci/builds.md @@ -1,5 +1,10 @@ # Builds API +>**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`. + API used by runners to receive and update builds. >**Note:** diff --git a/doc/api/ci/lint.md b/doc/api/ci/lint.md index 0c96b3ee3357..d377ceabc180 100644 --- a/doc/api/ci/lint.md +++ b/doc/api/ci/lint.md @@ -1,5 +1,10 @@ # Validate the .gitlab-ci.yml +>**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`. + > [Introduced][ce-5953] in GitLab 8.12. Checks if your .gitlab-ci.yml file is valid. diff --git a/doc/api/ci/runners.md b/doc/api/ci/runners.md index 16028d1f124c..b0783aa6cff7 100644 --- a/doc/api/ci/runners.md +++ b/doc/api/ci/runners.md @@ -1,5 +1,10 @@ # Runners API +>**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`. + API used by Runners to register and delete themselves. >**Note:** diff --git a/doc/api/commits.md b/doc/api/commits.md index e1ed99d98d37..13d9cca55d56 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -1,5 +1,10 @@ # Commits API +>**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`. + ## List repository commits Get a list of repository commits in a project. diff --git a/doc/api/deploy_key_multiple_projects.md b/doc/api/deploy_key_multiple_projects.md index 73cb4b7ea8c2..e20012d59e4f 100644 --- a/doc/api/deploy_key_multiple_projects.md +++ b/doc/api/deploy_key_multiple_projects.md @@ -1,5 +1,10 @@ # Adding deploy keys to multiple projects +>**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`. + 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 5f248ab6f91b..8c9f263876af 100644 --- a/doc/api/deploy_keys.md +++ b/doc/api/deploy_keys.md @@ -1,5 +1,10 @@ # Deploy Keys +>**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`. + ## List all deploy keys Get a list of all deploy keys across all projects of the GitLab instance. This endpoint requires admin access. diff --git a/doc/api/deployments.md b/doc/api/deployments.md index 3d95c4cde604..3cda1204b004 100644 --- a/doc/api/deployments.md +++ b/doc/api/deployments.md @@ -1,5 +1,10 @@ # Deployments API +>**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`. + ## List project deployments Get a list of deployments in a project. diff --git a/doc/api/enviroments.md b/doc/api/enviroments.md index 87a5fa671249..cbe98610219b 100644 --- a/doc/api/enviroments.md +++ b/doc/api/enviroments.md @@ -1,5 +1,10 @@ # Environments +>**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`. + ## List environments Get all environments for a given project. diff --git a/doc/api/groups.md b/doc/api/groups.md index 5e6f498c365f..9e5cf60c9596 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -1,5 +1,10 @@ # Groups +>**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`. + ## List groups Get a list of groups. (As user: my groups or all available, as admin: all groups). diff --git a/doc/api/issues.md b/doc/api/issues.md index 134263d27b4b..a83de501f80f 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -1,5 +1,10 @@ # Issues +>**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`. + Every API call to issues must be authenticated. If a user is not a member of a project and the project is private, a `GET` diff --git a/doc/api/keys.md b/doc/api/keys.md index b68f08a007d5..0e62a6ced3a1 100644 --- a/doc/api/keys.md +++ b/doc/api/keys.md @@ -1,5 +1,10 @@ # Keys +>**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`. + ## Get SSH key with user by ID of an SSH key Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID of an SSH key. diff --git a/doc/api/labels.md b/doc/api/labels.md index 78686fdcad4d..ba549e9c0d73 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -1,5 +1,10 @@ # Labels +>**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`. + ## List labels Get all labels for a given project. diff --git a/doc/api/members.md b/doc/api/members.md index 6535e9a7801d..ebedfaf6de93 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -1,5 +1,10 @@ # Group and project members +>**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`. + **Valid access levels** The access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized: diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 4cc385e36fe2..8c2e72551c3b 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -1,5 +1,10 @@ # Merge requests +>**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`. + ## List merge requests Get all merge requests for this project. diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 12497acff984..c09971bb8bd1 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -1,5 +1,10 @@ # Milestones +>**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`. + ## List project milestones Returns a list of project milestones. diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 88cd407d792b..1bf69db8c3a2 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -1,5 +1,10 @@ # Namespaces +>**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`. + Usernames and groupnames fall under a special category called namespaces. For users and groups supported API calls see the [users](users.md) and diff --git a/doc/api/notes.md b/doc/api/notes.md index 58d40eecf3e3..21faa46f5ee2 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -1,5 +1,10 @@ # Notes +>**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`. + Notes are comments on snippets, issues or merge requests. ## Issues diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index aea1c12a3927..f366312c1f19 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -1,5 +1,10 @@ # Notification settings +>**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`. + >**Note:** This feature was [introduced][ce-5632] in GitLab 8.12. **Valid notification levels** diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index 5ef5e3f57447..282aa511634d 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -1,5 +1,10 @@ # GitLab as an OAuth2 provider +>**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`. + This document covers using the OAuth2 protocol to access GitLab. If you want GitLab to be an OAuth authentication service provider to sign into other services please see the [Oauth2 provider documentation](../integration/oauth_provider.md). diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 6455c333faf6..b2470cec5c06 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -1,5 +1,10 @@ # Pipelines API +>**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`. + ## List project pipelines > [Introduced][ce-5837] in GitLab 8.11 diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index c6685f54a9d2..fd86dcc93bb7 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -1,5 +1,10 @@ # Project snippets +>**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`. + ### Snippet visibility level Snippets in GitLab can be either private, internal or public. diff --git a/doc/api/projects.md b/doc/api/projects.md index 467a880ac134..be82f3505b6f 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -1,5 +1,10 @@ # Projects +>**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`. + ### Project visibility level diff --git a/doc/api/repositories.md b/doc/api/repositories.md index bcf8b9550445..9200fa407580 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -1,5 +1,10 @@ # Repositories +>**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`. + ## List repository tree Get a list of repository files and directories in a project. diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 1bc6a24e9146..016cdb94edc8 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -1,5 +1,10 @@ # Repository files +>**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`. + **CRUD for repository files** **Create, read, update and delete repository files using this API** diff --git a/doc/api/runners.md b/doc/api/runners.md index 28610762dca8..077088b2b287 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -1,5 +1,10 @@ # Runners API +>**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`. + > [Introduced][ce-2640] in GitLab 8.5 [ce-2640]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2640 diff --git a/doc/api/services.md b/doc/api/services.md index a5d733fe6c7e..d67b82ed1695 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -1,5 +1,10 @@ # Services +>**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`. + ## Asana Asana - Teamwork without email diff --git a/doc/api/session.md b/doc/api/session.md index f776424023e8..7688527a6467 100644 --- a/doc/api/session.md +++ b/doc/api/session.md @@ -1,5 +1,10 @@ # Session +>**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`. + ## Deprecation Notice 1. Starting in GitLab 8.11, this feature has been *disabled* for users with two-factor authentication turned on. diff --git a/doc/api/settings.md b/doc/api/settings.md index 218546aafea0..1785ac11509e 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -1,5 +1,10 @@ # Application settings +>**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`. + These API calls allow you to read and modify GitLab instance application settings as appear in `/admin/application_settings`. You have to be an administrator in order to perform this action. diff --git a/doc/api/sidekiq_metrics.md b/doc/api/sidekiq_metrics.md index 1ae732d40d6c..bf9fb0ffc66d 100644 --- a/doc/api/sidekiq_metrics.md +++ b/doc/api/sidekiq_metrics.md @@ -1,5 +1,10 @@ # Sidekiq Metrics +>**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`. + >**Note:** This endpoint is only available on GitLab 8.9 and above. This API endpoint allows you to retrieve some information about the current state diff --git a/doc/api/system_hooks.md b/doc/api/system_hooks.md index efd23d514bc6..43726a567508 100644 --- a/doc/api/system_hooks.md +++ b/doc/api/system_hooks.md @@ -1,5 +1,10 @@ # System hooks +>**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`. + All methods require administrator authorization. The URL endpoint of the system hooks can also be configured using the UI in diff --git a/doc/api/tags.md b/doc/api/tags.md index 398b080e3f67..4647896052c9 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -1,5 +1,10 @@ # Tags +>**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`. + ## List project repository tags Get a list of repository tags from a project, sorted by name in reverse alphabetical order. diff --git a/doc/api/templates/gitignores.md b/doc/api/templates/gitignores.md index 8235be92b12d..449cea23f51f 100644 --- a/doc/api/templates/gitignores.md +++ b/doc/api/templates/gitignores.md @@ -1,5 +1,10 @@ # Gitignores +>**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`. + ## List gitignore templates Get all gitignore templates. diff --git a/doc/api/templates/gitlab_ci_ymls.md b/doc/api/templates/gitlab_ci_ymls.md index e120016fbe6b..e86980b8de1b 100644 --- a/doc/api/templates/gitlab_ci_ymls.md +++ b/doc/api/templates/gitlab_ci_ymls.md @@ -1,5 +1,10 @@ # GitLab CI YMLs +>**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`. + ## List GitLab CI YML templates Get all GitLab CI YML templates. diff --git a/doc/api/templates/licenses.md b/doc/api/templates/licenses.md index ae7218cf1bdf..b9525e28f655 100644 --- a/doc/api/templates/licenses.md +++ b/doc/api/templates/licenses.md @@ -1,5 +1,10 @@ # Licenses +>**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`. + ## List license templates Get all license templates. diff --git a/doc/api/todos.md b/doc/api/todos.md index a5e818010247..322388cc4ee6 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -1,5 +1,10 @@ # Todos +>**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`. + > [Introduced][ce-3188] in GitLab 8.10. ## Get a list of todos diff --git a/doc/api/users.md b/doc/api/users.md index b38c335490a1..0953b82e9014 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -1,5 +1,10 @@ # Users +>**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`. + ## List users Get a list of users. diff --git a/doc/api/version.md b/doc/api/version.md index 287d17cf97f8..f71c39c9b639 100644 --- a/doc/api/version.md +++ b/doc/api/version.md @@ -1,5 +1,10 @@ # Version API +>**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`. + >**Note:** This feature was introduced in GitLab 8.13 Retrieve version information for this GitLab instance. Responds `200 OK` for -- GitLab From b69c2c11230d274fd9e6228fdcacc514f15b638f Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 23 Nov 2016 17:09:13 +0100 Subject: [PATCH 2/3] Merge notes in API docs [ci skip] --- doc/api/access_requests.md | 6 +++--- doc/api/award_emoji.md | 2 +- doc/api/broadcast_messages.md | 2 +- doc/api/version.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/access_requests.md b/doc/api/access_requests.md index c14a56a5c449..49a61c02f162 100644 --- a/doc/api/access_requests.md +++ b/doc/api/access_requests.md @@ -5,11 +5,11 @@ 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`. - >**Note:** This feature was introduced in GitLab 8.11 +>Introduced in GitLab 8.11. - **Valid access levels** +**Valid access levels** - The access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized: +The access levels are defined in the `Gitlab::Access` module. Currently, these levels are recognized: ``` 10 => Guest access diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 2017727ca19b..9081820b3058 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -5,7 +5,7 @@ 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`. -> [Introduced][ce-4575] in GitLab 8.9, Snippet support in 8.12 +>[Introduced][ce-4575] in GitLab 8.9, snippet support in 8.12. An awarded emoji tells a thousand words, and can be awarded on issues, merge diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index fb7d1cf5ddd5..2729e09c51ca 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -5,7 +5,7 @@ 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`. -> **Note:** This feature was introduced in GitLab 8.12. +>Introduced in GitLab 8.12. The broadcast message API is only accessible to administrators. All requests by guests will respond with `401 Unauthorized`, and all requests by normal users diff --git a/doc/api/version.md b/doc/api/version.md index f71c39c9b639..368b579c849a 100644 --- a/doc/api/version.md +++ b/doc/api/version.md @@ -5,7 +5,7 @@ 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`. ->**Note:** This feature was introduced in GitLab 8.13 +>Introduced in GitLab 8.13. Retrieve version information for this GitLab instance. Responds `200 OK` for authenticated users. -- GitLab From 87a267d7a97bc50d11b2e34dd360c4212de952f6 Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Wed, 23 Nov 2016 17:17:31 +0100 Subject: [PATCH 3/3] Add a note that the API of `https://gitlab.com` cannot always be used [ci skip] --- doc/api/README.md | 2 +- doc/api/access_requests.md | 2 +- doc/api/award_emoji.md | 2 +- doc/api/boards.md | 2 +- doc/api/branches.md | 2 +- doc/api/broadcast_messages.md | 2 +- doc/api/build_triggers.md | 2 +- doc/api/build_variables.md | 2 +- doc/api/builds.md | 2 +- doc/api/ci/README.md | 2 +- doc/api/ci/builds.md | 2 +- doc/api/ci/lint.md | 2 +- doc/api/ci/runners.md | 2 +- doc/api/commits.md | 2 +- doc/api/deploy_key_multiple_projects.md | 2 +- doc/api/deploy_keys.md | 2 +- doc/api/deployments.md | 2 +- doc/api/enviroments.md | 2 +- doc/api/groups.md | 2 +- doc/api/issues.md | 2 +- doc/api/keys.md | 2 +- doc/api/labels.md | 2 +- doc/api/members.md | 2 +- doc/api/merge_requests.md | 2 +- doc/api/milestones.md | 2 +- doc/api/namespaces.md | 2 +- doc/api/notes.md | 2 +- doc/api/notification_settings.md | 2 +- doc/api/oauth2.md | 2 +- doc/api/pipelines.md | 2 +- doc/api/project_snippets.md | 2 +- doc/api/projects.md | 2 +- doc/api/repositories.md | 2 +- doc/api/repository_files.md | 2 +- doc/api/runners.md | 2 +- doc/api/services.md | 2 +- doc/api/session.md | 2 +- doc/api/settings.md | 2 +- doc/api/sidekiq_metrics.md | 2 +- doc/api/system_hooks.md | 2 +- doc/api/tags.md | 2 +- doc/api/templates/gitignores.md | 2 +- doc/api/templates/gitlab_ci_ymls.md | 2 +- doc/api/templates/licenses.md | 2 +- doc/api/todos.md | 2 +- doc/api/users.md | 2 +- doc/api/version.md | 2 +- 47 files changed, 47 insertions(+), 47 deletions(-) diff --git a/doc/api/README.md b/doc/api/README.md index d65a99527429..05881082eff0 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 49a61c02f162..fd47c29feb47 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 9081820b3058..ec6c9c7c8cb7 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 fd330b6047f0..f893b6723a17 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 35e0918a3a4a..85690ebb3549 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 2729e09c51ca..0ce58c3d519d 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 c98001b6039f..42d3d3e1ccb4 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 46bb21ba31c8..63fb6ce8f6c4 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 4072f3ca76fc..9a2638db119e 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 5f46f4225ca9..b039a930d3ed 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 4686b95c4f71..0a7db894ac34 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 d377ceabc180..6a29d42896cf 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 b0783aa6cff7..4c3fa5a85985 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 13d9cca55d56..43426a652e8c 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 e20012d59e4f..43cd4aecf640 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 8c9f263876af..0cf34b1c83fe 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 3cda1204b004..346ac789151e 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 cbe98610219b..05141ba10648 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 9e5cf60c9596..eff110d3bfc7 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 a83de501f80f..bcbe4a844394 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 0e62a6ced3a1..f6f278c27c48 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 ba549e9c0d73..10bbea5ba76d 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 ebedfaf6de93..baef85802c6c 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 8c2e72551c3b..b07b3fc1bdf6 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 c09971bb8bd1..e6b8cd00f349 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 1bf69db8c3a2..1493925f3bab 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 21faa46f5ee2..871356e0223b 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 f366312c1f19..4a7aa65b7347 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 282aa511634d..dd8344e4b39c 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 b2470cec5c06..df8560819306 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 fd86dcc93bb7..6799b11fd1c8 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 be82f3505b6f..b66348f32e4b 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 9200fa407580..fe9a8f6dc9c5 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 016cdb94edc8..eee3346badf7 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 077088b2b287..cd09af1e77e5 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 d67b82ed1695..042a514e8fa1 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 7688527a6467..98359d6f88b3 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 1785ac11509e..253fc8cfe5d3 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 bf9fb0ffc66d..7f1e260e28d9 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 43726a567508..e9780ba81694 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 4647896052c9..265c4d7a37b5 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 449cea23f51f..abf38084185e 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 e86980b8de1b..6a719d7f8e9e 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 b9525e28f655..a655c8ac3a1c 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 322388cc4ee6..cedd7bf039f2 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 0953b82e9014..4161a81d1cea 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 368b579c849a..6d39133fcbe0 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. -- GitLab