Skip to content

Commit 78c1c02

Browse files
refactor(specs): extract results field in a dedicated directory (generated)
algolia/api-clients-automation#5739 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Clara Muller <[email protected]>
1 parent 2e82b77 commit 78c1c02

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

Sources/Composition/Models/CompositionSearchHits.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public struct CompositionSearchHits<T: Codable>: Codable, JSONEncodable {
1010
/// Search results (hits). Hits are records from your index that match the search criteria, augmented with
1111
/// additional attributes, such as, for highlighting.
1212
public var hits: [T]
13-
/// Search query.
13+
/// The search query string.
1414
public var query: String
1515
/// URL-encoded string of all search parameters.
1616
public var params: String

Sources/Composition/Models/CompositionSearchPagination.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ import Foundation
77
#endif
88

99
public struct CompositionSearchPagination: Codable, JSONEncodable {
10-
/// Page of search results to retrieve.
10+
/// The current page of the results.
1111
public var page: Int
1212
/// Number of results (hits).
1313
public var nbHits: Int
1414
/// Number of pages of results.
1515
public var nbPages: Int
16-
/// Number of hits per page.
16+
/// Number of hits returned per page.
1717
public var hitsPerPage: Int
1818

1919
public init(page: Int, nbHits: Int, nbPages: Int, hitsPerPage: Int) {

Sources/Composition/Models/SearchResultsItem.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,18 +62,18 @@ public struct SearchResultsItem<T: Codable>: Codable, JSONEncodable {
6262
public var queryID: String?
6363
/// Whether automatic events collection is enabled for the application.
6464
public var automaticInsights: Bool?
65-
/// Page of search results to retrieve.
65+
/// The current page of the results.
6666
public var page: Int
6767
/// Number of results (hits).
6868
public var nbHits: Int
6969
/// Number of pages of results.
7070
public var nbPages: Int
71-
/// Number of hits per page.
71+
/// Number of hits returned per page.
7272
public var hitsPerPage: Int
7373
/// Search results (hits). Hits are records from your index that match the search criteria, augmented with
7474
/// additional attributes, such as, for highlighting.
7575
public var hits: [T]
76-
/// Search query.
76+
/// The search query string.
7777
public var query: String
7878
/// URL-encoded string of all search parameters.
7979
public var params: String

0 commit comments

Comments
 (0)