From 956e5cd9ee24042abe021679755c0205287f4b2f Mon Sep 17 00:00:00 2001 From: Mathew Polzin Date: Tue, 13 Nov 2018 08:37:15 -0800 Subject: [PATCH] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5599c04..e536081 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ The primary goals of this framework are: ### `EntityDescription` -An `EntityDescription` is the `JSONAPI` framework's specification for what the JSON API spec calls a *Resource Objects*. You might create the following `EntityDescription` to represent a person in a network of friends: +An `EntityDescription` is the `JSONAPI` framework's specification for what the JSON API spec calls a *Resource Object*. You might create the following `EntityDescription` to represent a person in a network of friends: ``` enum PersonDescription: IdentifiedEntityDescription { @@ -178,6 +178,8 @@ The first generic type of a `JSONAPIDocument` is a `ResourceBody`. This can eith The second generic type of a `JSONAPIDocument` is an `IncludeDecoder`. This type controls which types of `Entity` are looked for when decoding the "included" part of the JSON API document. If you do not expect any included entities to be in the document, `NoIncludes` is the way to go. The `JSONAPI` framework provides `IncludeDecoder`s for up to six types of included entities. These are named `Include1`, `Include2`, `Include3`, and so on. +**IMPORTANT**: The number trailing "Include" in these type names does not indicate a number of included entities, it indicates a number of _types_ of included entities. `Include1` can be used to decode any number of included entities as long as all the entities are of the same _type_. + To specify that we expect friends of a person to be included in the above example `JSONAPIDocument`, we would use `Include1` instead of `NoIncludes`. #### `Error`