Skip to content

Commit b514a81

Browse files
algolia-botkai687
andcommitted
fix(specs): normalize spelling of summaries (#5340) (generated) [skip ci]
Co-authored-by: Kai Welke <[email protected]>
1 parent cfbd9aa commit b514a81

File tree

17 files changed

+111
-128
lines changed

17 files changed

+111
-128
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1739,7 +1739,7 @@ WatchResponse Push(
17391739
);
17401740

17411741
/// <summary>
1742-
/// Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
1742+
/// Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
17431743
/// </summary>
17441744
///
17451745
/// Required API Key ACLs:
@@ -1764,7 +1764,7 @@ Task<WatchResponse> PushTaskAsync(
17641764
);
17651765

17661766
/// <summary>
1767-
/// Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`. (Synchronous version)
1767+
/// Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`. (Synchronous version)
17681768
/// </summary>
17691769
///
17701770
/// Required API Key ACLs:

clients/algoliasearch-client-go/algolia/ingestion/api_ingestion.go

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/api/IngestionClient.java

Lines changed: 40 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -3333,14 +3333,12 @@ public CompletableFuture<WatchResponse> pushAsync(@Nonnull String indexName, @No
33333333
}
33343334

33353335
/**
3336-
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by
3336+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by
33373337
* providing the `watch` parameter, for asynchronous calls, you can use the observability
3338-
* endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the
3339-
* [pre-indexing data
3340-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3341-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3342-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3343-
* the same `indexName`.
3338+
* endpoints or the debugger dashboard to see the status of your task. If you want to transform
3339+
* your data before indexing, this is the recommended way of ingesting your records. This method
3340+
* is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when
3341+
* many `destinations` target the same `indexName`.
33443342
*
33453343
* @param taskID Unique identifier of a task. (required)
33463344
* @param pushTaskPayload (required)
@@ -3360,14 +3358,12 @@ public WatchResponse pushTask(
33603358
}
33613359

33623360
/**
3363-
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by
3361+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by
33643362
* providing the `watch` parameter, for asynchronous calls, you can use the observability
3365-
* endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the
3366-
* [pre-indexing data
3367-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3368-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3369-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3370-
* the same `indexName`.
3363+
* endpoints or the debugger dashboard to see the status of your task. If you want to transform
3364+
* your data before indexing, this is the recommended way of ingesting your records. This method
3365+
* is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when
3366+
* many `destinations` target the same `indexName`.
33713367
*
33723368
* @param taskID Unique identifier of a task. (required)
33733369
* @param pushTaskPayload (required)
@@ -3381,14 +3377,12 @@ public WatchResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload p
33813377
}
33823378

33833379
/**
3384-
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by
3380+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by
33853381
* providing the `watch` parameter, for asynchronous calls, you can use the observability
3386-
* endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the
3387-
* [pre-indexing data
3388-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3389-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3390-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3391-
* the same `indexName`.
3382+
* endpoints or the debugger dashboard to see the status of your task. If you want to transform
3383+
* your data before indexing, this is the recommended way of ingesting your records. This method
3384+
* is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when
3385+
* many `destinations` target the same `indexName`.
33923386
*
33933387
* @param taskID Unique identifier of a task. (required)
33943388
* @param pushTaskPayload (required)
@@ -3402,14 +3396,12 @@ public WatchResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload p
34023396
}
34033397

34043398
/**
3405-
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by
3399+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by
34063400
* providing the `watch` parameter, for asynchronous calls, you can use the observability
3407-
* endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the
3408-
* [pre-indexing data
3409-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3410-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3411-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3412-
* the same `indexName`.
3401+
* endpoints or the debugger dashboard to see the status of your task. If you want to transform
3402+
* your data before indexing, this is the recommended way of ingesting your records. This method
3403+
* is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when
3404+
* many `destinations` target the same `indexName`.
34133405
*
34143406
* @param taskID Unique identifier of a task. (required)
34153407
* @param pushTaskPayload (required)
@@ -3420,14 +3412,12 @@ public WatchResponse pushTask(@Nonnull String taskID, @Nonnull PushTaskPayload p
34203412
}
34213413

34223414
/**
3423-
* (asynchronously) Pushes records through the Pipeline, directly to an index. You can make the
3415+
* (asynchronously) Pushes records through the pipeline, directly to an index. You can make the
34243416
* call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the
3425-
* observability endpoints and/or debugger dashboard to see the status of your task. If you want
3426-
* to leverage the [pre-indexing data
3427-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3428-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3429-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3430-
* the same `indexName`.
3417+
* observability endpoints or the debugger dashboard to see the status of your task. If you want
3418+
* to transform your data before indexing, this is the recommended way of ingesting your records.
3419+
* This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is
3420+
* useful when many `destinations` target the same `indexName`.
34313421
*
34323422
* @param taskID Unique identifier of a task. (required)
34333423
* @param pushTaskPayload (required)
@@ -3465,14 +3455,12 @@ public CompletableFuture<WatchResponse> pushTaskAsync(
34653455
}
34663456

34673457
/**
3468-
* (asynchronously) Pushes records through the Pipeline, directly to an index. You can make the
3458+
* (asynchronously) Pushes records through the pipeline, directly to an index. You can make the
34693459
* call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the
3470-
* observability endpoints and/or debugger dashboard to see the status of your task. If you want
3471-
* to leverage the [pre-indexing data
3472-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3473-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3474-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3475-
* the same `indexName`.
3460+
* observability endpoints or the debugger dashboard to see the status of your task. If you want
3461+
* to transform your data before indexing, this is the recommended way of ingesting your records.
3462+
* This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is
3463+
* useful when many `destinations` target the same `indexName`.
34763464
*
34773465
* @param taskID Unique identifier of a task. (required)
34783466
* @param pushTaskPayload (required)
@@ -3486,14 +3474,12 @@ public CompletableFuture<WatchResponse> pushTaskAsync(@Nonnull String taskID, @N
34863474
}
34873475

34883476
/**
3489-
* (asynchronously) Pushes records through the Pipeline, directly to an index. You can make the
3477+
* (asynchronously) Pushes records through the pipeline, directly to an index. You can make the
34903478
* call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the
3491-
* observability endpoints and/or debugger dashboard to see the status of your task. If you want
3492-
* to leverage the [pre-indexing data
3493-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3494-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3495-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3496-
* the same `indexName`.
3479+
* observability endpoints or the debugger dashboard to see the status of your task. If you want
3480+
* to transform your data before indexing, this is the recommended way of ingesting your records.
3481+
* This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is
3482+
* useful when many `destinations` target the same `indexName`.
34973483
*
34983484
* @param taskID Unique identifier of a task. (required)
34993485
* @param pushTaskPayload (required)
@@ -3510,14 +3496,12 @@ public CompletableFuture<WatchResponse> pushTaskAsync(
35103496
}
35113497

35123498
/**
3513-
* (asynchronously) Pushes records through the Pipeline, directly to an index. You can make the
3499+
* (asynchronously) Pushes records through the pipeline, directly to an index. You can make the
35143500
* call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the
3515-
* observability endpoints and/or debugger dashboard to see the status of your task. If you want
3516-
* to leverage the [pre-indexing data
3517-
* transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
3518-
* this is the recommended way of ingesting your records. This method is similar to `push`, but
3519-
* requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target
3520-
* the same `indexName`.
3501+
* observability endpoints or the debugger dashboard to see the status of your task. If you want
3502+
* to transform your data before indexing, this is the recommended way of ingesting your records.
3503+
* This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is
3504+
* useful when many `destinations` target the same `indexName`.
35213505
*
35223506
* @param taskID Unique identifier of a task. (required)
35233507
* @param pushTaskPayload (required)

clients/algoliasearch-client-javascript/packages/client-composition/src/compositionClient.ts

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -317,7 +317,6 @@ export function createCompositionClient({
317317
*
318318
* Required API Key ACLs:
319319
* - editSettings
320-
* - settings
321320
* @param deleteComposition - The deleteComposition object.
322321
* @param deleteComposition.compositionID - Unique Composition ObjectID.
323322
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -352,7 +351,6 @@ export function createCompositionClient({
352351
*
353352
* Required API Key ACLs:
354353
* - editSettings
355-
* - settings
356354
* @param deleteCompositionRule - The deleteCompositionRule object.
357355
* @param deleteCompositionRule.compositionID - Unique Composition ObjectID.
358356
* @param deleteCompositionRule.objectID - Unique identifier of a rule object.
@@ -422,6 +420,7 @@ export function createCompositionClient({
422420
* Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
423421
*
424422
* Required API Key ACLs:
423+
* - editSettings
425424
* - settings
426425
* @param getRule - The getRule object.
427426
* @param getRule.compositionID - Unique Composition ObjectID.
@@ -566,7 +565,6 @@ export function createCompositionClient({
566565
*
567566
* Required API Key ACLs:
568567
* - editSettings
569-
* - settings
570568
* @param putComposition - The putComposition object.
571569
* @param putComposition.compositionID - Unique Composition ObjectID.
572570
* @param putComposition.composition - The composition object.
@@ -617,7 +615,6 @@ export function createCompositionClient({
617615
*
618616
* Required API Key ACLs:
619617
* - editSettings
620-
* - settings
621618
* @param putCompositionRule - The putCompositionRule object.
622619
* @param putCompositionRule.compositionID - Unique Composition ObjectID.
623620
* @param putCompositionRule.objectID - Unique identifier of a rule object.

clients/algoliasearch-client-javascript/packages/ingestion/src/ingestionClient.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1854,7 +1854,7 @@ export function createIngestionClient({
18541854
},
18551855

18561856
/**
1857-
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
1857+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
18581858
*
18591859
* Required API Key ACLs:
18601860
* - addObject

0 commit comments

Comments
 (0)