@@ -28,15 +28,15 @@ private protocol HomogeneousArray: Array {
2828 var items : [ ItemType ] { get }
2929}
3030
31- /**
32- Sometimes, when links are unresolvable (for instance, when a linked entry is not published), the API
33- will return an array of errors, one for each unresolvable link.
34- */
31+ /// Sometimes, when links are unresolvable (for instance, when a linked entry is not published), the API
32+ /// will return an array of errors, one for each unresolvable link.
3533public struct ArrayResponseError : Decodable {
3634 /// The system fields of the error.
3735 public struct Sys : Decodable {
38- let id : String
39- let type : String
36+ /// The identifer of the error.
37+ public let id : String
38+ /// The type identifier for the error.
39+ public let type : String
4040 }
4141
4242 /// System fields for the unresolvable link.
@@ -45,24 +45,21 @@ public struct ArrayResponseError: Decodable {
4545 public let sys : ArrayResponseError . Sys
4646}
4747
48- /**
49- A list of resources in Contentful
50-
51- This is the result type for any request of a collection of resources.
52- See: <https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination>
53- */
48+ /// A list of resources in Contentful
49+ /// This is the result type for any request of a collection of resources.
50+ /// See: <https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination>
5451public struct ArrayResponse < ItemType> : HomogeneousArray where ItemType: Decodable & EndpointAccessible {
5552
56- /// The resources which are part of the given array
53+ /// The resources which are part of the array response.
5754 public let items : [ ItemType ]
5855
59- /// The maximum number of resources originally requested
56+ /// The maximum number of resources originally requested.
6057 public let limit : UInt
6158
62- /// The number of elements skipped when performing the request
59+ /// The number of elements skipped when performing the request.
6360 public let skip : UInt
6461
65- /// The total number of resources which matched the original request
62+ /// The total number of resources which matched the original request.
6663 public let total : UInt
6764
6865 /// An array of errors, or partial errors, which describe links which were returned in the response that
@@ -80,15 +77,15 @@ public struct ArrayResponse<ItemType>: HomogeneousArray where ItemType: Decodabl
8077 }
8178
8279 internal struct Includes : Decodable {
83- let assets : [ Asset ] ?
84- let entries : [ Entry ] ?
80+ internal let assets : [ Asset ] ?
81+ internal let entries : [ Entry ] ?
8582
8683 private enum CodingKeys : String , CodingKey {
8784 case assets = " Asset "
8885 case entries = " Entry "
8986 }
9087
91- init ( from decoder: Decoder ) throws {
88+ internal init ( from decoder: Decoder ) throws {
9289 let values = try . container ( keyedBy: CodingKeys . self)
9390 assets = try . decodeIfPresent ( [ Asset ] . self, forKey: . assets)
9491 entries = try . decodeIfPresent ( [ Entry ] . self, forKey: . entries)
@@ -172,15 +169,15 @@ extension ArrayResponse: Decodable {
172169}
173170
174171internal struct MappedIncludes : Decodable {
175- let assets : [ Asset ] ?
176- let entries : [ EntryDecodable ] ?
172+ internal let assets : [ Asset ] ?
173+ internal let entries : [ EntryDecodable ] ?
177174
178175 private enum CodingKeys : String , CodingKey {
179176 case assets = " Asset "
180177 case entries = " Entry "
181178 }
182179
183- init ( from decoder: Decoder ) throws {
180+ internal init ( from decoder: Decoder ) throws {
184181 let container = try . container ( keyedBy: CodingKeys . self)
185182 assets = try . decodeIfPresent ( [ Asset ] . self, forKey: . assets)
186183 entries = try . decodeHeterogeneousEntries ( forKey: . entries,
@@ -197,28 +194,24 @@ internal struct MappedIncludes: Decodable {
197194 }
198195}
199196
200-
201- /**
202- A list of Contentful entries that have been mapped to types conforming to `EntryDecodable` instances.
203- A MixedArrayResponse respresents a heterogeneous collection of EntryDecodables being returned,
204- for instance if hitting the base /entries endpoint with no additional query parameters. If there is no
205- user-defined type for a particular entry, that entry will not be serialized at all. It is up to you to
206- introspect the type of each element in the items array to handle the response data properly.
207-
208- See: <https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination>
209- */
197+ /// A list of Contentful entries that have been mapped to types conforming to `EntryDecodable` instances.
198+ /// A `MixedArrayResponse` respresents a heterogeneous collection of `EntryDecodable` being returned,
199+ /// for instance, if hitting the base `/entries` endpoint with no additional query parameters. If there is no
200+ /// user-defined type for a particular entry, that entry will not be deserialized at all. It is up to you to
201+ /// introspect the type of each element in the items array to handle the response data properly.
202+ /// See: <https://www.contentful.com/developers/docs/references/content-delivery-api/#/introduction/collection-resources-and-pagination>
210203public struct MixedArrayResponse : Array {
211204
212- /// The resources which are part of the given array
205+ /// The resources which are part of the given array response.
213206 public let items : [ EntryDecodable ]
214207
215208 /// The maximum number of resources originally requested
216209 public let limit : UInt
217210
218- /// The number of elements skipped when performing the request
211+ /// The number of elements skipped when performing the request.
219212 public let skip : UInt
220213
221- /// The total number of resources which matched the original request
214+ /// The total number of resources which matched the original request.
222215 public let total : UInt
223216
224217 /// An array of errors, or partial errors, which describe links which were returned in the response that
@@ -261,14 +254,14 @@ extension MixedArrayResponse: Decodable {
261254// Convenience method for grabbing the content type information of a json item in an array of resources.
262255internal extension Swift . Array where Element == Dictionary < String , Any > {
263256
264- func contentTypeInfo( at index: Int ) -> Link ? {
257+ internal func contentTypeInfo( at index: Int ) -> Link ? {
265258 guard let sys = self [ index] [ " sys " ] as? [ String : Any ] , let contentTypeInfo = sys [ " contentType " ] as? Link else {
266259 return nil
267260 }
268261 return contentTypeInfo
269262 }
270263
271- func nodeType( at index: Int ) -> NodeType ? {
264+ internal func nodeType( at index: Int ) -> NodeType ? {
272265 guard let nodeTypeString = self [ index] [ " nodeType " ] as? String , let nodeType = NodeType ( rawValue: nodeTypeString) else {
273266 return nil
274267 }
0 commit comments