Skip to content

Commit 8fc5415

Browse files
algolia-botmillotp
algolia-bot
and
millotp
committed
chore(spec): fix comment of custom path (generated)
algolia/api-clients-automation#5014 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
1 parent 055c078 commit 8fc5415

File tree

9 files changed

+72
-72
lines changed

9 files changed

+72
-72
lines changed

‎Sources/Abtesting/AbtestingClient.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ open class AbtestingClient {
8181
)
8282
}
8383

84-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
84+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
8585
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
8686
/// - returns: AnyCodable
8787
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -106,7 +106,7 @@ open class AbtestingClient {
106106
// This method lets you send requests to the Algolia REST API.
107107
//
108108
//
109-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
109+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
110110
//
111111
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
112112
// - returns: RequestBuilder<AnyCodable>
@@ -146,7 +146,7 @@ open class AbtestingClient {
146146
)
147147
}
148148

149-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
149+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
150150
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
151151
/// - returns: AnyCodable
152152
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -171,7 +171,7 @@ open class AbtestingClient {
171171
// This method lets you send requests to the Algolia REST API.
172172
//
173173
//
174-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
174+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
175175
//
176176
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
177177
// - returns: RequestBuilder<AnyCodable>
@@ -211,7 +211,7 @@ open class AbtestingClient {
211211
)
212212
}
213213

214-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
214+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
215215
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
216216
/// - parameter body: (body) Parameters to send with the custom request. (optional)
217217
/// - returns: AnyCodable
@@ -239,7 +239,7 @@ open class AbtestingClient {
239239
// This method lets you send requests to the Algolia REST API.
240240
//
241241
//
242-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
242+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
243243
//
244244
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
245245
//
@@ -282,7 +282,7 @@ open class AbtestingClient {
282282
)
283283
}
284284

