summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrancisco Javier López <fjlopez@gitlab.com>2018-05-15 15:39:33 +0200
committerFrancisco Javier López <fjlopez@gitlab.com>2018-05-30 18:23:07 +0200
commit4d3f7ae1ef5881869140f0c4a5865f65569db26a (patch)
tree4d1cf8339ad9d8d9dc9a0176b90827e84ef3aaf2 /doc
parent439adb96dadd49124d080db0db0b0076d2049c6b (diff)
downloadgitlab-ce-4d3f7ae1ef5881869140f0c4a5865f65569db26a.tar.gz
Removed API endpoint and specsfj-36819-remove-v3-api
Diffstat (limited to 'doc')
-rw-r--r--doc/api/README.md15
-rw-r--r--doc/api/applications.md2
-rw-r--r--doc/api/environments.md2
-rw-r--r--doc/api/projects.md2
-rw-r--r--doc/api/v3_to_v4.md7
-rw-r--r--doc/integration/shibboleth.md2
6 files changed, 14 insertions, 16 deletions
diff --git a/doc/api/README.md b/doc/api/README.md
index 194907accc7..1c756dc855f 100644
--- a/doc/api/README.md
+++ b/doc/api/README.md
@@ -90,24 +90,23 @@ specification.
## Compatibility Guidelines
The HTTP API is versioned using a single number, the current one being 4. This
-number symbolises the same as the major version number as described by
+number symbolises the same as the major version number as described by
[SemVer](https://semver.org/). This mean that backward incompatible changes
will require this version number to change. However, the minor version is
-not explicit. This allows for a stable API endpoint, but also means new
+not explicit. This allows for a stable API endpoint, but also means new
features can be added to the API in the same version number.
New features and bug fixes are released in tandem with a new GitLab, and apart
from incidental patch and security releases, are released on the 22nd each
-month. Backward incompatible changes (e.g. endpoints removal, parameters
-removal etc.), as well as removal of entire API versions are done in tandem
-with a major point release of GitLab itself. All deprecations and changes
-between two versions should be listed in the documentation. For the changes
+month. Backward incompatible changes (e.g. endpoints removal, parameters
+removal etc.), as well as removal of entire API versions are done in tandem
+with a major point release of GitLab itself. All deprecations and changes
+between two versions should be listed in the documentation. For the changes
between v3 and v4; please read the [v3 to v4 documentation](v3_to_v4.md)
#### Current status
-Currently two API versions are available, v3 and v4. v3 is deprecated and
-will soon be removed. Deletion is scheduled for
+Currently only API version v4 is available. Version v3 was removed in
[GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819).
## Basic usage
diff --git a/doc/api/applications.md b/doc/api/applications.md
index 933867ed0bb..6d244594b71 100644
--- a/doc/api/applications.md
+++ b/doc/api/applications.md
@@ -23,7 +23,7 @@ POST /applications
| `scopes` | string | yes | The scopes of the application |
```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "name=MyApplication&redirect_uri=http://redirect.uri&scopes=" https://gitlab.example.com/api/v3/applications
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --data "name=MyApplication&redirect_uri=http://redirect.uri&scopes=" https://gitlab.example.com/api/v4/applications
```
Example response:
diff --git a/doc/api/environments.md b/doc/api/environments.md
index 6e20781f51a..29da4590a59 100644
--- a/doc/api/environments.md
+++ b/doc/api/environments.md
@@ -123,7 +123,7 @@ POST /projects/:id/environments/:environment_id/stop
| `environment_id` | integer | yes | The ID of the environment |
```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/1/environments/1/stop"
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v4/projects/1/environments/1/stop"
```
Example response:
diff --git a/doc/api/projects.md b/doc/api/projects.md
index 79cf5e1cc10..d3e95926322 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -1169,7 +1169,7 @@ The `file=` parameter must point to a file on your filesystem and be preceded
by `@`. For example:
```bash
-curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --form "file=@dk.png" https://gitlab.example.com/api/v3/projects/5/uploads
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" --form "file=@dk.png" https://gitlab.example.com/api/v4/projects/5/uploads
```
Returned object:
diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md
index 9835fab7c98..98eae66469f 100644
--- a/doc/api/v3_to_v4.md
+++ b/doc/api/v3_to_v4.md
@@ -2,10 +2,9 @@
Since GitLab 9.0, API V4 is the preferred version to be used.
-API V3 will be unsupported from GitLab 9.5, to be released on August
-22, 2017. It will be removed in GitLab 9.5 or later. In the meantime, we advise
-you to make any necessary changes to applications that use V3. The V3 API
-documentation is still
+API V3 was unsupported from GitLab 9.5, released on August
+22, 2017. API v3 was removed in [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819).
+The V3 API documentation is still
[available](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-16-stable/doc/api/README.md).
Below are the changes made between V3 and V4.
diff --git a/doc/integration/shibboleth.md b/doc/integration/shibboleth.md
index 8611d4f7315..0e43b4a39a4 100644
--- a/doc/integration/shibboleth.md
+++ b/doc/integration/shibboleth.md
@@ -107,7 +107,7 @@ you will not get a shibboleth session!
RewriteEngine on
#Don't escape encoded characters in api requests
- RewriteCond %{REQUEST_URI} ^/api/v3/.*
+ RewriteCond %{REQUEST_URI} ^/api/v4/.*
RewriteCond %{REQUEST_URI} !/Shibboleth.sso
RewriteCond %{REQUEST_URI} !/shibboleth-sp
RewriteRule .* http://127.0.0.1:8181%{REQUEST_URI} [P,QSA,NE]