Skip to content

Commit 5277712

Browse files
algolia-botgazconroy
algolia-bot
and
gazconroy
committed
fix(specs): Increase optionalWords visibility in docs (#4559) (generated) [skip ci]
Co-authored-by: gazconroy <[email protected]>
1 parent 97d2722 commit 5277712

File tree

180 files changed

+1233
-1133
lines changed

Some content is hidden

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

180 files changed

+1233
-1133
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public interface IAbtestingClient
5252
ABTestResponse AddABTests(AddABTestsRequest addABTestsRequest, RequestOptions options = null, CancellationToken cancellationToken = default);
5353

5454
/// <summary>
55-
/// This method allow you to send requests to the Algolia REST API.
55+
/// This method lets you send requests to the Algolia REST API.
5656
/// </summary>
5757
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
5858
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -65,7 +65,7 @@ public interface IAbtestingClient
6565
Task<object> CustomDeleteAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
6666

6767
/// <summary>
68-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
68+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
6969
/// </summary>
7070
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
7171
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -78,7 +78,7 @@ public interface IAbtestingClient
7878
object CustomDelete(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
7979

8080
/// <summary>
81-
/// This method allow you to send requests to the Algolia REST API.
81+
/// This method lets you send requests to the Algolia REST API.
8282
/// </summary>
8383
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
8484
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -91,7 +91,7 @@ public interface IAbtestingClient
9191
Task<object> CustomGetAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
9292

9393
/// <summary>
94-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
94+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
9595
/// </summary>
9696
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
9797
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -104,7 +104,7 @@ public interface IAbtestingClient
104104
object CustomGet(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
105105

106106
/// <summary>
107-
/// This method allow you to send requests to the Algolia REST API.
107+
/// This method lets you send requests to the Algolia REST API.
108108
/// </summary>
109109
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
110110
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -118,7 +118,7 @@ public interface IAbtestingClient
118118
Task<object> CustomPostAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
119119

120120
/// <summary>
121-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
121+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
122122
/// </summary>
123123
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
124124
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -132,7 +132,7 @@ public interface IAbtestingClient
132132
object CustomPost(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
133133

134134
/// <summary>
135-
/// This method allow you to send requests to the Algolia REST API.
135+
/// This method lets you send requests to the Algolia REST API.
136136
/// </summary>
137137
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
138138
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -146,7 +146,7 @@ public interface IAbtestingClient
146146
Task<object> CustomPutAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
147147

148148
/// <summary>
149-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
149+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
150150
/// </summary>
151151
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
152152
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace Algolia.Search.Clients;
2222
public interface IAnalyticsClient
2323
{
2424
/// <summary>
25-
/// This method allow you to send requests to the Algolia REST API.
25+
/// This method lets you send requests to the Algolia REST API.
2626
/// </summary>
2727
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
2828
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -35,7 +35,7 @@ public interface IAnalyticsClient
3535
Task<object> CustomDeleteAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
3636

3737
/// <summary>
38-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
38+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
3939
/// </summary>
4040
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
4141
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -48,7 +48,7 @@ public interface IAnalyticsClient
4848
object CustomDelete(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
4949

5050
/// <summary>
51-
/// This method allow you to send requests to the Algolia REST API.
51+
/// This method lets you send requests to the Algolia REST API.
5252
/// </summary>
5353
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
5454
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -61,7 +61,7 @@ public interface IAnalyticsClient
6161
Task<object> CustomGetAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
6262

6363
/// <summary>
64-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
64+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
6565
/// </summary>
6666
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
6767
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -74,7 +74,7 @@ public interface IAnalyticsClient
7474
object CustomGet(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
7575

7676
/// <summary>
77-
/// This method allow you to send requests to the Algolia REST API.
77+
/// This method lets you send requests to the Algolia REST API.
7878
/// </summary>
7979
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
8080
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -88,7 +88,7 @@ public interface IAnalyticsClient
8888
Task<object> CustomPostAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
8989

9090
/// <summary>
91-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
91+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
9292
/// </summary>
9393
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
9494
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -102,7 +102,7 @@ public interface IAnalyticsClient
102102
object CustomPost(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
103103

104104
/// <summary>
105-
/// This method allow you to send requests to the Algolia REST API.
105+
/// This method lets you send requests to the Algolia REST API.
106106
/// </summary>
107107
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
108108
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -116,7 +116,7 @@ public interface IAnalyticsClient
116116
Task<object> CustomPutAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
117117

118118
/// <summary>
119-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
119+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
120120
/// </summary>
121121
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
122122
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public interface IIngestionClient
198198
TransformationCreateResponse CreateTransformation(TransformationCreate transformationCreate, RequestOptions options = null, CancellationToken cancellationToken = default);
199199

200200
/// <summary>
201-
/// This method allow you to send requests to the Algolia REST API.
201+
/// This method lets you send requests to the Algolia REST API.
202202
/// </summary>
203203
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
204204
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -211,7 +211,7 @@ public interface IIngestionClient
211211
Task<object> CustomDeleteAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
212212

213213
/// <summary>
214-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
214+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
215215
/// </summary>
216216
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
217217
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -224,7 +224,7 @@ public interface IIngestionClient
224224
object CustomDelete(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
225225

226226
/// <summary>
227-
/// This method allow you to send requests to the Algolia REST API.
227+
/// This method lets you send requests to the Algolia REST API.
228228
/// </summary>
229229
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
230230
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -237,7 +237,7 @@ public interface IIngestionClient
237237
Task<object> CustomGetAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
238238

239239
/// <summary>
240-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
240+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
241241
/// </summary>
242242
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
243243
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -250,7 +250,7 @@ public interface IIngestionClient
250250
object CustomGet(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
251251

252252
/// <summary>
253-
/// This method allow you to send requests to the Algolia REST API.
253+
/// This method lets you send requests to the Algolia REST API.
254254
/// </summary>
255255
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
256256
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -264,7 +264,7 @@ public interface IIngestionClient
264264
Task<object> CustomPostAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
265265

266266
/// <summary>
267-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
267+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
268268
/// </summary>
269269
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
270270
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -278,7 +278,7 @@ public interface IIngestionClient
278278
object CustomPost(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
279279

280280
/// <summary>
281-
/// This method allow you to send requests to the Algolia REST API.
281+
/// This method lets you send requests to the Algolia REST API.
282282
/// </summary>
283283
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
284284
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -292,7 +292,7 @@ public interface IIngestionClient
292292
Task<object> CustomPutAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
293293

294294
/// <summary>
295-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
295+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
296296
/// </summary>
297297
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
298298
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace Algolia.Search.Clients;
2222
public interface IInsightsClient
2323
{
2424
/// <summary>
25-
/// This method allow you to send requests to the Algolia REST API.
25+
/// This method lets you send requests to the Algolia REST API.
2626
/// </summary>
2727
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
2828
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -35,7 +35,7 @@ public interface IInsightsClient
3535
Task<object> CustomDeleteAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
3636

3737
/// <summary>
38-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
38+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
3939
/// </summary>
4040
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
4141
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -48,7 +48,7 @@ public interface IInsightsClient
4848
object CustomDelete(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
4949

5050
/// <summary>
51-
/// This method allow you to send requests to the Algolia REST API.
51+
/// This method lets you send requests to the Algolia REST API.
5252
/// </summary>
5353
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
5454
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -61,7 +61,7 @@ public interface IInsightsClient
6161
Task<object> CustomGetAsync(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
6262

6363
/// <summary>
64-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
64+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
6565
/// </summary>
6666
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
6767
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -74,7 +74,7 @@ public interface IInsightsClient
7474
object CustomGet(string path, Dictionary<string, object> parameters = default, RequestOptions options = null, CancellationToken cancellationToken = default);
7575

7676
/// <summary>
77-
/// This method allow you to send requests to the Algolia REST API.
77+
/// This method lets you send requests to the Algolia REST API.
7878
/// </summary>
7979
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
8080
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -88,7 +88,7 @@ public interface IInsightsClient
8888
Task<object> CustomPostAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
8989

9090
/// <summary>
91-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
91+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
9292
/// </summary>
9393
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
9494
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -102,7 +102,7 @@ public interface IInsightsClient
102102
object CustomPost(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
103103

104104
/// <summary>
105-
/// This method allow you to send requests to the Algolia REST API.
105+
/// This method lets you send requests to the Algolia REST API.
106106
/// </summary>
107107
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
108108
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>
@@ -116,7 +116,7 @@ public interface IInsightsClient
116116
Task<object> CustomPutAsync(string path, Dictionary<string, object> parameters = default, object body = default, RequestOptions options = null, CancellationToken cancellationToken = default);
117117

118118
/// <summary>
119-
/// This method allow you to send requests to the Algolia REST API. (Synchronous version)
119+
/// This method lets you send requests to the Algolia REST API. (Synchronous version)
120120
/// </summary>
121121
/// <param name="path">Path of the endpoint, anything after \"/1\" must be specified.</param>
122122
/// <param name="parameters">Query parameters to apply to the current query. (optional)</param>

0 commit comments

Comments
 (0)