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

super minor code doc tweak

Browse Source
This commit is contained in:
Mathew Polzin
2019-01-28 23:51:29 -08:00
parent c96bfadd82
commit f48c385f99
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/JSONAPIOpenAPI/Sampleable/Sampleable.swift
+6
View File
@@ -18,17 +18,23 @@ public protocol Sampleable {
/// Get an example of success, if that is meaningful and
/// available. If not, will be nil.
///
/// (optional)
///
/// The default implementation returns `nil`.
static var successSample: Self? { get }
/// Get an example of failure, if that is meaningful and
/// available. If not, will be nil.
///
/// (optional)
///
/// The default implementation returns `nil`.
static var failureSample: Self? { get }
/// An array of samples of this Type.
///
/// (optional)
///
/// The default implementation returns
/// an array with just the result of
/// `Self.sample` in it.