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

Add tests for BasicJSONAPIError and tweak documentation

Browse Source
This commit is contained in:
Mathew Polzin
2019-09-29 15:20:08 -07:00
parent 88c5d400aa
commit b0801f7cee
3 changed files with 105 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/JSONAPI/Error/BasicJSONAPIError.swift
+5
View File
@@ -70,4 +70,9 @@ public struct BasicJSONAPIErrorPayload<IdType: Codable & Equatable>: Codable, Eq
/// a good option if you do not know what to expect. You could also use
/// `Either<Int, String>` (provided by the `Poly` package that is
/// already a dependency of `JSONAPI`).
///
/// - Important: The `definedFields` property will include fields
/// with non-nil values in a flattened way. There will be no `source` key
/// but there will be `pointer` and `parameter` keys (if those values
/// are non-nil).
public typealias BasicJSONAPIError<IdType: Codable & Equatable> = GenericJSONAPIError<BasicJSONAPIErrorPayload<IdType>>