Adds JSONAPITesting framework compare(to:) functions that deliver concise comparisons of two documents or resource objects.
Adds ResourceObjectDecodingError and DocumentDecodingError which represent more JSON:API-specific errors and come with good string descriptions for many common reasons why JSON:API resources or documents could fail to decode.
β οΈ Breaking Changes β οΈ
π Renames JSONAPIDocument to CodableJSONAPIDocument.
π Renames OptionalPrimaryResource to OptionalCodablePrimaryResource.
π Renames PrimaryResource to CodablePrimaryResource.
π Renames ResourceBody to CodableResourceBody.
π Renames PolyWrapped to CodablePolyWrapped.
π Renames SingleResourceBody.Entity to SingleResourceBody.PrimaryResource
π Renames ManyResourceBody.Entity to ManyResourceBody.PrimaryResource
π Renames JSONAPIEncodingError to JSONAPICodingError
βοΈ Deprecates subscript access of ResourceObject attributes in favor of key path dynamic member lookup.
π Removes key path dynamic member lookup of Document properties on Document.SuccessDocument and Document.ErrorDocument in favor of directly providing relevant accessors (see SuccessDocument/ErrorDocument for details).
WIP branch for alpha
3.0.0
releases.JSONAPITesting
frameworkcompare(to:)
functions that deliver concise comparisons of two documents or resource objects.ResourceObjectDecodingError
andDocumentDecodingError
which represent more JSON:API-specific errors and come with good string descriptions for many common reasons why JSON:API resources or documents could fail to decode.β οΈ Breaking Changes β οΈ
π Renames
JSONAPIDocument
toCodableJSONAPIDocument
. π RenamesOptionalPrimaryResource
toOptionalCodablePrimaryResource
. π RenamesPrimaryResource
toCodablePrimaryResource
. π RenamesResourceBody
toCodableResourceBody
. π RenamesPolyWrapped
toCodablePolyWrapped
. π RenamesSingleResourceBody.Entity
toSingleResourceBody.PrimaryResource
π RenamesManyResourceBody.Entity
toManyResourceBody.PrimaryResource
π RenamesJSONAPIEncodingError
toJSONAPICodingError
βοΈ Deprecates
subscript
access ofResourceObject
attributes in favor of key path dynamic member lookup.π Removes key path dynamic member lookup of
Document
properties onDocument.SuccessDocument
andDocument.ErrorDocument
in favor of directly providing relevant accessors (seeSuccessDocument
/ErrorDocument
for details).