Skip to content

Commit 6d65806

Browse files
author
Petar Obradović
committed
Add upgrade notes
1 parent 4c31af5 commit 6d65806

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

UPGRADE.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,50 @@
11
# Upgrade
22
Here you will find upgrade steps between major releases.
33

4+
## From 2.x to 3.x
5+
6+
### Console command changes
7+
8+
#### `trikoder:oauth2:clear-expired-tokens`
9+
10+
The following options have been renamed:
11+
12+
* `access-tokens-only` has been renamed to `access-tokens`
13+
* `refresh-tokens-only` has been renamed to `refresh-tokens`
14+
15+
### SQL schema changes
16+
17+
The bundle makes modifications to the existing schema. You will need to run the Doctrine schema update process to sync the changes:
18+
19+
```sh
20+
bin/console doctrine:schema:update
21+
```
22+
23+
The schema changes include:
24+
25+
* New `allow_plain_text_pkce` field on the `oauth2_client` table
26+
* `secret` field on the `oauth2_client` table is now nullable
27+
28+
### Interface changes
29+
30+
The following interfaces have been changed:
31+
32+
#### `Trikoder\Bundle\OAuth2Bundle\Manager\AuthorizationCodeManagerInterface`
33+
34+
- [Added the clearExpired() method](https://github.com/trikoder/oauth2-bundle/blob/v3.0.0/Manager/AuthorizationCodeManagerInterface.php#L15)
35+
36+
### Method signature changes
37+
38+
The following method signatures have been changed:
39+
40+
#### `Trikoder\Bundle\OAuth2Bundle\Model\Client`
41+
42+
- [Return type for getSecret() is now nullable](https://github.com/trikoder/oauth2-bundle/blob/v3.0.0/Model/Client.php#L60)
43+
44+
---
45+
46+
> **NOTE:** The underlying [league/oauth2-server](https://github.com/thephpleague/oauth2-server) library has been upgraded from version `7.x` to `8.x`. Please check your code if you are directly implementing their interfaces or extending existing non-final classes.
47+
448
## From 1.x to 2.x
549

650
### PSR-7/17 HTTP transport implementation

0 commit comments

Comments
 (0)