Skip to content

Commit

Permalink
Add upgrade notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Petar Obradović committed Feb 26, 2020
1 parent 4c31af5 commit 6d65806
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,50 @@
# Upgrade
Here you will find upgrade steps between major releases.

## From 2.x to 3.x

### Console command changes

#### `trikoder:oauth2:clear-expired-tokens`

The following options have been renamed:

* `access-tokens-only` has been renamed to `access-tokens`
* `refresh-tokens-only` has been renamed to `refresh-tokens`

### SQL schema changes

The bundle makes modifications to the existing schema. You will need to run the Doctrine schema update process to sync the changes:

```sh
bin/console doctrine:schema:update
```

The schema changes include:

* New `allow_plain_text_pkce` field on the `oauth2_client` table
* `secret` field on the `oauth2_client` table is now nullable

### Interface changes

The following interfaces have been changed:

#### `Trikoder\Bundle\OAuth2Bundle\Manager\AuthorizationCodeManagerInterface`

- [Added the clearExpired() method](https://github.com/trikoder/oauth2-bundle/blob/v3.0.0/Manager/AuthorizationCodeManagerInterface.php#L15)

### Method signature changes

The following method signatures have been changed:

#### `Trikoder\Bundle\OAuth2Bundle\Model\Client`

- [Return type for getSecret() is now nullable](https://github.com/trikoder/oauth2-bundle/blob/v3.0.0/Model/Client.php#L60)

---

> **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.
## From 1.x to 2.x

### PSR-7/17 HTTP transport implementation
Expand Down

0 comments on commit 6d65806

Please sign in to comment.