README.md in jsonapi-serializers-0.3.0 vs README.md in jsonapi-serializers-0.3.1
- old
+ new
@@ -15,10 +15,11 @@
* [Serialize a collection](#serialize-a-collection)
* [Null handling](#null-handling)
* [Custom attributes](#custom-attributes)
* [More customizations](#more-customizations)
* [Base URL](#base-url)
+ * [Root metadata](#root-metadata)
* [Relationships](#relationships)
* [Compound documents and includes](#compound-documents-and-includes)
* [Relationship path handling](#relationship-path-handling)
* [Rails example](#rails-example)
* [Unfinished business](#unfinished-business)
@@ -294,11 +295,11 @@
JSONAPI::Serializer.serialize(post, base_url: 'http://example.com')
```
Note: if you override `self_link` in your serializer and leave out `base_url`, it will not be included.
-### Top-level metadata
+### Root metadata
You can pass a `meta` argument to specify top-level metadata:
```ruby
JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
@@ -516,9 +517,10 @@
* 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.3.1: Improve performance of loading included relationships.
* v0.3.0: Add top-level `meta` support.
* v0.2.6: Add `base_url` support.
* v0.2.5: Allow disabling ambiguous collection checks for Sequel support.
* v0.2.4: Improve handling for nil relationship links.
* v0.2.3: Support serializers with no attributes.