diff options
author | Francisco Javier López <fjlopez@gitlab.com> | 2018-05-15 15:39:33 +0200 |
---|---|---|
committer | Francisco Javier López <fjlopez@gitlab.com> | 2018-05-30 18:23:07 +0200 |
commit | 4d3f7ae1ef5881869140f0c4a5865f65569db26a (patch) | |
tree | 4d1cf8339ad9d8d9dc9a0176b90827e84ef3aaf2 /doc/api/README.md | |
parent | 439adb96dadd49124d080db0db0b0076d2049c6b (diff) | |
download | gitlab-ce-4d3f7ae1ef5881869140f0c4a5865f65569db26a.tar.gz |
Removed API endpoint and specsfj-36819-remove-v3-api
Diffstat (limited to 'doc/api/README.md')
-rw-r--r-- | doc/api/README.md | 15 |
1 files changed, 7 insertions, 8 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 |