8000 [Docs] Update changelog and upgrade guide · volldigital/laravel-json-api@70c5a24 · GitHub
[go: up one dir, main page]

Skip to content

Commit 70c5a24

Browse files
committed
[Docs] Update changelog and upgrade guide
1 parent 421992e commit 70c5a24

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
All notable changes to this project will be documented in this file. This project adheres to
33
[Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
44

5-
## Unreleased
5+
## [0.6.0] - 2017-02-20
66

77
### Added
88
- Added support for Laravel 5.4. However, consuming applications will need to use the Browserkit testing package

UPGRADE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,29 @@
22

33
This file provides notes on how to upgrade between versions.
44

5+
## v0.5 to v0.6
6+
7+
### Config
8+
9+
Add the following to your `json-api-errors.php` config file:
10+
11+
```php
12+
/**
13+
* When the resource type of a related resource is not recognised.
14+
*/
15+
V::RELATIONSHIP_UNKNOWN_TYPE => [
16+
Error::TITLE => 'Invalid Relationship',
17+
Error::DETAIL => "Resource type '{actual}' is not recognised.",
18+
Error::STATUS => 400,
19+
],
20+
```
21+
22+
### Other
23+
24+
This upgrade includes updating `cloudcreativity/json-api` from v0.6 to v0.7. This will not affect the vast majority
25+
of applications. However, if you have implemented your own Store or Validator Error Factory, you will need to refer
26+
to the upgrade notes in that package.
27+
528
## v0.5.0|v0.5.1 to v0.5.2
629

730
Version `0.5.2` adds generator commands to your application. We've updated the configuration so you will need to

0 commit comments

Comments
 (0)
0