Skip to content

Commit cd45c2f

Browse files
fix(specs): update sourceRun docs (#5057) (generated) [skip ci]
Co-authored-by: Devin Beeuwkes <[email protected]>
1 parent 4c9416a commit cd45c2f

File tree

23 files changed

+86
-84
lines changed

23 files changed

+86
-84
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1789,7 +1789,7 @@ WatchResponse PushTask(
17891789
);
17901790

17911791
/// <summary>
1792-
/// Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
1792+
/// Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
17931793
/// </summary>
17941794
///
17951795
/// Required API Key ACLs:
@@ -1812,7 +1812,7 @@ Task<RunSourceResponse> RunSourceAsync(
18121812
);
18131813

18141814
/// <summary>
1815-
/// Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task. (Synchronous version)
1815+
/// Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task. (Synchronous version)
18161816
/// </summary>
18171817
///
18181818
/// Required API Key ACLs:

clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/RunSourcePayload.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,23 @@ public partial class RunSourcePayload
2828
public RunSourcePayload() { }
2929

3030
/// <summary>
31-
/// List of index names to include in reidexing/update.
31+
/// List of index names to include in reindex/update.
3232
/// </summary>
33-
/// <value>List of index names to include in reidexing/update.</value>
33+
/// <value>List of index names to include in reindex/update.</value>
3434
[JsonPropertyName("indexToInclude")]
3535
public List<string> IndexToInclude { get; set; }
3636

3737
/// <summary>
38-
/// List of index names to exclude in reidexing/update.
38+
/// List of index names to exclude in reindex/update.
3939
/// </summary>
40-
/// <value>List of index names to exclude in reidexing/update.</value>
40+
/// <value>List of index names to exclude in reindex/update.</value>
4141
[JsonPropertyName("indexToExclude")]
4242
public List<string> IndexToExclude { get; set; }
4343

4444
/// <summary>
45-
/// List of entityID to update.
45+
/// List of entityIDs to update.
4646
/// </summary>
47-
/// <value>List of entityID to update.</value>
47+
/// <value>List of entityIDs to update.</value>
4848
[JsonPropertyName("entityIDs")]
4949
public List<string> EntityIDs { get; set; }
5050

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

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

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

Lines changed: 3 additions & 3 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: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3532,8 +3532,8 @@ public CompletableFuture<WatchResponse> pushTaskAsync(@Nonnull String taskID, @N
35323532
}
35333533

35343534
/**
3535-
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per
3536-
* task.
3535+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools
3536+
* sources. Creates one run per task.
35373537
*
35383538
* @param sourceID Unique identifier of a source. (required)
35393539
* @param runSourcePayload (optional)
@@ -3547,8 +3547,8 @@ public RunSourceResponse runSource(@Nonnull String sourceID, RunSourcePayload ru
35473547
}
35483548

35493549
/**
3550-
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per
3551-
* task.
3550+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools
3551+
* sources. Creates one run per task.
35523552
*
35533553
* @param sourceID Unique identifier of a source. (required)
35543554
* @param runSourcePayload (optional)
@@ -3559,8 +3559,8 @@ public RunSourceResponse runSource(@Nonnull String sourceID, RunSourcePayload ru
35593559
}
35603560

35613561
/**
3562-
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per
3563-
* task.
3562+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools
3563+
* sources. Creates one run per task.
35643564
*
35653565
* @param sourceID Unique identifier of a source. (required)
35663566
* @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -3572,8 +3572,8 @@ public RunSourceResponse runSource(@Nonnull String sourceID, @Nullable RequestOp
35723572
}
35733573

35743574
/**
3575-
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per
3576-
* task.
3575+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools
3576+
* sources. Creates one run per task.
35773577
*
35783578
* @param sourceID Unique identifier of a source. (required)
35793579
* @throws AlgoliaRuntimeException If it fails to process the API call
@@ -3583,8 +3583,8 @@ public RunSourceResponse runSource(@Nonnull String sourceID) throws AlgoliaRunti
35833583
}
35843584

35853585
/**
3586-
* (asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will
3587-
* create 1 run per task.
3586+
* (asynchronously) Runs all tasks linked to a source, only available for Shopify, BigCommerce and
3587+
* commercetools sources. Creates one run per task.
35883588
*
35893589
* @param sourceID Unique identifier of a source. (required)
35903590
* @param runSourcePayload (optional)
@@ -3608,8 +3608,8 @@ public CompletableFuture<RunSourceResponse> runSourceAsync(
36083608
}
36093609

36103610
/**
3611-
* (asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will
3612-
* create 1 run per task.
3611+
* (asynchronously) Runs all tasks linked to a source, only available for Shopify, BigCommerce and
3612+
* commercetools sources. Creates one run per task.
36133613
*
36143614
* @param sourceID Unique identifier of a source. (required)
36153615
* @param runSourcePayload (optional)
@@ -3621,8 +3621,8 @@ public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull String sourc
36213621
}
36223622

36233623
/**
3624-
* (asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will
3625-
* create 1 run per task.
3624+
* (asynchronously) Runs all tasks linked to a source, only available for Shopify, BigCommerce and
3625+
* commercetools sources. Creates one run per task.
36263626
*
36273627
* @param sourceID Unique identifier of a source. (required)
36283628
* @param requestOptions The requestOptions to send along with the query, they will be merged with
@@ -3635,8 +3635,8 @@ public CompletableFuture<RunSourceResponse> runSourceAsync(@Nonnull String sourc
36353635
}
36363636

36373637
/**
3638-
* (asynchronously) Runs all tasks linked to a source, only available for Shopify sources. It will
3639-
* create 1 run per task.
3638+
* (asynchronously) Runs all tasks linked to a source, only available for Shopify, BigCommerce and
3639+
* commercetools sources. Creates one run per task.
36403640
*
36413641
* @param sourceID Unique identifier of a source. (required)
36423642
* @throws AlgoliaRuntimeException If it fails to process the API call

clients/algoliasearch-client-java/algoliasearch/src/main/java/com/algolia/model/ingestion/RunSourcePayload.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public RunSourcePayload addIndexToInclude(String indexToIncludeItem) {
3737
return this;
3838
}
3939

40-
/** List of index names to include in reidexing/update. */
40+
/** List of index names to include in reindex/update. */
4141
@javax.annotation.Nullable
4242
public List<String> getIndexToInclude() {
4343
return indexToInclude;
@@ -56,7 +56,7 @@ public RunSourcePayload addIndexToExclude(String indexToExcludeItem) {
5656
return this;
5757
}
5858

59-
/** List of index names to exclude in reidexing/update. */
59+
/** List of index names to exclude in reindex/update. */
6060
@javax.annotation.Nullable
6161
public List<String> getIndexToExclude() {
6262
return indexToExclude;
@@ -75,7 +75,7 @@ public RunSourcePayload addEntityIDs(String entityIDsItem) {
7575
return this;
7676
}
7777

78-
/** List of entityID to update. */
78+
/** List of entityIDs to update. */
7979
@javax.annotation.Nullable
8080
public List<String> getEntityIDs() {
8181
return entityIDs;

clients/algoliasearch-client-javascript/packages/ingestion/model/runSourcePayload.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@ import type { EntityType } from './entityType';
44

55
export type RunSourcePayload = {
66
/**
7-
* List of index names to include in reidexing/update.
7+
* List of index names to include in reindex/update.
88
*/
99
indexToInclude?: Array<string> | undefined;
1010

1111
/**
12-
* List of index names to exclude in reidexing/update.
12+
* List of index names to exclude in reindex/update.
1313
*/
1414
indexToExclude?: Array<string> | undefined;
1515

1616
/**
17-
* List of entityID to update.
17+
* List of entityIDs to update.
1818
*/
1919
entityIDs?: Array<string> | undefined;
2020

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1906,7 +1906,7 @@ export function createIngestionClient({
19061906
},
19071907

19081908
/**
1909-
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
1909+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
19101910
*
19111911
* Required API Key ACLs:
19121912
* - addObject

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/api/IngestionClient.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -988,7 +988,7 @@ public class IngestionClient(
988988
}
989989

990990
/**
991-
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
991+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
992992
*
993993
* Required API Key ACLs:
994994
* - addObject

clients/algoliasearch-client-kotlin/client/src/commonMain/kotlin/com/algolia/client/model/ingestion/RunSourcePayload.kt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,21 @@ import kotlinx.serialization.json.*
77
/**
88
* RunSourcePayload
99
*
10-
* @param indexToInclude List of index names to include in reidexing/update.
11-
* @param indexToExclude List of index names to exclude in reidexing/update.
12-
* @param entityIDs List of entityID to update.
10+
* @param indexToInclude List of index names to include in reindex/update.
11+
* @param indexToExclude List of index names to exclude in reindex/update.
12+
* @param entityIDs List of entityIDs to update.
1313
* @param entityType
1414
*/
1515
@Serializable
1616
public data class RunSourcePayload(
1717

18-
/** List of index names to include in reidexing/update. */
18+
/** List of index names to include in reindex/update. */
1919
@SerialName(value = "indexToInclude") val indexToInclude: List<String>? = null,
2020

21-
/** List of index names to exclude in reidexing/update. */
21+
/** List of index names to exclude in reindex/update. */
2222
@SerialName(value = "indexToExclude") val indexToExclude: List<String>? = null,
2323

24-
/** List of entityID to update. */
24+
/** List of entityIDs to update. */
2525
@SerialName(value = "entityIDs") val entityIDs: List<String>? = null,
2626

2727
@SerialName(value = "entityType") val entityType: EntityType? = null,

0 commit comments

Comments
 (0)