mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2025-02-18 00:09:54 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #608 from acelaya-forks/feature/missing-upgrade+info

Browse source 
Added missing information in upgrading document
This commit is contained in:
Alejandro Celaya 2020-01-09 07:48:27 +01:00 • committed by GitHub
commit 8465a9da31
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
UPGRADE.md
View file

@ -2,6 +2,14 @@
## From v1.x to v2.x
### PHP 7.4 required
This new version takes advantage of several new features introduced in PHP 7.4.
Thanks to that, the code is more reliable and robust, and easier to maintain and improve.
However, that means that any previous PHP version is no longer supported.
### Preview generation
The ability to generate website previews has been completely removed and has no replacement.
@ -43,6 +51,16 @@ Endpoints need to provide a version in the path now. Previously, not providing a
The only exception is the `/rest/health` endpoint, which will continue working without the version.
### API errors
Shlink v1.21.0 introduced support for API errors using the Problem Details format, as well as the v2 of the API.
For backwards compatibility reasons, requests performed to v1 continued to return the old `error` and `message` properties.
Starting with Shlink v2.0.0, both versions of the API will no longer return those two properties.
As a replacement, use `type` instead of `error`, and `detail` instead of `message`.
### Changes in models
The next REST API models have changed: