Skip to content

Commit 49d0e86

Browse files
algolia-botmillotp
andcommitted
fix(clients): add a default idleConnTimeout (generated)
algolia/api-clients-automation#5442 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent baec768 commit 49d0e86

File tree

87 files changed

+489
-487
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

87 files changed

+489
-487
lines changed

Sources/Abtesting/Models/AbtestingABTestResponse.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ public struct AbtestingABTestResponse: Codable, JSONEncodable {
1212
/// Unique A/B test identifier.
1313
public var abTestID: Int
1414
/// Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run
15-
/// immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and
16-
/// this `taskID`.
15+
/// immediately. You can check the task's progress with the [`task`
16+
/// operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
1717
public var taskID: Int64
1818

1919
public init(index: String, abTestID: Int, taskID: Int64) {

Sources/AbtestingV3/Models/AbtestingV3ABTestResponse.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ public struct AbtestingV3ABTestResponse: Codable, JSONEncodable {
1212
/// Unique A/B test identifier.
1313
public var abTestID: Int
1414
/// Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run
15-
/// immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and
16-
/// this `taskID`.
15+
/// immediately. You can check the task's progress with the [`task`
16+
/// operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
1717
public var taskID: Int64
1818

1919
public init(index: String, abTestID: Int, taskID: Int64) {

Sources/Analytics/AnalyticsClient.swift

Lines changed: 49 additions & 48 deletions
Large diffs are not rendered by default.

Sources/Composition/CompositionClient.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -529,8 +529,8 @@ open class CompositionClient {
529529
return body
530530
}
531531

532-
// Retrieves a rule by its ID. To find the object ID of rules, use the [`search`
533-
// operation](#tag/Rules/operation/searchRules).
532+
// Retrieves a rule by its ID. To find the object ID of a rule, use the [`search`
533+
// operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules).
534534
// Required API Key ACLs:
535535
// - editSettings
536536
// - settings
@@ -873,7 +873,7 @@ open class CompositionClient {
873873
return body
874874
}
875875

876-
// Upsert a Composition Rule for the specified composition ID.
876+
// If a composition rule with the provided ID already exists, it's replaced. Otherwise, a new one is added.
877877
// Required API Key ACLs:
878878
// - editSettings
879879
//

Sources/Composition/Models/BaseInjectionQueryParameters.swift

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public struct BaseInjectionQueryParameters: Codable, JSONEncodable {
3939
/// attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With
4040
/// highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and
4141
/// `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more
42-
/// information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
42+
/// information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).
4343
public var attributesToHighlight: [String]?
4444
/// Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the
4545
/// attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the
@@ -54,7 +54,7 @@ public struct BaseInjectionQueryParameters: Codable, JSONEncodable {
5454
public var attributesToSnippet: [String]?
5555
/// Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query
5656
/// and is required for tracking [click and conversion
57-
/// events](https://www.algolia.com/guides/sending-events/getting-started/).
57+
/// events](https://www.algolia.com/guides/sending-events/getting-started).
5858
public var clickAnalytics: Bool?
5959
/// Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words).
6060
/// Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian.
@@ -69,8 +69,8 @@ public struct BaseInjectionQueryParameters: Codable, JSONEncodable {
6969
/// lot of content on ranking.
7070
public var disableExactOnAttributes: [String]?
7171
/// Attributes for which you want to turn off [typo
72-
/// tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
73-
/// Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/).
72+
/// tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance).
73+
/// Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes).
7474
/// - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks
7575
/// of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding
7676
/// synonyms if your attributes have intentional unusual spellings that might look like typos.
@@ -80,8 +80,8 @@ public struct BaseInjectionQueryParameters: Codable, JSONEncodable {
8080
public var enableABTest: Bool?
8181
/// Whether to enable Personalization.
8282
public var enablePersonalization: Bool?
83-
/// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/)
84-
/// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
83+
/// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This
84+
/// setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
8585
public var enableReRanking: Bool?
8686
/// Whether to enable rules.
8787
public var enableRules: Bool?
@@ -99,7 +99,7 @@ public struct BaseInjectionQueryParameters: Codable, JSONEncodable {
9999
/// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet
100100
/// attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an
101101
/// array, the filter matches if it matches at least one element of the array. For more information, see
102-
/// [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
102+
/// [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
103103
public var filters: String?
104104
/// Whether the search response should include detailed ranking information.
105105
public var getRankingInfo: Bool?
@@ -136,9 +136,9 @@ public struct BaseInjectionQueryParameters: Codable, JSONEncodable {
136136
/// dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals`
137137
/// settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk)
138138
/// languages. To support this, you must place the CJK language **first** **You should always specify a query
139-
/// language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
139+
/// language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages),
140140
/// or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to
141-
/// unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
141+
/// unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
142142
public var queryLanguages: [CompositionSupportedLanguage]?
143143
public var queryType: CompositionQueryType?
144144
public var removeStopWords: CompositionRemoveStopWords?

Sources/Composition/Models/CompositionBaseSearchResponse.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public struct CompositionBaseSearchResponse: Codable, JSONEncodable {
5858
/// An object with custom data. You can store up to 32kB as custom data.
5959
public var userData: AnyCodable?
6060
/// Unique identifier for the query. This is used for [click
61-
/// analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
61+
/// analytics](https://www.algolia.com/doc/guides/analytics/click-analytics).
6262
public var queryID: String?
6363
/// Whether automatic events collection is enabled for the application.
6464
public var automaticInsights: Bool?

Sources/Composition/Models/CompositionOptionalFilters.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import Foundation
1111
/// match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. -
1212
/// Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. -
1313
/// Optional filters are applied _before_ custom ranking attributes (in the default
14-
/// [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)). -
14+
/// [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria)). -
1515
/// Optional filters don't work with numeric attributes.
1616
public enum CompositionOptionalFilters: Codable, JSONEncodable, AbstractEncodable {
1717
case arrayOfCompositionOptionalFilters([CompositionOptionalFilters])

Sources/Composition/Models/CompositionParams.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public struct CompositionParams: Codable, JSONEncodable {
2121
/// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet
2222
/// attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an
2323
/// array, the filter matches if it matches at least one element of the array. For more information, see
24-
/// [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
24+
/// [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
2525
public var filters: String?
2626
/// Page of search results to retrieve.
2727
public var page: Int?
@@ -57,9 +57,9 @@ public struct CompositionParams: Codable, JSONEncodable {
5757
/// dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals`
5858
/// settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk)
5959
/// languages. To support this, you must place the CJK language **first** **You should always specify a query
60-
/// language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
60+
/// language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages),
6161
/// or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to
62-
/// unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
62+
/// unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
6363
public var queryLanguages: [CompositionSupportedLanguage]?
6464
/// ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to
6565
/// keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets
@@ -72,22 +72,22 @@ public struct CompositionParams: Codable, JSONEncodable {
7272
/// are strings that you can use to trigger matching rules.
7373
public var ruleContexts: [String]?
7474
/// Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events.
75-
/// For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
75+
/// For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
7676
public var userToken: String?
7777
/// Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query
7878
/// and is required for tracking [click and conversion
79-
/// events](https://www.algolia.com/guides/sending-events/getting-started/).
79+
/// events](https://www.algolia.com/guides/sending-events/getting-started).
8080
public var clickAnalytics: Bool?
8181
/// Whether this search will be included in Analytics.
8282
public var analytics: Bool?
8383
/// Tags to apply to the query for [segmenting analytics
84-
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
84+
/// data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
8585
public var analyticsTags: [String]?
8686
/// Whether to enable index level A/B testing for this run request. If the composition mixes multiple indices, the
8787
/// A/B test is ignored.
8888
public var enableABTest: Bool?
89-
/// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/)
90-
/// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
89+
/// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This
90+
/// setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
9191
public var enableReRanking: Bool?
9292
/// A list of extenrally injected objectID groups into from an external source.
9393
public var injectedItems: [String: ExternalInjectedItem]?

Sources/Composition/Models/CompositionQueryType.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Foundation
99
/// Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a
1010
/// prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words
1111
/// as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see
12-
/// [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
12+
/// [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching).
1313
public enum CompositionQueryType: String, Codable, CaseIterable {
1414
case prefixLast
1515
case prefixAll

Sources/Composition/Models/CompositionRedirect.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Foundation
77
#endif
88

99
/// [Redirect results to a
10-
/// URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this
10+
/// URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects), this
1111
/// this parameter is for internal use only.
1212
public struct CompositionRedirect: Codable, JSONEncodable {
1313
public var index: [CompositionRedirectRuleIndexMetadata]?

0 commit comments

Comments
 (0)