Skip to content

Commit 0ad7f6a

Browse files
algolia-botmillotp
algolia-bot
and
millotp
committed
chore(spec): fix comment of custom path (#5014) (generated) [skip ci]
Co-authored-by: Pierre Millot <[email protected]>
1 parent 5e38699 commit 0ad7f6a

File tree

143 files changed

+1109
-1397
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

143 files changed

+1109
-1397
lines changed

‎clients/algoliasearch-client-csharp/algoliasearch/Clients/AbtestingClient.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ ABTestResponse AddABTests(
6161
/// <summary>
6262
/// This method lets you send requests to the Algolia REST API.
6363
/// </summary>
64-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
64+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
6565
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
6666
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
6767
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -79,7 +79,7 @@ Task<object> CustomDeleteAsync(
7979
/// <summary>
8080
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
8181
/// </summary>
82-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
82+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
8383
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
8484
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
8585
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -97,7 +97,7 @@ object CustomDelete(
9797
/// <summary>
9898
/// This method lets you send requests to the Algolia REST API.
9999
/// </summary>
100-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
100+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
101101
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
102102
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
103103
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -115,7 +115,7 @@ Task<object> CustomGetAsync(
115115
/// <summary>
116116
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
117117
/// </summary>
118-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
118+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
119119
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
120120
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
121121
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -133,7 +133,7 @@ object CustomGet(
133133
/// <summary>
134134
/// This method lets you send requests to the Algolia REST API.
135135
/// </summary>
136-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
136+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
137137
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
138138
/// <param name="body">Parameters to send with the custom request. (optional)</param>
139139
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -153,7 +153,7 @@ Task<object> CustomPostAsync(
153153
/// <summary>
154154
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
155155
/// </summary>
156-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
156+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
157157
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
158158
/// <param name="body">Parameters to send with the custom request. (optional)</param>
159159
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -173,7 +173,7 @@ object CustomPost(
173173
/// <summary>
174174
/// This method lets you send requests to the Algolia REST API.
175175
/// </summary>
176-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
176+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
177177
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
178178
/// <param name="body">Parameters to send with the custom request. (optional)</param>
179179
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -193,7 +193,7 @@ Task<object> CustomPutAsync(
193193
/// <summary>
194194
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
195195
/// </summary>
196-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
196+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
197197
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
198198
/// <param name="body">Parameters to send with the custom request. (optional)</param>
199199
/// <param name="options">Add extra http header or query parameters to Algolia.</param>

‎clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public interface IAnalyticsClient
2323
/// <summary>
2424
/// This method lets you send requests to the Algolia REST API.
2525
/// </summary>
26-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
26+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
2727
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
2828
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
2929
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -41,7 +41,7 @@ Task<object> CustomDeleteAsync(
4141
/// <summary>
4242
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
4343
/// </summary>
44-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
44+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
4545
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
4646
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
4747
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -59,7 +59,7 @@ object CustomDelete(
5959
/// <summary>
6060
/// This method lets you send requests to the Algolia REST API.
6161
/// </summary>
62-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
62+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
6363
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
6464
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
6565
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -77,7 +77,7 @@ Task<object> CustomGetAsync(
7777
/// <summary>
7878
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
7979
/// </summary>
80-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
80+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
8181
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
8282
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
8383
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -95,7 +95,7 @@ object CustomGet(
9595
/// <summary>
9696
/// This method lets you send requests to the Algolia REST API.
9797
/// </summary>
98-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
98+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
9999
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
100100
/// <param name="body">Parameters to send with the custom request. (optional)</param>
101101
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -115,7 +115,7 @@ Task<object> CustomPostAsync(
115115
/// <summary>
116116
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
117117
/// </summary>
118-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
118+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
119119
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
120120
/// <param name="body">Parameters to send with the custom request. (optional)</param>
121121
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -135,7 +135,7 @@ object CustomPost(
135135
/// <summary>
136136
/// This method lets you send requests to the Algolia REST API.
137137
/// </summary>
138-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
138+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
139139
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
140140
/// <param name="body">Parameters to send with the custom request. (optional)</param>
141141
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -155,7 +155,7 @@ Task<object> CustomPutAsync(
155155
/// <summary>
156156
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
157157
/// </summary>
158-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
158+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
159159
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
160160
/// <param name="body">Parameters to send with the custom request. (optional)</param>
161161
/// <param name="options">Add extra http header or query parameters to Algolia.</param>

‎clients/algoliasearch-client-csharp/algoliasearch/Clients/IngestionClient.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ TransformationCreateResponse CreateTransformation(
247247
/// <summary>
248248
/// This method lets you send requests to the Algolia REST API.
249249
/// </summary>
250-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
250+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
251251
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
252252
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
253253
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -265,7 +265,7 @@ Task<object> CustomDeleteAsync(
265265
/// <summary>
266266
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
267267
/// </summary>
268-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
268+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
269269
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
270270
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
271271
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -283,7 +283,7 @@ object CustomDelete(
283283
/// <summary>
284284
/// This method lets you send requests to the Algolia REST API.
285285
/// </summary>
286-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
286+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
287287
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
288288
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
289289
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -301,7 +301,7 @@ Task<object> CustomGetAsync(
301301
/// <summary>
302302
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
303303
/// </summary>
304-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
304+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
305305
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
306306
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
307307
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -319,7 +319,7 @@ object CustomGet(
319319
/// <summary>
320320
/// This method lets you send requests to the Algolia REST API.
321321
/// </summary>
322-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
322+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
323323
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
324324
/// <param name="body">Parameters to send with the custom request. (optional)</param>
325325
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -339,7 +339,7 @@ Task<object> CustomPostAsync(
339339
/// <summary>
340340
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
341341
/// </summary>
342-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
342+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
343343
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
344344
/// <param name="body">Parameters to send with the custom request. (optional)</param>
345345
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -359,7 +359,7 @@ object CustomPost(
359359
/// <summary>
360360
/// This method lets you send requests to the Algolia REST API.
361361
/// </summary>
362-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
362+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
363363
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
364364
/// <param name="body">Parameters to send with the custom request. (optional)</param>
365365
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -379,7 +379,7 @@ Task<object> CustomPutAsync(
379379
/// <summary>
380380
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
381381
/// </summary>
382-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
382+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
383383
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
384384
/// <param name="body">Parameters to send with the custom request. (optional)</param>
385385
/// <param name="options">Add extra http header or query parameters to Algolia.</param>

‎clients/algoliasearch-client-csharp/algoliasearch/Clients/InsightsClient.cs‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public interface IInsightsClient
2323
/// <summary>
2424
/// This method lets you send requests to the Algolia REST API.
2525
/// </summary>
26-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
26+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
2727
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
2828
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
2929
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -41,7 +41,7 @@ Task<object> CustomDeleteAsync(
4141
/// <summary>
4242
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
4343
/// </summary>
44-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
44+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
4545
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
4646
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
4747
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -59,7 +59,7 @@ object CustomDelete(
5959
/// <summary>
6060
/// This method lets you send requests to the Algolia REST API.
6161
/// </summary>
62-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
62+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
6363
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
6464
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
6565
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -77,7 +77,7 @@ Task<object> CustomGetAsync(
7777
/// <summary>
7878
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
7979
/// </summary>
80-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
80+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
8181
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
8282
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
8383
/// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
@@ -95,7 +95,7 @@ object CustomGet(
9595
/// <summary>
9696
/// This method lets you send requests to the Algolia REST API.
9797
/// </summary>
98-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
98+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
9999
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
100100
/// <param name="body">Parameters to send with the custom request. (optional)</param>
101101
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -115,7 +115,7 @@ Task<object> CustomPostAsync(
115115
/// <summary>
116116
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
117117
/// </summary>
118-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
118+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
119119
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
120120
/// <param name="body">Parameters to send with the custom request. (optional)</param>
121121
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -135,7 +135,7 @@ object CustomPost(
135135
/// <summary>
136136
/// This method lets you send requests to the Algolia REST API.
137137
/// </summary>
138-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
138+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
139139
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
140140
/// <param name="body">Parameters to send with the custom request. (optional)</param>
141141
/// <param name="options">Add extra http header or query parameters to Algolia.</param>
@@ -155,7 +155,7 @@ Task<object> CustomPutAsync(
155155
/// <summary>
156156
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
157157
/// </summary>
158-
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
158+
/// <param name="path">Path of the endpoint, for example `1/newFeature`.</param>
159159
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
160160
/// <param name="body">Parameters to send with the custom request. (optional)</param>
161161
/// <param name="options">Add extra http header or query parameters to Algolia.</param>

0 commit comments

Comments
 (0)