Skip to content

Commit f0c1486

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 4397b2e commit f0c1486

9 files changed

+36
-36
lines changed

‎src/main/scala/algoliasearch/api/AbtestingClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ class AbtestingClient(
113113
/** This method lets you send requests to the Algolia REST API.
114114
*
115115
* @param path
116-
* Path of the endpoint, anything after \"/1\" must be specified.
116+
* Path of the endpoint, for example `1/newFeature`.
117117
* @param parameters
118118
* Query parameters to apply to the current query.
119119
*/
@@ -136,7 +136,7 @@ class AbtestingClient(
136136
/** This method lets you send requests to the Algolia REST API.
137137
*
138138
* @param path
139-
* Path of the endpoint, anything after \"/1\" must be specified.
139+
* Path of the endpoint, for example `1/newFeature`.
140140
* @param parameters
141141
* Query parameters to apply to the current query.
142142
*/
@@ -159,7 +159,7 @@ class AbtestingClient(
159159
/** This method lets you send requests to the Algolia REST API.
160160
*
161161
* @param path
162-
* Path of the endpoint, anything after \"/1\" must be specified.
162+
* Path of the endpoint, for example `1/newFeature`.
163163
* @param parameters
164164
* Query parameters to apply to the current query.
165165
* @param body
@@ -186,7 +186,7 @@ class AbtestingClient(
186186
/** This method lets you send requests to the Algolia REST API.
187187
*
188188
* @param path
189-
* Path of the endpoint, anything after \"/1\" must be specified.
189+
* Path of the endpoint, for example `1/newFeature`.
190190
* @param parameters
191191
* Query parameters to apply to the current query.
192192
* @param body

‎src/main/scala/algoliasearch/api/AnalyticsClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ class AnalyticsClient(
108108
/** This method lets you send requests to the Algolia REST API.
109109
*
110110
* @param path
111-
* Path of the endpoint, anything after \"/1\" must be specified.
111+
* Path of the endpoint, for example `1/newFeature`.
112112
* @param parameters
113113
* Query parameters to apply to the current query.
114114
*/
@@ -131,7 +131,7 @@ class AnalyticsClient(
131131
/** This method lets you send requests to the Algolia REST API.
132132
*
133133
* @param path
134-
* Path of the endpoint, anything after \"/1\" must be specified.
134+
* Path of the endpoint, for example `1/newFeature`.
135135
* @param parameters
136136
* Query parameters to apply to the current query.
137137
*/
@@ -154,7 +154,7 @@ class AnalyticsClient(
154154
/** This method lets you send requests to the Algolia REST API.
155155
*
156156
* @param path
157-
* Path of the endpoint, anything after \"/1\" must be specified.
157+
* Path of the endpoint, for example `1/newFeature`.
158158
* @param parameters
159159
* Query parameters to apply to the current query.
160160
* @param body
@@ -181,7 +181,7 @@ class AnalyticsClient(
181181
/** This method lets you send requests to the Algolia REST API.
182182
*
183183
* @param path
184-
* Path of the endpoint, anything after \"/1\" must be specified.
184+
* Path of the endpoint, for example `1/newFeature`.
185185
* @param parameters
186186
* Query parameters to apply to the current query.
187187
* @param body

‎src/main/scala/algoliasearch/api/IngestionClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ class IngestionClient(
289289
/** This method lets you send requests to the Algolia REST API.
290290
*
291291
* @param path
292-
* Path of the endpoint, anything after \"/1\" must be specified.
292+
* Path of the endpoint, for example `1/newFeature`.
293293
* @param parameters
294294
* Query parameters to apply to the current query.
295295
*/
@@ -312,7 +312,7 @@ class IngestionClient(
312312
/** This method lets you send requests to the Algolia REST API.
313313
*
314314
* @param path
315-
* Path of the endpoint, anything after \"/1\" must be specified.
315+
* Path of the endpoint, for example `1/newFeature`.
316316
* @param parameters
317317
* Query parameters to apply to the current query.
318318
*/
@@ -335,7 +335,7 @@ class IngestionClient(
335335
/** This method lets you send requests to the Algolia REST API.
336336
*
337337
* @param path
338-
* Path of the endpoint, anything after \"/1\" must be specified.
338+
* Path of the endpoint, for example `1/newFeature`.
339339
* @param parameters
340340
* Query parameters to apply to the current query.
341341
* @param body
@@ -362,7 +362,7 @@ class IngestionClient(
362362
/** This method lets you send requests to the Algolia REST API.
363363
*
364364
* @param path
365-
* Path of the endpoint, anything after \"/1\" must be specified.
365+
* Path of the endpoint, for example `1/newFeature`.
366366
* @param parameters
367367
* Query parameters to apply to the current query.
368368
* @param body

‎src/main/scala/algoliasearch/api/InsightsClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class InsightsClient(
8888
/** This method lets you send requests to the Algolia REST API.
8989
*
9090
* @param path
91-
* Path of the endpoint, anything after \"/1\" must be specified.
91+
* Path of the endpoint, for example `1/newFeature`.
9292
* @param parameters
9393
* Query parameters to apply to the current query.
9494
*/
@@ -111,7 +111,7 @@ class InsightsClient(
111111
/** This method lets you send requests to the Algolia REST API.
112112
*
113113
* @param path
114-
* Path of the endpoint, anything after \"/1\" must be specified.
114+
* Path of the endpoint, for example `1/newFeature`.
115115
* @param parameters
116116
* Query parameters to apply to the current query.
117117
*/
@@ -134,7 +134,7 @@ class InsightsClient(
134134
/** This method lets you send requests to the Algolia REST API.
135135
*
136136
* @param path
137-
* Path of the endpoint, anything after \"/1\" must be specified.
137+
* Path of the endpoint, for example `1/newFeature`.
138138
* @param parameters
139139
* Query parameters to apply to the current query.
140140
* @param body
@@ -161,7 +161,7 @@ class InsightsClient(
161161
/** This method lets you send requests to the Algolia REST API.
162162
*
163163
* @param path
164-
* Path of the endpoint, anything after \"/1\" must be specified.
164+
* Path of the endpoint, for example `1/newFeature`.
165165
* @param parameters
166166
* Query parameters to apply to the current query.
167167
* @param body

‎src/main/scala/algoliasearch/api/MonitoringClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class MonitoringClient(
8989
/** This method lets you send requests to the Algolia REST API.
9090
*
9191
* @param path
92-
* Path of the endpoint, anything after \"/1\" must be specified.
92+
* Path of the endpoint, for example `1/newFeature`.
9393
* @param parameters
9494
* Query parameters to apply to the current query.
9595
*/
@@ -112,7 +112,7 @@ class MonitoringClient(
112112
/** This method lets you send requests to the Algolia REST API.
113113
*
114114
* @param path
115-
* Path of the endpoint, anything after \"/1\" must be specified.
115+
* Path of the endpoint, for example `1/newFeature`.
116116
* @param parameters
117117
* Query parameters to apply to the current query.
118118
*/
@@ -135,7 +135,7 @@ class MonitoringClient(
135135
/** This method lets you send requests to the Algolia REST API.
136136
*
137137
* @param path
138-
* Path of the endpoint, anything after \"/1\" must be specified.
138+
* Path of the endpoint, for example `1/newFeature`.
139139
* @param parameters
140140
* Query parameters to apply to the current query.
141141
* @param body
@@ -162,7 +162,7 @@ class MonitoringClient(
162162
/** This method lets you send requests to the Algolia REST API.
163163
*
164164
* @param path
165-
* Path of the endpoint, anything after \"/1\" must be specified.
165+
* Path of the endpoint, for example `1/newFeature`.
166166
* @param parameters
167167
* Query parameters to apply to the current query.
168168
* @param body

‎src/main/scala/algoliasearch/api/PersonalizationClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class PersonalizationClient(
9191
/** This method lets you send requests to the Algolia REST API.
9292
*
9393
* @param path
94-
* Path of the endpoint, anything after \"/1\" must be specified.
94+
* Path of the endpoint, for example `1/newFeature`.
9595
* @param parameters
9696
* Query parameters to apply to the current query.
9797
*/
@@ -114,7 +114,7 @@ class PersonalizationClient(
114114
/** This method lets you send requests to the Algolia REST API.
115115
*
116116
* @param path
117-
* Path of the endpoint, anything after \"/1\" must be specified.
117+
* Path of the endpoint, for example `1/newFeature`.
118118
* @param parameters
119119
* Query parameters to apply to the current query.
120120
*/
@@ -137,7 +137,7 @@ class PersonalizationClient(
137137
/** This method lets you send requests to the Algolia REST API.
138138
*
139139
* @param path
140-
* Path of the endpoint, anything after \"/1\" must be specified.
140+
* Path of the endpoint, for example `1/newFeature`.
141141
* @param parameters
142142
* Query parameters to apply to the current query.
143143
* @param body
@@ -164,7 +164,7 @@ class PersonalizationClient(
164164
/** This method lets you send requests to the Algolia REST API.
165165
*
166166
* @param path
167-
* Path of the endpoint, anything after \"/1\" must be specified.
167+
* Path of the endpoint, for example `1/newFeature`.
168168
* @param parameters
169169
* Query parameters to apply to the current query.
170170
* @param body

‎src/main/scala/algoliasearch/api/QuerySuggestionsClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ class QuerySuggestionsClient(
115115
/** This method lets you send requests to the Algolia REST API.
116116
*
117117
* @param path
118-
* Path of the endpoint, anything after \"/1\" must be specified.
118+
* Path of the endpoint, for example `1/newFeature`.
119119
* @param parameters
120120
* Query parameters to apply to the current query.
121121
*/
@@ -138,7 +138,7 @@ class QuerySuggestionsClient(
138138
/** This method lets you send requests to the Algolia REST API.
139139
*
140140
* @param path
141-
* Path of the endpoint, anything after \"/1\" must be specified.
141+
* Path of the endpoint, for example `1/newFeature`.
142142
* @param parameters
143143
* Query parameters to apply to the current query.
144144
*/
@@ -161,7 +161,7 @@ class QuerySuggestionsClient(
161161
/** This method lets you send requests to the Algolia REST API.
162162
*
163163
* @param path
164-
* Path of the endpoint, anything after \"/1\" must be specified.
164+
* Path of the endpoint, for example `1/newFeature`.
165165
* @param parameters
166166
* Query parameters to apply to the current query.
167167
* @param body
@@ -188,7 +188,7 @@ class QuerySuggestionsClient(
188188
/** This method lets you send requests to the Algolia REST API.
189189
*
190190
* @param path
191-
* Path of the endpoint, anything after \"/1\" must be specified.
191+
* Path of the endpoint, for example `1/newFeature`.
192192
* @param parameters
193193
* Query parameters to apply to the current query.
194194
* @param body

‎src/main/scala/algoliasearch/api/RecommendClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ class RecommendClient(
131131
/** This method lets you send requests to the Algolia REST API.
132132
*
133133
* @param path
134-
* Path of the endpoint, anything after \"/1\" must be specified.
134+
* Path of the endpoint, for example `1/newFeature`.
135135
* @param parameters
136136
* Query parameters to apply to the current query.
137137
*/
@@ -154,7 +154,7 @@ class RecommendClient(
154154
/** This method lets you send requests to the Algolia REST API.
155155
*
156156
* @param path
157-
* Path of the endpoint, anything after \"/1\" must be specified.
157+
* Path of the endpoint, for example `1/newFeature`.
158158
* @param parameters
159159
* Query parameters to apply to the current query.
160160
*/
@@ -177,7 +177,7 @@ class RecommendClient(
177177
/** This method lets you send requests to the Algolia REST API.
178178
*
179179
* @param path
180-
* Path of the endpoint, anything after \"/1\" must be specified.
180+
* Path of the endpoint, for example `1/newFeature`.
181181
* @param parameters
182182
* Query parameters to apply to the current query.
183183
* @param body
@@ -204,7 +204,7 @@ class RecommendClient(
204204
/** This method lets you send requests to the Algolia REST API.
205205
*
206206
* @param path
207-
* Path of the endpoint, anything after \"/1\" must be specified.
207+
* Path of the endpoint, for example `1/newFeature`.
208208
* @param parameters
209209
* Query parameters to apply to the current query.
210210
* @param body

‎src/main/scala/algoliasearch/api/SearchClient.scala

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ class SearchClient(
446446
/** This method lets you send requests to the Algolia REST API.
447447
*
448448
* @param path
449-
* Path of the endpoint, anything after \"/1\" must be specified.
449+
* Path of the endpoint, for example `1/newFeature`.
450450
* @param parameters
451451
* Query parameters to apply to the current query.
452452
*/
@@ -469,7 +469,7 @@ class SearchClient(
469469
/** This method lets you send requests to the Algolia REST API.
470470
*
471471
* @param path
472-
* Path of the endpoint, anything after \"/1\" must be specified.
472+
* Path of the endpoint, for example `1/newFeature`.
473473
* @param parameters
474474
* Query parameters to apply to the current query.
475475
*/
@@ -492,7 +492,7 @@ class SearchClient(
492492
/** This method lets you send requests to the Algolia REST API.
493493
*
494494
* @param path
495-
* Path of the endpoint, anything after \"/1\" must be specified.
495+
* Path of the endpoint, for example `1/newFeature`.
496496
* @param parameters
497497
* Query parameters to apply to the current query.
498498
* @param body
@@ -519,7 +519,7 @@ class SearchClient(
519519
/** This method lets you send requests to the Algolia REST API.
520520
*
521521
* @param path
522-
* Path of the endpoint, anything after \"/1\" must be specified.
522+
* Path of the endpoint, for example `1/newFeature`.
523523
* @param parameters
524524
* Query parameters to apply to the current query.
525525
* @param body

0 commit comments

Comments
 (0)