Skip to content

Commit 2315f52

Browse files
algolia-botkai687
andcommitted
docs(specs): align with style guides (generated)
algolia/api-clients-automation#5930 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: Kai Welke <kai.welke@algolia.com>
1 parent 48a96f4 commit 2315f52

Some content is hidden

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

63 files changed

+1425
-1531
lines changed

algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java

Lines changed: 408 additions & 456 deletions
Large diffs are not rendered by default.

algoliasearch/src/main/java/com/algolia/api/CompositionClient.java

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -2986,13 +2986,13 @@ public CompletableFuture<Response> searchForFacetValuesWithHTTPInfoAsync(@Nonnul
29862986
}
29872987

29882988
/**
2989-
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to
2990-
* create a new sorting strategy mapping or replace the currently configured one. The provided
2991-
* sorting indices MUST be associated indices or replicas of the main targeted index. WARNING:
2992-
* This endpoint cannot validate if the sort index is related to the composition's main index.
2993-
* Validation will fail at runtime if the index you updated is not related! The update is applied
2994-
* to the specified composition within the current Algolia application and returns a taskID that
2995-
* can be used to track the operation’s completion.
2989+
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create
2990+
* a new sorting strategy mapping or replace the configured one. The provided sorting indices must
2991+
* be associated indices or replicas of the main targeted index. This endpoint can't validate
2992+
* whether the sort index is related to the composition's main index. Validation fails at runtime
2993+
* if the index you updated isn't related. The update is applied to the specified composition
2994+
* within the current Algolia application and returns a taskID that can be used to track the
2995+
* operation’s completion.
29962996
*
29972997
* @param compositionID Unique Composition ObjectID. (required)
29982998
* @param requestBody (required)
@@ -3009,13 +3009,13 @@ public TaskIDResponse updateSortingStrategyComposition(
30093009
}
30103010

30113011
/**
3012-
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to
3013-
* create a new sorting strategy mapping or replace the currently configured one. The provided
3014-
* sorting indices MUST be associated indices or replicas of the main targeted index. WARNING:
3015-
* This endpoint cannot validate if the sort index is related to the composition's main index.
3016-
* Validation will fail at runtime if the index you updated is not related! The update is applied
3017-
* to the specified composition within the current Algolia application and returns a taskID that
3018-
* can be used to track the operation’s completion.
3012+
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create
3013+
* a new sorting strategy mapping or replace the configured one. The provided sorting indices must
3014+
* be associated indices or replicas of the main targeted index. This endpoint can't validate
3015+
* whether the sort index is related to the composition's main index. Validation fails at runtime
3016+
* if the index you updated isn't related. The update is applied to the specified composition
3017+
* within the current Algolia application and returns a taskID that can be used to track the
3018+
* operation’s completion.
30193019
*
30203020
* @param compositionID Unique Composition ObjectID. (required)
30213021
* @param requestBody (required)
@@ -3032,13 +3032,13 @@ public Response updateSortingStrategyCompositionWithHTTPInfo(
30323032
}
30333033

30343034
/**
3035-
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to
3036-
* create a new sorting strategy mapping or replace the currently configured one. The provided
3037-
* sorting indices MUST be associated indices or replicas of the main targeted index. WARNING:
3038-
* This endpoint cannot validate if the sort index is related to the composition's main index.
3039-
* Validation will fail at runtime if the index you updated is not related! The update is applied
3040-
* to the specified composition within the current Algolia application and returns a taskID that
3041-
* can be used to track the operation’s completion.
3035+
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create
3036+
* a new sorting strategy mapping or replace the configured one. The provided sorting indices must
3037+
* be associated indices or replicas of the main targeted index. This endpoint can't validate
3038+
* whether the sort index is related to the composition's main index. Validation fails at runtime
3039+
* if the index you updated isn't related. The update is applied to the specified composition
3040+
* within the current Algolia application and returns a taskID that can be used to track the
3041+
* operation’s completion.
30423042
*
30433043
* @param compositionID Unique Composition ObjectID. (required)
30443044
* @param requestBody (required)
@@ -3050,13 +3050,13 @@ public TaskIDResponse updateSortingStrategyComposition(@Nonnull String compositi
30503050
}
30513051

30523052
/**
3053-
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to
3054-
* create a new sorting strategy mapping or replace the currently configured one. The provided
3055-
* sorting indices MUST be associated indices or replicas of the main targeted index. WARNING:
3056-
* This endpoint cannot validate if the sort index is related to the composition's main index.
3057-
* Validation will fail at runtime if the index you updated is not related! The update is applied
3058-
* to the specified composition within the current Algolia application and returns a taskID that
3059-
* can be used to track the operation’s completion.
3053+
* Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create
3054+
* a new sorting strategy mapping or replace the configured one. The provided sorting indices must
3055+
* be associated indices or replicas of the main targeted index. This endpoint can't validate
3056+
* whether the sort index is related to the composition's main index. Validation fails at runtime
3057+
* if the index you updated isn't related. The update is applied to the specified composition
3058+
* within the current Algolia application and returns a taskID that can be used to track the
3059+
* operation’s completion.
30603060
*
30613061
* @param compositionID Unique Composition ObjectID. (required)
30623062
* @param requestBody (required)
@@ -3069,12 +3069,12 @@ public Response updateSortingStrategyCompositionWithHTTPInfo(@Nonnull String com
30693069

30703070
/**
30713071
* (asynchronously) Updates the \"sortingStrategy\" field of an existing composition. This
3072-
* endpoint allows you to create a new sorting strategy mapping or replace the currently
3073-
* configured one. The provided sorting indices MUST be associated indices or replicas of the main
3074-
* targeted index. WARNING: This endpoint cannot validate if the sort index is related to the
3075-
* composition's main index. Validation will fail at runtime if the index you updated is not
3076-
* related! The update is applied to the specified composition within the current Algolia
3077-
* application and returns a taskID that can be used to track the operation’s completion.
3072+
* endpoint lets you create a new sorting strategy mapping or replace the configured one. The
3073+
* provided sorting indices must be associated indices or replicas of the main targeted index.
3074+
* This endpoint can't validate whether the sort index is related to the composition's main index.
3075+
* Validation fails at runtime if the index you updated isn't related. The update is applied to
3076+
* the specified composition within the current Algolia application and returns a taskID that can
3077+
* be used to track the operation’s completion.
30783078
*
30793079
* @param compositionID Unique Composition ObjectID. (required)
30803080
* @param requestBody (required)
@@ -3101,12 +3101,12 @@ public CompletableFuture<TaskIDResponse> updateSortingStrategyCompositionAsync(
31013101

31023102
/**
31033103
* (asynchronously) Updates the \"sortingStrategy\" field of an existing composition. This
3104-
* endpoint allows you to create a new sorting strategy mapping or replace the currently
3105-
* configured one. The provided sorting indices MUST be associated indices or replicas of the main
3106-
* targeted index. WARNING: This endpoint cannot validate if the sort index is related to the
3107-
* composition's main index. Validation will fail at runtime if the index you updated is not
3108-
* related! The update is applied to the specified composition within the current Algolia
3109-
* application and returns a taskID that can be used to track the operation’s completion.
3104+
* endpoint lets you create a new sorting strategy mapping or replace the configured one. The
3105+
* provided sorting indices must be associated indices or replicas of the main targeted index.
3106+
* This endpoint can't validate whether the sort index is related to the composition's main index.
3107+
* Validation fails at runtime if the index you updated isn't related. The update is applied to
3108+
* the specified composition within the current Algolia application and returns a taskID that can
3109+
* be used to track the operation’s completion.
31103110
*
31113111
* @param compositionID Unique Composition ObjectID. (required)
31123112
* @param requestBody (required)
@@ -3133,12 +3133,12 @@ public CompletableFuture<Response> updateSortingStrategyCompositionWithHTTPInfoA
31333133

31343134
/**
31353135
* (asynchronously) Updates the \"sortingStrategy\" field of an existing composition. This
3136-
* endpoint allows you to create a new sorting strategy mapping or replace the currently
3137-
* configured one. The provided sorting indices MUST be associated indices or replicas of the main
3138-
* targeted index. WARNING: This endpoint cannot validate if the sort index is related to the
3139-
* composition's main index. Validation will fail at runtime if the index you updated is not
3140-
* related! The update is applied to the specified composition within the current Algolia
3141-
* application and returns a taskID that can be used to track the operation’s completion.
3136+
* endpoint lets you create a new sorting strategy mapping or replace the configured one. The
3137+
* provided sorting indices must be associated indices or replicas of the main targeted index.
3138+
* This endpoint can't validate whether the sort index is related to the composition's main index.
3139+
* Validation fails at runtime if the index you updated isn't related. The update is applied to
3140+
* the specified composition within the current Algolia application and returns a taskID that can
3141+
* be used to track the operation’s completion.
31423142
*
31433143
* @param compositionID Unique Composition ObjectID. (required)
31443144
* @param requestBody (required)
@@ -3153,12 +3153,12 @@ public CompletableFuture<TaskIDResponse> updateSortingStrategyCompositionAsync(
31533153

31543154
/**
31553155
* (asynchronously) Updates the \"sortingStrategy\" field of an existing composition. This
3156-
* endpoint allows you to create a new sorting strategy mapping or replace the currently
3157-
* configured one. The provided sorting indices MUST be associated indices or replicas of the main
3158-
* targeted index. WARNING: This endpoint cannot validate if the sort index is related to the
3159-
* composition's main index. Validation will fail at runtime if the index you updated is not
3160-
* related! The update is applied to the specified composition within the current Algolia
3161-
* application and returns a taskID that can be used to track the operation’s completion.
3156+
* endpoint lets you create a new sorting strategy mapping or replace the configured one. The
3157+
* provided sorting indices must be associated indices or replicas of the main targeted index.
3158+
* This endpoint can't validate whether the sort index is related to the composition's main index.
3159+
* Validation fails at runtime if the index you updated isn't related. The update is applied to
3160+
* the specified composition within the current Algolia application and returns a taskID that can
3161+
* be used to track the operation’s completion.
31623162
*
31633163
* @param compositionID Unique Composition ObjectID. (required)
31643164
* @param requestBody (required)

0 commit comments

Comments
 (0)