File tree 1 file changed +9
-1
lines changed
1 file changed +9
-1
lines changed Original file line number Diff line number Diff line change 6
6
7
7
Java implementation of [ JSON API] ( http://jsonapi.org/ ) specification v1.0 for [ moshi] ( https://github.com/square/moshi ) .
8
8
9
- ## Setup
9
+ ## Getting Started
10
10
11
11
``` java
12
12
JsonAdapter . Factory jsonApiAdapterFactory = ResourceAdapterFactory . builder()
@@ -260,6 +260,14 @@ For moshi, if you use a custom JSON adapter (e.g. for Enum types):
260
260
| Inclusion of related resources | Yes | |
261
261
| Resource IDs | Yes | |
262
262
263
+ ## Migration Note for 3.4 and 3.5
264
+
265
+ Release 3.4 removed type parameter from ` Document ` object which can break your code. Please replace the type declaration with
266
+ ` ObjectDocument<T> ` or ` ArrayDocument<T> ` if you insist that.
267
+
268
+ Release 3.5 changes the dependency to moshi from runtime dependency to compile-only dependency, which means moshi-jsonapi does no longer
269
+ includes moshi as a dependency for your project. And you need to add moshi to the dependencies of the project manually.
270
+
263
271
## Migration from 2.x to 3.x
264
272
265
273
3.x supports all features supported by JSON API specification. And the interface changed a lot especially in serialization/deserialization.
You can’t perform that action at this time.
0 commit comments