From 2e419b15b9e9b896d99ec3189ff821e5038441d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kocsis=20M=C3=A1t=C3=A9?= Date: Tue, 22 Sep 2015 21:45:18 +0200 Subject: [PATCH] Bumbed version --- CHANGELOG.md | 14 +++++++++++--- README.md | 6 +++--- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ae3527ff..a0fb9844 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,12 @@ -## 0.6.0 - Unreleased +## 0.7.0 - unreleased + +ADDED: + +CHANGED: + +FIXED: + +## 0.6.0 - 2015-09-22 ADDED: - More convenient handling of inappropriate relationship types during hydration @@ -8,7 +16,7 @@ ADDED: CHANGED: - Simplified relative links - Included resources are now sorted by type and id -- Renamed `AbstractCompoundDocument` to `AbstractSuccessfulDocument` +- Renamed `AbstractCompoundDocument` to `AbstractSuccessfulDocument` - Documents now require a `ResourceTransformerInterface` instance instead of `AbstractResourceTransformer` FIXED: @@ -22,7 +30,7 @@ FIXED: - Status code of error responses was always "500" when the document contained multiple errors - Content-Type header media types of responses are now correctly assembled when using extensions - Fatal error when the hydrated resource type didn't match the acceptable type -- Various issues of pagination providers +- Various issues of pagination providers ## 0.5.0 - 2015-09-11 diff --git a/README.md b/README.md index d7a65bd7..31b94ef6 100644 --- a/README.md +++ b/README.md @@ -114,7 +114,7 @@ three abstract classes that help you to create your own documents for the differ As the `AbstractSuccessfulDocument` is only useful for special use-cases (e.g. when a document can contain resources of multiple types), we will not cover it here. -`AbstractSingleResourceDocument` or `AbstractCollectionDocument` both need a +`AbstractSingleResourceDocument` and `AbstractCollectionDocument` both need a [resource transformer](#resource-transformers) to work, which is a concept introduced in the following sections. For now, it is enough to know that one must be passed for the documents during instantiation. This means that a minimal constructor of your documents must look like this: @@ -221,7 +221,7 @@ as an iterable collection of domain objects. ###### Usage -Documents are to be transformed to HTTP responses. The easiest way to achieve this is to use the +Documents can be transformed to HTTP responses. The easiest way to achieve this is to use the [`JsonApi` class](#jsonapi-class) and choose the appropriate response type. Successful documents support three kinds of responses: @@ -257,7 +257,7 @@ Documents for successful responses can contain one or more top-level resources, resource identifier objects as relationships. That's why resource transformers are responsible to convert a domain object into a JSON API resource or resource identifier. -Although you are encouraged to create one transformer for each resource types, there is possibility to define +Although you are encouraged to create one transformer for each resource type, there is possibility to define "composite" resource transformers too following the Composite design pattern if you need more sophistication. Resource transformers must implement the `ResourceTransformerInterface`, but to facilitate this job, you can extend