Skip to content

Commit d703195

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 98c5675 commit d703195

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

packages/algoliasearch/lib/src/api/search_client.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ final class SearchClient implements ApiClient {
4949
/// This method lets you send requests to the Algolia REST API.
5050
///
5151
/// Parameters:
52-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
52+
/// * [path] Path of the endpoint, for example `1/newFeature`.
5353
/// * [parameters] Query parameters to apply to the current query.
5454
/// * [body] Parameters to send with the custom request.
5555
/// * [requestOptions] additional request configuration.

packages/client_insights/lib/src/api/insights_client.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ final class InsightsClient implements ApiClient {
5050
/// This method lets you send requests to the Algolia REST API.
5151
///
5252
/// Parameters:
53-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
53+
/// * [path] Path of the endpoint, for example `1/newFeature`.
5454
/// * [parameters] Query parameters to apply to the current query.
5555
/// * [requestOptions] additional request configuration.
5656
Future<Object> customDelete({
@@ -83,7 +83,7 @@ final class InsightsClient implements ApiClient {
8383
/// This method lets you send requests to the Algolia REST API.
8484
///
8585
/// Parameters:
86-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
86+
/// * [path] Path of the endpoint, for example `1/newFeature`.
8787
/// * [parameters] Query parameters to apply to the current query.
8888
/// * [requestOptions] additional request configuration.
8989
Future<Object> customGet({
@@ -116,7 +116,7 @@ final class InsightsClient implements ApiClient {
116116
/// This method lets you send requests to the Algolia REST API.
117117
///
118118
/// Parameters:
119-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
119+
/// * [path] Path of the endpoint, for example `1/newFeature`.
120120
/// * [parameters] Query parameters to apply to the current query.
121121
/// * [body] Parameters to send with the custom request.
122122
/// * [requestOptions] additional request configuration.
@@ -152,7 +152,7 @@ final class InsightsClient implements ApiClient {
152152
/// This method lets you send requests to the Algolia REST API.
153153
///
154154
/// Parameters:
155-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
155+
/// * [path] Path of the endpoint, for example `1/newFeature`.
156156
/// * [parameters] Query parameters to apply to the current query.
157157
/// * [body] Parameters to send with the custom request.
158158
/// * [requestOptions] additional request configuration.

packages/client_recommend/lib/src/api/recommend_client.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ final class RecommendClient implements ApiClient {
9292
/// This method lets you send requests to the Algolia REST API.
9393
///
9494
/// Parameters:
95-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
95+
/// * [path] Path of the endpoint, for example `1/newFeature`.
9696
/// * [parameters] Query parameters to apply to the current query.
9797
/// * [requestOptions] additional request configuration.
9898
Future<Object> customDelete({
@@ -125,7 +125,7 @@ final class RecommendClient implements ApiClient {
125125
/// This method lets you send requests to the Algolia REST API.
126126
///
127127
/// Parameters:
128-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
128+
/// * [path] Path of the endpoint, for example `1/newFeature`.
129129
/// * [parameters] Query parameters to apply to the current query.
130130
/// * [requestOptions] additional request configuration.
131131
Future<Object> customGet({
@@ -158,7 +158,7 @@ final class RecommendClient implements ApiClient {
158158
/// This method lets you send requests to the Algolia REST API.
159159
///
160160
/// Parameters:
161-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
161+
/// * [path] Path of the endpoint, for example `1/newFeature`.
162162
/// * [parameters] Query parameters to apply to the current query.
163163
/// * [body] Parameters to send with the custom request.
164164
/// * [requestOptions] additional request configuration.
@@ -194,7 +194,7 @@ final class RecommendClient implements ApiClient {
194194
/// This method lets you send requests to the Algolia REST API.
195195
///
196196
/// Parameters:
197-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
197+
/// * [path] Path of the endpoint, for example `1/newFeature`.
198198
/// * [parameters] Query parameters to apply to the current query.
199199
/// * [body] Parameters to send with the custom request.
200200
/// * [requestOptions] additional request configuration.

packages/client_search/lib/src/api/search_client.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -498,7 +498,7 @@ final class SearchClient implements ApiClient {
498498
/// This method lets you send requests to the Algolia REST API.
499499
///
500500
/// Parameters:
501-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
501+
/// * [path] Path of the endpoint, for example `1/newFeature`.
502502
/// * [parameters] Query parameters to apply to the current query.
503503
/// * [requestOptions] additional request configuration.
504504
Future<Object> customDelete({
@@ -531,7 +531,7 @@ final class SearchClient implements ApiClient {
531531
/// This method lets you send requests to the Algolia REST API.
532532
///
533533
/// Parameters:
534-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
534+
/// * [path] Path of the endpoint, for example `1/newFeature`.
535535
/// * [parameters] Query parameters to apply to the current query.
536536
/// * [requestOptions] additional request configuration.
537537
Future<Object> customGet({
@@ -564,7 +564,7 @@ final class SearchClient implements ApiClient {
564564
/// This method lets you send requests to the Algolia REST API.
565565
///
566566
/// Parameters:
567-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
567+
/// * [path] Path of the endpoint, for example `1/newFeature`.
568568
/// * [parameters] Query parameters to apply to the current query.
569569
/// * [body] Parameters to send with the custom request.
570570
/// * [requestOptions] additional request configuration.
@@ -600,7 +600,7 @@ final class SearchClient implements ApiClient {
600600
/// This method lets you send requests to the Algolia REST API.
601601
///
602602
/// Parameters:
603-
/// * [path] Path of the endpoint, anything after \"/1\" must be specified.
603+
/// * [path] Path of the endpoint, for example `1/newFeature`.
604604
/// * [parameters] Query parameters to apply to the current query.
605605
/// * [body] Parameters to send with the custom request.
606606
/// * [requestOptions] additional request configuration.

0 commit comments

Comments
 (0)