Skip to content

Commit a6bd3a4

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 <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 3ee7108 commit a6bd3a4

File tree

9 files changed

+288
-576
lines changed

9 files changed

+288
-576
lines changed

‎algoliasearch/abtesting/client.py‎

Lines changed: 32 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,7 @@ async def custom_delete_with_http_info(
193193
self,
194194
path: Annotated[
195195
StrictStr,
196-
Field(
197-
description='Path of the endpoint, anything after "/1" must be specified.'
198-
),
196+
Field(description="Path of the endpoint, for example `1/newFeature`."),
199197
],
200198
parameters: Annotated[
201199
Optional[Dict[str, Any]],
@@ -207,7 +205,7 @@ async def custom_delete_with_http_info(
207205
This method lets you send requests to the Algolia REST API.
208206
209207
210-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
208+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
211209
:type path: str
212210
:param parameters: Query parameters to apply to the current query.
213211
:type parameters: Dict[str, object]
@@ -240,9 +238,7 @@ async def custom_delete(
240238
self,
241239
path: Annotated[
242240
StrictStr,
243-
Field(
244-
description='Path of the endpoint, anything after "/1" must be specified.'
245-
),
241+
Field(description="Path of the endpoint, for example `1/newFeature`."),
246242
],
247243
parameters: Annotated[
248244
Optional[Dict[str, Any]],
@@ -254,7 +250,7 @@ async def custom_delete(
254250
This method lets you send requests to the Algolia REST API.
255251
256252
257-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
253+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
258254
:type path: str
259255
:param parameters: Query parameters to apply to the current query.
260256
:type parameters: Dict[str, object]
@@ -270,9 +266,7 @@ async def custom_get_with_http_info(
270266
self,
271267
path: Annotated[
272268
StrictStr,
273-
Field(
274-
description='Path of the endpoint, anything after "/1" must be specified.'
275-
),
269+
Field(description="Path of the endpoint, for example `1/newFeature`."),
276270
],
277271
parameters: Annotated[
278272
Optional[Dict[str, Any]],
@@ -284,7 +278,7 @@ async def custom_get_with_http_info(
284278
This method lets you send requests to the Algolia REST API.
285279
286280
287-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
281+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
288282
:type path: str
289283
:param parameters: Query parameters to apply to the current query.
290284
:type parameters: Dict[str, object]
@@ -315,9 +309,7 @@ async def custom_get(
315309
self,
316310
path: Annotated[
317311
StrictStr,
318-
Field(
319-
description='Path of the endpoint, anything after "/1" must be specified.'
320-
),
312+
Field(description="Path of the endpoint, for example `1/newFeature`."),
321313
],
322314
parameters: Annotated[
323315
Optional[Dict[str, Any]],
@@ -329,7 +321,7 @@ async def custom_get(
329321
This method lets you send requests to the Algolia REST API.
330322
331323
332-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
324+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
333325
:type path: str
334326
:param parameters: Query parameters to apply to the current query.
335327
:type parameters: Dict[str, object]
@@ -343,9 +335,7 @@ async def custom_post_with_http_info(
343335
self,
344336
path: Annotated[
345337
StrictStr,
346-
Field(
347-
description='Path of the endpoint, anything after "/1" must be specified.'
348-
),
338+
Field(description="Path of the endpoint, for example `1/newFeature`."),
349339
],
350340
parameters: Annotated[
351341
Optional[Dict[str, Any]],
@@ -361,7 +351,7 @@ async def custom_post_with_http_info(
361351
This method lets you send requests to the Algolia REST API.
362352
363353
364-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
354+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
365355
:type path: str
366356
:param parameters: Query parameters to apply to the current query.
367357
:type parameters: Dict[str, object]
@@ -399,9 +389,7 @@ async def custom_post(
399389
self,
400390
path: Annotated[
401391
StrictStr,
402-
Field(
403-
description='Path of the endpoint, anything after "/1" must be specified.'
404-
),
392+
Field(description="Path of the endpoint, for example `1/newFeature`."),
405393
],
406394
parameters: Annotated[
407395
Optional[Dict[str, Any]],
@@ -417,7 +405,7 @@ async def custom_post(
417405
This method lets you send requests to the Algolia REST API.
418406
419407
420-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
408+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
421409
:type path: str
422410
:param parameters: Query parameters to apply to the current query.
423411
:type parameters: Dict[str, object]
@@ -435,9 +423,7 @@ async def custom_put_with_http_info(
435423
self,
436424
path: Annotated[
437425
StrictStr,
438-
Field(
439-
description='Path of the endpoint, anything after "/1" must be specified.'
440-
),
426+
Field(description="Path of the endpoint, for example `1/newFeature`."),
441427
],
442428
parameters: Annotated[
443429
Optional[Dict[str, Any]],
@@ -453,7 +439,7 @@ async def custom_put_with_http_info(
453439
This method lets you send requests to the Algolia REST API.
454440
455441
456-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
442+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
457443
:type path: str
458444
:param parameters: Query parameters to apply to the current query.
459445
:type parameters: Dict[str, object]
@@ -491,9 +477,7 @@ async def custom_put(
491477
self,
492478
path: Annotated[
493479
StrictStr,
494-
Field(
495-
description='Path of the endpoint, anything after "/1" must be specified.'
496-
),
480+
Field(description="Path of the endpoint, for example `1/newFeature`."),
497481
],
498482
parameters: Annotated[
499483
Optional[Dict[str, Any]],
@@ -509,7 +493,7 @@ async def custom_put(
509493
This method lets you send requests to the Algolia REST API.
510494
511495
512-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
496+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
513497
:type path: str
514498
:param parameters: Query parameters to apply to the current query.
515499
:type parameters: Dict[str, object]
@@ -1042,9 +1026,7 @@ def custom_delete_with_http_info(
10421026
self,
10431027
path: Annotated[
10441028
StrictStr,
1045-
Field(
1046-
description='Path of the endpoint, anything after "/1" must be specified.'
1047-
),
1029+
Field(description="Path of the endpoint, for example `1/newFeature`."),
10481030
],
10491031
parameters: Annotated[
10501032
Optional[Dict[str, Any]],
@@ -1056,7 +1038,7 @@ def custom_delete_with_http_info(
10561038
This method lets you send requests to the Algolia REST API.
10571039
10581040
1059-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1041+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
10601042
:type path: str
10611043
:param parameters: Query parameters to apply to the current query.
10621044
:type parameters: Dict[str, object]
@@ -1089,9 +1071,7 @@ def custom_delete(
10891071
self,
10901072
path: Annotated[
10911073
StrictStr,
1092-
Field(
1093-
description='Path of the endpoint, anything after "/1" must be specified.'
1094-
),
1074+
Field(description="Path of the endpoint, for example `1/newFeature`."),
10951075
],
10961076
parameters: Annotated[
10971077
Optional[Dict[str, Any]],
@@ -1103,7 +1083,7 @@ def custom_delete(
11031083
This method lets you send requests to the Algolia REST API.
11041084
11051085
1106-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1086+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
11071087
:type path: str
11081088
:param parameters: Query parameters to apply to the current query.
11091089
:type parameters: Dict[str, object]
@@ -1117,9 +1097,7 @@ def custom_get_with_http_info(
11171097
self,
11181098
path: Annotated[
11191099
StrictStr,
1120-
Field(
1121-
description='Path of the endpoint, anything after "/1" must be specified.'
1122-
),
1100+
Field(description="Path of the endpoint, for example `1/newFeature`."),
11231101
],
11241102
parameters: Annotated[
11251103
Optional[Dict[str, Any]],
@@ -1131,7 +1109,7 @@ def custom_get_with_http_info(
11311109
This method lets you send requests to the Algolia REST API.
11321110
11331111
1134-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1112+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
11351113
:type path: str
11361114
:param parameters: Query parameters to apply to the current query.
11371115
:type parameters: Dict[str, object]
@@ -1162,9 +1140,7 @@ def custom_get(
11621140
self,
11631141
path: Annotated[
11641142
StrictStr,
1165-
Field(
1166-
description='Path of the endpoint, anything after "/1" must be specified.'
1167-
),
1143+
Field(description="Path of the endpoint, for example `1/newFeature`."),
11681144
],
11691145
parameters: Annotated[
11701146
Optional[Dict[str, Any]],
@@ -1176,7 +1152,7 @@ def custom_get(
11761152
This method lets you send requests to the Algolia REST API.
11771153
11781154
1179-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1155+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
11801156
:type path: str
11811157
:param parameters: Query parameters to apply to the current query.
11821158
:type parameters: Dict[str, object]
@@ -1190,9 +1166,7 @@ def custom_post_with_http_info(
11901166
self,
11911167
path: Annotated[
11921168
StrictStr,
1193-
Field(
1194-
description='Path of the endpoint, anything after "/1" must be specified.'
1195-
),
1169+
Field(description="Path of the endpoint, for example `1/newFeature`."),
11961170
],
11971171
parameters: Annotated[
11981172
Optional[Dict[str, Any]],
@@ -1208,7 +1182,7 @@ def custom_post_with_http_info(
12081182
This method lets you send requests to the Algolia REST API.
12091183
12101184
1211-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1185+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
12121186
:type path: str
12131187
:param parameters: Query parameters to apply to the current query.
12141188
:type parameters: Dict[str, object]
@@ -1246,9 +1220,7 @@ def custom_post(
12461220
self,
12471221
path: Annotated[
12481222
StrictStr,
1249-
Field(
1250-
description='Path of the endpoint, anything after "/1" must be specified.'
1251-
),
1223+
Field(description="Path of the endpoint, for example `1/newFeature`."),
12521224
],
12531225
parameters: Annotated[
12541226
Optional[Dict[str, Any]],
@@ -1264,7 +1236,7 @@ def custom_post(
12641236
This method lets you send requests to the Algolia REST API.
12651237
12661238
1267-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1239+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
12681240
:type path: str
12691241
:param parameters: Query parameters to apply to the current query.
12701242
:type parameters: Dict[str, object]
@@ -1280,9 +1252,7 @@ def custom_put_with_http_info(
12801252
self,
12811253
path: Annotated[
12821254
StrictStr,
1283-
Field(
1284-
description='Path of the endpoint, anything after "/1" must be specified.'
1285-
),
1255+
Field(description="Path of the endpoint, for example `1/newFeature`."),
12861256
],
12871257
parameters: Annotated[
12881258
Optional[Dict[str, Any]],
@@ -1298,7 +1268,7 @@ def custom_put_with_http_info(
12981268
This method lets you send requests to the Algolia REST API.
12991269
13001270
1301-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1271+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
13021272
:type path: str
13031273
:param parameters: Query parameters to apply to the current query.
13041274
:type parameters: Dict[str, object]
@@ -1336,9 +1306,7 @@ def custom_put(
13361306
self,
13371307
path: Annotated[
13381308
StrictStr,
1339-
Field(
1340-
description='Path of the endpoint, anything after "/1" must be specified.'
1341-
),
1309+
Field(description="Path of the endpoint, for example `1/newFeature`."),
13421310
],
13431311
parameters: Annotated[
13441312
Optional[Dict[str, Any]],
@@ -1354,7 +1322,7 @@ def custom_put(
13541322
This method lets you send requests to the Algolia REST API.
13551323
13561324
1357-
:param path: Path of the endpoint, anything after \"/1\" must be specified. (required)
1325+
:param path: Path of the endpoint, for example `1/newFeature`. (required)
13581326
:type path: str
13591327
:param parameters: Query parameters to apply to the current query.
13601328
:type parameters: Dict[str, object]

0 commit comments

Comments
 (0)