Skip to content

Commit 4955e2d

Browse files
algolia-botmillotp
andcommitted
chore(spec): fix comment of custom path (generated)
algolia/api-clients-automation#5014 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent f786c96 commit 4955e2d

File tree

9 files changed

+36
-36
lines changed

9 files changed

+36
-36
lines changed

lib/Api/AbtestingClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ public function addABTests($addABTestsRequest, $requestOptions = [])
159159
/**
160160
* This method lets you send requests to the Algolia REST API.
161161
*
162-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
162+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
163163
* @param array $parameters Query parameters to apply to the current query. (optional)
164164
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
165165
*
@@ -198,7 +198,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
198198
/**
199199
* This method lets you send requests to the Algolia REST API.
200200
*
201-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
201+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
202202
* @param array $parameters Query parameters to apply to the current query. (optional)
203203
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
204204
*
@@ -237,7 +237,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
237237
/**
238238
* This method lets you send requests to the Algolia REST API.
239239
*
240-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
240+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
241241
* @param array $parameters Query parameters to apply to the current query. (optional)
242242
* @param array $body Parameters to send with the custom request. (optional)
243243
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -277,7 +277,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
277277
/**
278278
* This method lets you send requests to the Algolia REST API.
279279
*
280-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
280+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
281281
* @param array $parameters Query parameters to apply to the current query. (optional)
282282
* @param array $body Parameters to send with the custom request. (optional)
283283
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

lib/Api/AnalyticsClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ public function setClientApiKey($apiKey)
137137
/**
138138
* This method lets you send requests to the Algolia REST API.
139139
*
140-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
140+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
141141
* @param array $parameters Query parameters to apply to the current query. (optional)
142142
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
143143
*
@@ -176,7 +176,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
176176
/**
177177
* This method lets you send requests to the Algolia REST API.
178178
*
179-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
179+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
180180
* @param array $parameters Query parameters to apply to the current query. (optional)
181181
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
182182
*
@@ -215,7 +215,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
215215
/**
216216
* This method lets you send requests to the Algolia REST API.
217217
*
218-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
218+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
219219
* @param array $parameters Query parameters to apply to the current query. (optional)
220220
* @param array $body Parameters to send with the custom request. (optional)
221221
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -255,7 +255,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
255255
/**
256256
* This method lets you send requests to the Algolia REST API.
257257
*
258-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
258+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
259259
* @param array $parameters Query parameters to apply to the current query. (optional)
260260
* @param array $body Parameters to send with the custom request. (optional)
261261
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

lib/Api/IngestionClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -390,7 +390,7 @@ public function createTransformation($transformationCreate, $requestOptions = []
390390
/**
391391
* This method lets you send requests to the Algolia REST API.
392392
*
393-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
393+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
394394
* @param array $parameters Query parameters to apply to the current query. (optional)
395395
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
396396
*
@@ -429,7 +429,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
429429
/**
430430
* This method lets you send requests to the Algolia REST API.
431431
*
432-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
432+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
433433
* @param array $parameters Query parameters to apply to the current query. (optional)
434434
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
435435
*
@@ -468,7 +468,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
468468
/**
469469
* This method lets you send requests to the Algolia REST API.
470470
*
471-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
471+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
472472
* @param array $parameters Query parameters to apply to the current query. (optional)
473473
* @param array $body Parameters to send with the custom request. (optional)
474474
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -508,7 +508,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
508508
/**
509509
* This method lets you send requests to the Algolia REST API.
510510
*
511-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
511+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
512512
* @param array $parameters Query parameters to apply to the current query. (optional)
513513
* @param array $body Parameters to send with the custom request. (optional)
514514
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

lib/Api/InsightsClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public function setClientApiKey($apiKey)
119119
/**
120120
* This method lets you send requests to the Algolia REST API.
121121
*
122-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
122+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
123123
* @param array $parameters Query parameters to apply to the current query. (optional)
124124
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
125125
*
@@ -158,7 +158,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
158158
/**
159159
* This method lets you send requests to the Algolia REST API.
160160
*
161-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
161+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
162162
* @param array $parameters Query parameters to apply to the current query. (optional)
163163
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
164164
*
@@ -197,7 +197,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
197197
/**
198198
* This method lets you send requests to the Algolia REST API.
199199
*
200-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
200+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
201201
* @param array $parameters Query parameters to apply to the current query. (optional)
202202
* @param array $body Parameters to send with the custom request. (optional)
203203
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -237,7 +237,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
237237
/**
238238
* This method lets you send requests to the Algolia REST API.
239239
*
240-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
240+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
241241
* @param array $parameters Query parameters to apply to the current query. (optional)
242242
* @param array $body Parameters to send with the custom request. (optional)
243243
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

lib/Api/MonitoringClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ public function setClientApiKey($apiKey)
119119
/**
120120
* This method lets you send requests to the Algolia REST API.
121121
*
122-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
122+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
123123
* @param array $parameters Query parameters to apply to the current query. (optional)
124124
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
125125
*
@@ -158,7 +158,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
158158
/**
159159
* This method lets you send requests to the Algolia REST API.
160160
*
161-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
161+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
162162
* @param array $parameters Query parameters to apply to the current query. (optional)
163163
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
164164
*
@@ -197,7 +197,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
197197
/**
198198
* This method lets you send requests to the Algolia REST API.
199199
*
200-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
200+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
201201
* @param array $parameters Query parameters to apply to the current query. (optional)
202202
* @param array $body Parameters to send with the custom request. (optional)
203203
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -237,7 +237,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
237237
/**
238238
* This method lets you send requests to the Algolia REST API.
239239
*
240-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
240+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
241241
* @param array $parameters Query parameters to apply to the current query. (optional)
242242
* @param array $body Parameters to send with the custom request. (optional)
243243
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

lib/Api/PersonalizationClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ public function setClientApiKey($apiKey)
121121
/**
122122
* This method lets you send requests to the Algolia REST API.
123123
*
124-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
124+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
125125
* @param array $parameters Query parameters to apply to the current query. (optional)
126126
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
127127
*
@@ -160,7 +160,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
160160
/**
161161
* This method lets you send requests to the Algolia REST API.
162162
*
163-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
163+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
164164
* @param array $parameters Query parameters to apply to the current query. (optional)
165165
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
166166
*
@@ -199,7 +199,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
199199
/**
200200
* This method lets you send requests to the Algolia REST API.
201201
*
202-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
202+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
203203
* @param array $parameters Query parameters to apply to the current query. (optional)
204204
* @param array $body Parameters to send with the custom request. (optional)
205205
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -239,7 +239,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
239239
/**
240240
* This method lets you send requests to the Algolia REST API.
241241
*
242-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
242+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
243243
* @param array $parameters Query parameters to apply to the current query. (optional)
244244
* @param array $body Parameters to send with the custom request. (optional)
245245
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

lib/Api/QuerySuggestionsClient.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ public function createConfig($configurationWithIndex, $requestOptions = [])
154154
/**
155155
* This method lets you send requests to the Algolia REST API.
156156
*
157-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
157+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
158158
* @param array $parameters Query parameters to apply to the current query. (optional)
159159
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
160160
*
@@ -193,7 +193,7 @@ public function customDelete($path, $parameters = null, $requestOptions = [])
193193
/**
194194
* This method lets you send requests to the Algolia REST API.
195195
*
196-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
196+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
197197
* @param array $parameters Query parameters to apply to the current query. (optional)
198198
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
199199
*
@@ -232,7 +232,7 @@ public function customGet($path, $parameters = null, $requestOptions = [])
232232
/**
233233
* This method lets you send requests to the Algolia REST API.
234234
*
235-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
235+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
236236
* @param array $parameters Query parameters to apply to the current query. (optional)
237237
* @param array $body Parameters to send with the custom request. (optional)
238238
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -272,7 +272,7 @@ public function customPost($path, $parameters = null, $body = null, $requestOpti
272272
/**
273273
* This method lets you send requests to the Algolia REST API.
274274
*
275-
* @param string $path Path of the endpoint, anything after \"/1\" must be specified. (required)
275+
* @param string $path Path of the endpoint, for example `1/newFeature`. (required)
276276
* @param array $parameters Query parameters to apply to the current query. (optional)
277277
* @param array $body Parameters to send with the custom request. (optional)
278278
* @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions

0 commit comments

Comments
 (0)