Commit 87a267d7 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files

Add a note that the API of `https://gitlab.com` cannot always be used

[ci skip]
parent b69c2c11
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 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). under [`/lib/api`](https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api).
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. >Introduced in GitLab 8.11.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. >[Introduced][ce-4575] in GitLab 8.9, snippet support in 8.12.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. Every API call to boards must be authenticated.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List repository branches
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. >Introduced in GitLab 8.12.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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). You can read more about [triggering builds through the API](../ci/triggers/README.md).
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List project variables
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List project builds
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## Purpose
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. API used by runners to receive and update builds.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. > [Introduced][ce-5953] in GitLab 8.12.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. API used by Runners to register and delete themselves.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List repository commits
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 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. group, this can be achieved quite easily with the API.
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List all deploy keys
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List project deployments
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List environments
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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 ## List groups
......
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
>**Note:** >**Note:**
The `https://gitlab.example.com` URL that is presented in the examples of the 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, 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. Every API call to issues must be authenticated.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment