README.md in jsonapi-serializers-0.8.0 vs README.md in jsonapi-serializers-0.9.0
- old
+ new
@@ -316,15 +316,15 @@
JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
```
### Root errors
-You can pass an `errors` argument to specify top-level errors:
+You can use `serialize_errors` method in order to specify top-level errors:
```ruby
errors = [{ "title": "Invalid Attribute", "detail": "First name must contain at least three characters." }]
-JSONAPI::Serializer.serialize(post, errors: errors)
+JSONAPI::Serializer.serialize_errors(errors)
```
### Explicit serializer discovery
By default, jsonapi-serializers assumes that the serializer class for `Namespace::User` is `Namespace::UserSerializer`. You can override this behavior on a per-object basis by implementing the `jsonapi_serializer_class_name` method.
@@ -660,9 +660,11 @@
* Support for the `fields` spec is planned, would love a PR contribution for this.
* Support for pagination/sorting is unlikely to be supported because it would likely involve coupling to ActiveRecord, but please open an issue if you have ideas of how to support this generically.
## Release notes
+* v0.9.0: Add initial `serialize_errors` support.
+* v0.8.0: Pass context through recursive relationships.
* v0.7.0: Support for root error objects.
* v0.6.5: Exclude attributes when empty.
* v0.6.4: Fix regression of including links when empty.
* v0.6.3: Fix support for underscore-formatted attribute names.
* v0.6.2: Internal style updates and performance fixes.