Skip to content

Commit

Permalink
[Docs] Update upgrade guide
Browse files Browse the repository at this point in the history
  • Loading branch information
lindyhopchris committed Jun 22, 2018
1 parent bc79f58 commit 8800dae
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,34 @@ and then we are planning on tagging `1.0.0` after a limited number of beta tags.

## 1.0.0-alpha.3 to 1.0.0-beta.1

### Controllers

If you have overloaded the `read` method on any of your controllers, you will need to change the
method signature. Change this:

```php
/**
* @param CloudCreativity\LaravelJsonApi\Http\Requests\ValidatedRequest $request
*/
public function read(ValidatedRequest $request)
{
// ...
}
```

To this:

```php
/**
* @param CloudCreativity\LaravelJsonApi\Contracts\Store\StoreInterface
* @param CloudCreativity\LaravelJsonApi\Http\Requests\ValidatedRequest $request
*/
public function read(StoreInterface $store, ValidatedRequest $request)
{
// ...
}
```

### Has-Many

The method signatures for the `sync` and `detach` methods in the JSON API Eloquent `HasMany` relation have been
Expand Down

0 comments on commit 8800dae

Please sign in to comment.