8000 [Docs] Update changelog, upgrade guide and copyright notices · AxonDivisionDev/laravel-json-api@242da6c · GitHub
[go: up one dir, main page]
Skip to content

Commit 242da6c

Browse files
lindyhopchrislindyhopchris
committed
[Docs] Update changelog, upgrade guide and copyright notices
1 parent 797430f commit 242da6c

25 files changed

+313
-14
lines changed

‎CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
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+
## [1.0.0-beta.3] - 2018-09-21
66

77
### Added
88
- New cursor-based paging strategy, refer to the [Pagination docs](./docs/fetching/pagination.md) for
99
details.
1010
- Refactored the client interface and implementation, improving record serializing and adding missing
1111
relationship request methods.
12-
- [#144](https://github.com/cloudcreativity/laravel-json-api/issues/144)
13-
Improved the helper method that creates new client instances so that it automatically adds a base
14-
URI for the client if one is not provided.
1512
- [#123](https://github.com/cloudcreativity/laravel-json-api/issues/123)
1613
Can now use a custom resolver if wanting to override the default namespace resolution provided by
1714
this package. This is documented in the [Resolvers chapter.](./docs/features/resolvers.md)
1815

1916
### Changed
2017
- Extract model sorting from the Eloquent adapter into a `SortsModels` trait.
18+
- [#144](https://github.com/cloudcreativity/laravel-json-api/issues/144)
19+
Improved the helper method that creates new client instances so that it automatically adds a base
20+
URI for the client if one is not provided.
2121

2222
### Fixed
2323
- [#222](https://github.com/cloudcreativity/laravel-json-api/issues/222)

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ A demo application is available at [here](https://github.com/cloudcreativity/dem
2626

2727
| Laravel | This Package |
2828
| --- | --- |
29-
| 5.7.* | `1.0.0-beta.2` |
30-
| 5.6.* | `1.0.0-beta.2` |
31-
| 5.5.* | `1.0.0-beta.2` |
32-
| 5.4.* | `1.0.0-beta.2` |
29+
| 5.7.* | `1.0.0-beta.3` |
30+
| 5.6.* | `1.0.0-beta.3` |
31+
| 5.5.* | `1.0.0-beta.3` |
32+
| 5.4.* | `1.0.0-beta.3` |
3333

3434
Make sure you consult the [Upgrade Guide](http://laravel-json-api.readthedocs.io/en/latest/upgrade/) when upgrading.
3535

‎docs/basics/adapters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -395,8 +395,8 @@ class Adapter extends AbstractAdapter
395395
}
396396
```
397397

398-
> The `morphMany` implementation currently has some limitations that we are hoping to resolve during our alpha
399-
and beta releases. If you have problems using it, please create an issue as this will help us out.
398+
> The `morphMany` implementation currently has some limitations that we are hoping to resolve during our
399+
beta releases. If you have problems using it, please create an issue as this will help us out.
400400

401401
#### Queries-One and Queries-Many
402402

‎docs/features/resolvers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ the generators will not work.
9999

100100
### Without a Factory
101101

102-
If you do not need to access any configuration for your API when creating your resolver, and
102+
If you do not need to access any configuration for your API when creating your resolver,
103103
you can use your resolver by adding its fully qualified class name (or a container binding
104104
name) to your API's `resolver` configuration setting.
105105

@@ -119,7 +119,7 @@ return [
119119

120120
If you need access to your API's configuration when creating a resolver, or if you need
121121
to calculate any resolver settings, you can create the resolver via a factory. For example,
122-
if you have extended our abstract resolver, you will need to provide the `resources` value
122+
if you have extended our abstract resolver you will need to provide the `resources` value
123123
from the config when constructing your resolver.
124124

125125
The factory is an invokable class that receives the API name and the API's config. For

‎docs/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Install using [Composer](http://getcomposer.org):
66

77
``` bash
8-
$ composer require cloudcreativity/laravel-json-api:1.0.0-beta.2
8+
$ composer require cloudcreativity/laravel-json-api:1.0.0-beta.3
99
$ composer require --dev cloudcreativity/json-api-testing
1010
```
1111

@@ -17,7 +17,7 @@ need to follow the instructions below for updating your `ExceptionHandler`.
1717
Install using [Composer](http://getcomposer.org):
1818

1919
``` bash
20-
$ composer require cloudcreativity/laravel-json-api:1.0.0-beta.2
20+
$ composer require cloudcreativity/laravel-json-api:1.0.0-beta.3
2121
$ composer require --dev cloudcreativity/json-api-testing
2222
```
2323

‎docs/upgrade.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ so this will not result in a major breaking change before `1.0.0`.
1111

1212
## 1.0.0-beta.2 to 1.0.0-beta.3
1313

14+
With the exception of the client feature, we have not made any changes that we believe will be
15+
breaking unless you are overriding the internals of the package. The majority of applications
16+
should therefore be able to upgrade without any changes.
17+
1418
### Clients
1519

1620
We have updated the client implementation to add the following:

‎src/Client/ClientSerializer.php

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
<?php
2+
/**
3+
* Copyright 2018 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
217

318
namespace CloudCreativity\LaravelJsonApi\Client;
419

@@ -7,6 +22,11 @@
722
use Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface;
823
use Neomerx\JsonApi\Contracts\Http\HttpFactoryInterface;
924

25+
/**
26+
* Class ClientSerializer
27+
*
28+
* @package CloudCreativity\LaravelJsonApi
29+
*/
1030
class ClientSerializer
1131
{
1232

‎src/Encoder/Parameters/EncodingParameters.php

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
<?php
2+
/**
3+
* Copyright 2018 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
217

318
namespace CloudCreativity\LaravelJsonApi\Encoder\Parameters;
419

@@ -7,6 +22,11 @@
722
use Neomerx\JsonApi\Contracts\Http\Query\QueryParametersParserInterface;
823
use Neomerx\JsonApi\Encoder\Parameters\EncodingParameters as NeomerxEncodingParameters;
924

25+
/**
26+
* Class EncodingParameters
27+
*
28+
* @package CloudCreativity\LaravelJsonApi
29+
*/
1030
class EncodingParameters extends NeomerxEncodingParameters implements Arrayable
1131
{
1232

‎src/Exceptions/ClientException.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
<?php
2+
/**
3+
* Copyright 2018 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
217

318
namespace CloudCreativity\LaravelJsonApi\Exceptions;
419

‎src/Resolver/AbstractResolver.php

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
11
<?php
2+
/**
3+
* Copyright 2018 Cloud Creativity Limited
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
217

318
namespace CloudCreativity\LaravelJsonApi\Resolver;
419

0 commit comments

Comments
 (0)
0