285-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
285+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
286286
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
287287
/// - parameter body: (body) Parameters to send with the custom request. (optional)
288288
/// - returns: AnyCodable
@@ -310,7 +310,7 @@ open class AbtestingClient {
310310
// This method lets you send requests to the Algolia REST API.
311311
//
312312
//
313-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
313+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
314314
//
315315
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
316316
//

‎Sources/Analytics/AnalyticsClient.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ open class AnalyticsClient {
3232
self.transporter.setClientApiKey(apiKey: apiKey)
3333
}
3434

35-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
35+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
3636
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
3737
/// - returns: AnyCodable
3838
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -57,7 +57,7 @@ open class AnalyticsClient {
5757
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
60-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
60+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
6161
//
6262
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
6363
// - returns: RequestBuilder<AnyCodable>
@@ -97,7 +97,7 @@ open class AnalyticsClient {
9797
)
9898
}
9999

100-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
100+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
101101
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
102102
/// - returns: AnyCodable
103103
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -122,7 +122,7 @@ open class AnalyticsClient {
122122
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
125+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
126126
//
127127
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
128128
// - returns: RequestBuilder<AnyCodable>
@@ -162,7 +162,7 @@ open class AnalyticsClient {
162162
)
163163
}
164164

165-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
165+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
166166
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
167167
/// - parameter body: (body) Parameters to send with the custom request. (optional)
168168
/// - returns: AnyCodable
@@ -190,7 +190,7 @@ open class AnalyticsClient {
190190
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
193+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
194194
//
195195
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
196196
//
@@ -233,7 +233,7 @@ open class AnalyticsClient {
233233
)
234234
}
235235

236-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
236+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
237237
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
238238
/// - parameter body: (body) Parameters to send with the custom request. (optional)
239239
/// - returns: AnyCodable
@@ -261,7 +261,7 @@ open class AnalyticsClient {
261261
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
264+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
265265
//
266266
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
267267
//

‎Sources/Ingestion/IngestionClient.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ open class IngestionClient {
331331
)
332332
}
333333

334-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
334+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
335335
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
336336
/// - returns: AnyCodable
337337
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -356,7 +356,7 @@ open class IngestionClient {
356356
// This method lets you send requests to the Algolia REST API.
357357
//
358358
//
359-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
359+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
360360
//
361361
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
362362
// - returns: RequestBuilder<AnyCodable>
@@ -396,7 +396,7 @@ open class IngestionClient {
396396
)
397397
}
398398

399-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
399+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
400400
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
401401
/// - returns: AnyCodable
402402
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -421,7 +421,7 @@ open class IngestionClient {
421421
// This method lets you send requests to the Algolia REST API.
422422
//
423423
//
424-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
424+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
425425
//
426426
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
427427
// - returns: RequestBuilder<AnyCodable>
@@ -461,7 +461,7 @@ open class IngestionClient {
461461
)
462462
}
463463

464-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
464+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
465465
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
466466
/// - parameter body: (body) Parameters to send with the custom request. (optional)
467467
/// - returns: AnyCodable
@@ -489,7 +489,7 @@ open class IngestionClient {
489489
// This method lets you send requests to the Algolia REST API.
490490
//
491491
//
492-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
492+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
493493
//
494494
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
495495
//
@@ -532,7 +532,7 @@ open class IngestionClient {
532532
)
533533
}
534534

535-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
535+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
536536
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
537537
/// - parameter body: (body) Parameters to send with the custom request. (optional)
538538
/// - returns: AnyCodable
@@ -560,7 +560,7 @@ open class IngestionClient {
560560
// This method lets you send requests to the Algolia REST API.
561561
//
562562
//
563-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
563+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
564564
//
565565
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
566566
//

‎Sources/Insights/InsightsClient.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ open class InsightsClient {
3232
self.transporter.setClientApiKey(apiKey: apiKey)
3333
}
3434

35-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
35+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
3636
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
3737
/// - returns: AnyCodable
3838
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -57,7 +57,7 @@ open class InsightsClient {
5757
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
60-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
60+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
6161
//
6262
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
6363
// - returns: RequestBuilder<AnyCodable>
@@ -97,7 +97,7 @@ open class InsightsClient {
9797
)
9898
}
9999

100-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
100+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
101101
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
102102
/// - returns: AnyCodable
103103
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -122,7 +122,7 @@ open class InsightsClient {
122122
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
125+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
126126
//
127127
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
128128
// - returns: RequestBuilder<AnyCodable>
@@ -162,7 +162,7 @@ open class InsightsClient {
162162
)
163163
}
164164

165-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
165+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
166166
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
167167
/// - parameter body: (body) Parameters to send with the custom request. (optional)
168168
/// - returns: AnyCodable
@@ -190,7 +190,7 @@ open class InsightsClient {
190190
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
193+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
194194
//
195195
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
196196
//
@@ -233,7 +233,7 @@ open class InsightsClient {
233233
)
234234
}
235235

236-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
236+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
237237
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
238238
/// - parameter body: (body) Parameters to send with the custom request. (optional)
239239
/// - returns: AnyCodable
@@ -261,7 +261,7 @@ open class InsightsClient {
261261
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
264+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
265265
//
266266
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
267267
//

‎Sources/Monitoring/MonitoringClient.swift

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ open class MonitoringClient {
3232
self.transporter.setClientApiKey(apiKey: apiKey)
3333
}
3434

35-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
35+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
3636
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
3737
/// - returns: AnyCodable
3838
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -57,7 +57,7 @@ open class MonitoringClient {
5757
// This method lets you send requests to the Algolia REST API.
5858
//
5959
//
60-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
60+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
6161
//
6262
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
6363
// - returns: RequestBuilder<AnyCodable>
@@ -97,7 +97,7 @@ open class MonitoringClient {
9797
)
9898
}
9999

100-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
100+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
101101
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
102102
/// - returns: AnyCodable
103103
@available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
@@ -122,7 +122,7 @@ open class MonitoringClient {
122122
// This method lets you send requests to the Algolia REST API.
123123
//
124124
//
125-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
125+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
126126
//
127127
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
128128
// - returns: RequestBuilder<AnyCodable>
@@ -162,7 +162,7 @@ open class MonitoringClient {
162162
)
163163
}
164164

165-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
165+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
166166
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
167167
/// - parameter body: (body) Parameters to send with the custom request. (optional)
168168
/// - returns: AnyCodable
@@ -190,7 +190,7 @@ open class MonitoringClient {
190190
// This method lets you send requests to the Algolia REST API.
191191
//
192192
//
193-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
193+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
194194
//
195195
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
196196
//
@@ -233,7 +233,7 @@ open class MonitoringClient {
233233
)
234234
}
235235

236-
/// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
236+
/// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
237237
/// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
238238
/// - parameter body: (body) Parameters to send with the custom request. (optional)
239239
/// - returns: AnyCodable
@@ -261,7 +261,7 @@ open class MonitoringClient {
261261
// This method lets you send requests to the Algolia REST API.
262262
//
263263
//
264-
// - parameter path: (path) Path of the endpoint, anything after \"/1\" must be specified.
264+
// - parameter path: (path) Path of the endpoint, for example `1/newFeature`.
265265
//
266266
// - parameter parameters: (query) Query parameters to apply to the current query. (optional)
267267
//

0 commit comments

Comments
 (0)