Add a migration doc for 2.0.0

This commit is contained in:
François Voron
2020-06-15 14:44:47 +02:00
parent 111af6e2eb
commit 638ffb70d0
3 changed files with 27 additions and 2 deletions

View File

@@ -1,4 +1,4 @@
# 0.8.x ➡️ 1.0.x
# 0.8.x ➡️ 1.x.x
1.0 version introduces major breaking changes that need you to update some of your code and migrate your data.

View File

@@ -0,0 +1,24 @@
# 1.x.x ➡️ 2.x.x
## JWT authentication backend
To be fully compatible with Swagger authentication, the output of a successful login operation with the JWT authentication backend has changed:
**Before**
```json
{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI"
}
```
**After**
```json
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI",
"token_type": "bearer"
}
```
Make sure to update your clients to read the token in the right property.

View File

@@ -51,4 +51,5 @@ nav:
- usage/routes.md
- usage/dependency-callables.md
- Migration:
- migration/08_to_10.md
- migration/08_to_1x.md
- migration/1x_to_2x.md