encounter/JSONAPI
0
0
Fork 0
mirror of https://github.com/encounter/JSONAPI.git synced 2026-03-30 11:18:38 -07:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Mathew Polzin
2019-07-23 21:11:59 -07:00
committed by GitHub
parent 61fa56e84b
commit c996e7447c
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2
View File
@@ -462,6 +462,8 @@ A `Meta` struct is totally open-ended. It is described by the **SPEC** as a plac
You can specify `NoMetadata` if the part of the document being described should not contain any `Meta`.
If you need to support metadata with structure that is not pre-determined, consider an "Any Codable" type such as that found at https://github.com/Flight-School/AnyCodable.
### `JSONAPI.Links`
A `Links` struct must contain only `Link` properties. Each `Link` property can either be a `URL` or a `URL` and some `Meta`. Each part of the document has some suggested common `Links` to include but generally any link can be included.