diff --git a/.eslintrc.js b/.eslintrc.js index bddc0f5770..1c753ed834 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -64,10 +64,6 @@ module.exports = { 'no-continue': 0, '@typescript-eslint/prefer-enum-initializers': 0, - // in the meantime of finding an alternative, we warn - 'no-shadow': 'off', - '@typescript-eslint/no-shadow': ['warn'], - '@typescript-eslint/no-unused-vars': 2, 'unused-imports/no-unused-imports-ts': 2, '@typescript-eslint/member-ordering': [ diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchDictionaryEntries.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchDictionaryEntriesParams.java similarity index 81% rename from clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchDictionaryEntries.java rename to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchDictionaryEntriesParams.java index d45f5ac17d..41bfc9d320 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchDictionaryEntries.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/BatchDictionaryEntriesParams.java @@ -5,8 +5,8 @@ import java.util.List; import java.util.Objects; -/** The `batchDictionaryEntries` requests. */ -public class BatchDictionaryEntries { +/** The `batchDictionaryEntries` parameters. */ +public class BatchDictionaryEntriesParams { @SerializedName("clearExistingDictionaryEntries") private Boolean clearExistingDictionaryEntries = false; @@ -14,7 +14,7 @@ public class BatchDictionaryEntries { @SerializedName("requests") private List requests = new ArrayList<>(); - public BatchDictionaryEntries clearExistingDictionaryEntries( + public BatchDictionaryEntriesParams clearExistingDictionaryEntries( Boolean clearExistingDictionaryEntries ) { this.clearExistingDictionaryEntries = clearExistingDictionaryEntries; @@ -37,14 +37,14 @@ public void setClearExistingDictionaryEntries( this.clearExistingDictionaryEntries = clearExistingDictionaryEntries; } - public BatchDictionaryEntries requests( + public BatchDictionaryEntriesParams requests( List requests ) { this.requests = requests; return this; } - public BatchDictionaryEntries addRequestsItem( + public BatchDictionaryEntriesParams addRequestsItem( BatchDictionaryEntriesRequest requestsItem ) { this.requests.add(requestsItem); @@ -73,13 +73,13 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - BatchDictionaryEntries batchDictionaryEntries = (BatchDictionaryEntries) o; + BatchDictionaryEntriesParams batchDictionaryEntriesParams = (BatchDictionaryEntriesParams) o; return ( Objects.equals( this.clearExistingDictionaryEntries, - batchDictionaryEntries.clearExistingDictionaryEntries + batchDictionaryEntriesParams.clearExistingDictionaryEntries ) && - Objects.equals(this.requests, batchDictionaryEntries.requests) + Objects.equals(this.requests, batchDictionaryEntriesParams.requests) ); } @@ -91,7 +91,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class BatchDictionaryEntries {\n"); + sb.append("class BatchDictionaryEntriesParams {\n"); sb .append(" clearExistingDictionaryEntries: ") .append(toIndentedString(clearExistingDictionaryEntries)) diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionarySettingsRequest.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionarySettingsParams.java similarity index 84% rename from clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionarySettingsRequest.java rename to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionarySettingsParams.java index 3e2c34a377..f4ca451420 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionarySettingsRequest.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/DictionarySettingsParams.java @@ -4,12 +4,12 @@ import java.util.Objects; /** Disable the builtin Algolia entries for a type of dictionary per language. */ -public class DictionarySettingsRequest { +public class DictionarySettingsParams { @SerializedName("disableStandardEntries") private StandardEntries disableStandardEntries; - public DictionarySettingsRequest disableStandardEntries( + public DictionarySettingsParams disableStandardEntries( StandardEntries disableStandardEntries ) { this.disableStandardEntries = disableStandardEntries; @@ -40,10 +40,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - DictionarySettingsRequest dictionarySettingsRequest = (DictionarySettingsRequest) o; + DictionarySettingsParams dictionarySettingsParams = (DictionarySettingsParams) o; return Objects.equals( this.disableStandardEntries, - dictionarySettingsRequest.disableStandardEntries + dictionarySettingsParams.disableStandardEntries ); } @@ -55,7 +55,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class DictionarySettingsRequest {\n"); + sb.append("class DictionarySettingsParams {\n"); sb .append(" disableStandardEntries: ") .append(toIndentedString(disableStandardEntries)) diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SearchDictionaryEntries.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SearchDictionaryEntriesParams.java similarity index 75% rename from clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SearchDictionaryEntries.java rename to clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SearchDictionaryEntriesParams.java index 79bb7a6fdc..29fc496bf7 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SearchDictionaryEntries.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/model/SearchDictionaryEntriesParams.java @@ -3,8 +3,8 @@ import com.google.gson.annotations.SerializedName; import java.util.Objects; -/** The `searchDictionaryEntries` request. */ -public class SearchDictionaryEntries { +/** The `searchDictionaryEntries` parameters. */ +public class SearchDictionaryEntriesParams { @SerializedName("query") private String query = ""; @@ -18,7 +18,7 @@ public class SearchDictionaryEntries { @SerializedName("language") private String language; - public SearchDictionaryEntries query(String query) { + public SearchDictionaryEntriesParams query(String query) { this.query = query; return this; } @@ -37,7 +37,7 @@ public void setQuery(String query) { this.query = query; } - public SearchDictionaryEntries page(Integer page) { + public SearchDictionaryEntriesParams page(Integer page) { this.page = page; return this; } @@ -56,7 +56,7 @@ public void setPage(Integer page) { this.page = page; } - public SearchDictionaryEntries hitsPerPage(Integer hitsPerPage) { + public SearchDictionaryEntriesParams hitsPerPage(Integer hitsPerPage) { this.hitsPerPage = hitsPerPage; return this; } @@ -75,7 +75,7 @@ public void setHitsPerPage(Integer hitsPerPage) { this.hitsPerPage = hitsPerPage; } - public SearchDictionaryEntries language(String language) { + public SearchDictionaryEntriesParams language(String language) { this.language = language; return this; } @@ -102,12 +102,15 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - SearchDictionaryEntries searchDictionaryEntries = (SearchDictionaryEntries) o; + SearchDictionaryEntriesParams searchDictionaryEntriesParams = (SearchDictionaryEntriesParams) o; return ( - Objects.equals(this.query, searchDictionaryEntries.query) && - Objects.equals(this.page, searchDictionaryEntries.page) && - Objects.equals(this.hitsPerPage, searchDictionaryEntries.hitsPerPage) && - Objects.equals(this.language, searchDictionaryEntries.language) + Objects.equals(this.query, searchDictionaryEntriesParams.query) && + Objects.equals(this.page, searchDictionaryEntriesParams.page) && + Objects.equals( + this.hitsPerPage, + searchDictionaryEntriesParams.hitsPerPage + ) && + Objects.equals(this.language, searchDictionaryEntriesParams.language) ); } @@ -119,7 +122,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class SearchDictionaryEntries {\n"); + sb.append("class SearchDictionaryEntriesParams {\n"); sb.append(" query: ").append(toIndentedString(query)).append("\n"); sb.append(" page: ").append(toIndentedString(page)).append("\n"); sb diff --git a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java index 5c6167035f..4c9f5f528b 100644 --- a/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java +++ b/clients/algoliasearch-client-java-2/algoliasearch-core/com/algolia/search/SearchApi.java @@ -676,10 +676,10 @@ public Call batchAssignUserIdsAsync( */ private Call batchDictionaryEntriesCall( String dictionaryName, - BatchDictionaryEntries batchDictionaryEntries, + BatchDictionaryEntriesParams batchDictionaryEntriesParams, final ApiCallback _callback ) throws ApiException { - Object bodyObj = batchDictionaryEntries; + Object bodyObj = batchDictionaryEntriesParams; // create path and map variables String path = @@ -706,7 +706,7 @@ private Call batchDictionaryEntriesCall( private Call batchDictionaryEntriesValidateBeforeCall( String dictionaryName, - BatchDictionaryEntries batchDictionaryEntries, + BatchDictionaryEntriesParams batchDictionaryEntriesParams, final ApiCallback _callback ) throws ApiException { // verify the required parameter 'dictionaryName' is set @@ -717,17 +717,17 @@ private Call batchDictionaryEntriesValidateBeforeCall( ); } - // verify the required parameter 'batchDictionaryEntries' is set - if (batchDictionaryEntries == null) { + // verify the required parameter 'batchDictionaryEntriesParams' is set + if (batchDictionaryEntriesParams == null) { throw new ApiException( - "Missing the required parameter 'batchDictionaryEntries' when calling" + + "Missing the required parameter 'batchDictionaryEntriesParams' when calling" + " batchDictionaryEntries(Async)" ); } return batchDictionaryEntriesCall( dictionaryName, - batchDictionaryEntries, + batchDictionaryEntriesParams, _callback ); } @@ -736,18 +736,18 @@ private Call batchDictionaryEntriesValidateBeforeCall( * Send a batch of dictionary entries. * * @param dictionaryName The dictionary to search in. (required) - * @param batchDictionaryEntries (required) + * @param batchDictionaryEntriesParams (required) * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body */ public UpdatedAtResponse batchDictionaryEntries( String dictionaryName, - BatchDictionaryEntries batchDictionaryEntries + BatchDictionaryEntriesParams batchDictionaryEntriesParams ) throws ApiException { Call req = batchDictionaryEntriesValidateBeforeCall( dictionaryName, - batchDictionaryEntries, + batchDictionaryEntriesParams, null ); if (req instanceof CallEcho) { @@ -765,19 +765,19 @@ public UpdatedAtResponse batchDictionaryEntries( * (asynchronously) Send a batch of dictionary entries. * * @param dictionaryName The dictionary to search in. (required) - * @param batchDictionaryEntries (required) + * @param batchDictionaryEntriesParams (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ public Call batchDictionaryEntriesAsync( String dictionaryName, - BatchDictionaryEntries batchDictionaryEntries, + BatchDictionaryEntriesParams batchDictionaryEntriesParams, final ApiCallback _callback ) throws ApiException { Call call = batchDictionaryEntriesValidateBeforeCall( dictionaryName, - batchDictionaryEntries, + batchDictionaryEntriesParams, _callback ); Type returnType = new TypeToken() {}.getType(); @@ -5154,10 +5154,10 @@ public Call searchAsync( */ private Call searchDictionaryEntriesCall( String dictionaryName, - SearchDictionaryEntries searchDictionaryEntries, + SearchDictionaryEntriesParams searchDictionaryEntriesParams, final ApiCallback _callback ) throws ApiException { - Object bodyObj = searchDictionaryEntries; + Object bodyObj = searchDictionaryEntriesParams; // create path and map variables String path = @@ -5184,7 +5184,7 @@ private Call searchDictionaryEntriesCall( private Call searchDictionaryEntriesValidateBeforeCall( String dictionaryName, - SearchDictionaryEntries searchDictionaryEntries, + SearchDictionaryEntriesParams searchDictionaryEntriesParams, final ApiCallback _callback ) throws ApiException { // verify the required parameter 'dictionaryName' is set @@ -5195,17 +5195,17 @@ private Call searchDictionaryEntriesValidateBeforeCall( ); } - // verify the required parameter 'searchDictionaryEntries' is set - if (searchDictionaryEntries == null) { + // verify the required parameter 'searchDictionaryEntriesParams' is set + if (searchDictionaryEntriesParams == null) { throw new ApiException( - "Missing the required parameter 'searchDictionaryEntries' when calling" + + "Missing the required parameter 'searchDictionaryEntriesParams' when calling" + " searchDictionaryEntries(Async)" ); } return searchDictionaryEntriesCall( dictionaryName, - searchDictionaryEntries, + searchDictionaryEntriesParams, _callback ); } @@ -5214,18 +5214,18 @@ private Call searchDictionaryEntriesValidateBeforeCall( * Search the dictionary entries. * * @param dictionaryName The dictionary to search in. (required) - * @param searchDictionaryEntries (required) + * @param searchDictionaryEntriesParams (required) * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body */ public UpdatedAtResponse searchDictionaryEntries( String dictionaryName, - SearchDictionaryEntries searchDictionaryEntries + SearchDictionaryEntriesParams searchDictionaryEntriesParams ) throws ApiException { Call req = searchDictionaryEntriesValidateBeforeCall( dictionaryName, - searchDictionaryEntries, + searchDictionaryEntriesParams, null ); if (req instanceof CallEcho) { @@ -5243,19 +5243,19 @@ public UpdatedAtResponse searchDictionaryEntries( * (asynchronously) Search the dictionary entries. * * @param dictionaryName The dictionary to search in. (required) - * @param searchDictionaryEntries (required) + * @param searchDictionaryEntriesParams (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ public Call searchDictionaryEntriesAsync( String dictionaryName, - SearchDictionaryEntries searchDictionaryEntries, + SearchDictionaryEntriesParams searchDictionaryEntriesParams, final ApiCallback _callback ) throws ApiException { Call call = searchDictionaryEntriesValidateBeforeCall( dictionaryName, - searchDictionaryEntries, + searchDictionaryEntriesParams, _callback ); Type returnType = new TypeToken() {}.getType(); @@ -5776,10 +5776,10 @@ public Call searchUserIdsAsync( * @throws ApiException If fail to serialize the request body object */ private Call setDictionarySettingsCall( - DictionarySettingsRequest dictionarySettingsRequest, + DictionarySettingsParams dictionarySettingsParams, final ApiCallback _callback ) throws ApiException { - Object bodyObj = dictionarySettingsRequest; + Object bodyObj = dictionarySettingsParams; // create path and map variables String path = "/1/dictionaries/*/settings"; @@ -5801,33 +5801,33 @@ private Call setDictionarySettingsCall( } private Call setDictionarySettingsValidateBeforeCall( - DictionarySettingsRequest dictionarySettingsRequest, + DictionarySettingsParams dictionarySettingsParams, final ApiCallback _callback ) throws ApiException { - // verify the required parameter 'dictionarySettingsRequest' is set - if (dictionarySettingsRequest == null) { + // verify the required parameter 'dictionarySettingsParams' is set + if (dictionarySettingsParams == null) { throw new ApiException( - "Missing the required parameter 'dictionarySettingsRequest' when calling" + + "Missing the required parameter 'dictionarySettingsParams' when calling" + " setDictionarySettings(Async)" ); } - return setDictionarySettingsCall(dictionarySettingsRequest, _callback); + return setDictionarySettingsCall(dictionarySettingsParams, _callback); } /** * Set dictionary settings. * - * @param dictionarySettingsRequest (required) + * @param dictionarySettingsParams (required) * @return UpdatedAtResponse * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the * response body */ public UpdatedAtResponse setDictionarySettings( - DictionarySettingsRequest dictionarySettingsRequest + DictionarySettingsParams dictionarySettingsParams ) throws ApiException { Call req = setDictionarySettingsValidateBeforeCall( - dictionarySettingsRequest, + dictionarySettingsParams, null ); if (req instanceof CallEcho) { @@ -5842,17 +5842,17 @@ public UpdatedAtResponse setDictionarySettings( /** * (asynchronously) Set dictionary settings. * - * @param dictionarySettingsRequest (required) + * @param dictionarySettingsParams (required) * @param _callback The callback to be executed when the API call finishes * @return The request call * @throws ApiException If fail to process the API call, e.g. serializing the request body object */ public Call setDictionarySettingsAsync( - DictionarySettingsRequest dictionarySettingsRequest, + DictionarySettingsParams dictionarySettingsParams, final ApiCallback _callback ) throws ApiException { Call call = setDictionarySettingsValidateBeforeCall( - dictionarySettingsRequest, + dictionarySettingsParams, _callback ); Type returnType = new TypeToken() {}.getType(); diff --git a/clients/algoliasearch-client-javascript/client-search/model/batchDictionaryEntries.ts b/clients/algoliasearch-client-javascript/client-search/model/batchDictionaryEntriesParams.ts similarity index 81% rename from clients/algoliasearch-client-javascript/client-search/model/batchDictionaryEntries.ts rename to clients/algoliasearch-client-javascript/client-search/model/batchDictionaryEntriesParams.ts index 30e068e7f1..03a9a91be6 100644 --- a/clients/algoliasearch-client-javascript/client-search/model/batchDictionaryEntries.ts +++ b/clients/algoliasearch-client-javascript/client-search/model/batchDictionaryEntriesParams.ts @@ -1,9 +1,9 @@ import type { BatchDictionaryEntriesRequest } from './batchDictionaryEntriesRequest'; /** - * The `batchDictionaryEntries` requests. + * The `batchDictionaryEntries` parameters. */ -export type BatchDictionaryEntries = { +export type BatchDictionaryEntriesParams = { /** * When `true`, start the batch by removing all the custom entries from the dictionary. */ diff --git a/clients/algoliasearch-client-javascript/client-search/model/dictionarySettingsRequest.ts b/clients/algoliasearch-client-javascript/client-search/model/dictionarySettingsParams.ts similarity index 81% rename from clients/algoliasearch-client-javascript/client-search/model/dictionarySettingsRequest.ts rename to clients/algoliasearch-client-javascript/client-search/model/dictionarySettingsParams.ts index bd5a55ffd8..e1a831126e 100644 --- a/clients/algoliasearch-client-javascript/client-search/model/dictionarySettingsRequest.ts +++ b/clients/algoliasearch-client-javascript/client-search/model/dictionarySettingsParams.ts @@ -3,6 +3,6 @@ import type { StandardEntries } from './standardEntries'; /** * Disable the builtin Algolia entries for a type of dictionary per language. */ -export type DictionarySettingsRequest = { +export type DictionarySettingsParams = { disableStandardEntries: StandardEntries; }; diff --git a/clients/algoliasearch-client-javascript/client-search/model/searchDictionaryEntries.ts b/clients/algoliasearch-client-javascript/client-search/model/searchDictionaryEntriesParams.ts similarity index 78% rename from clients/algoliasearch-client-javascript/client-search/model/searchDictionaryEntries.ts rename to clients/algoliasearch-client-javascript/client-search/model/searchDictionaryEntriesParams.ts index c0cae58628..4f9b7a158f 100644 --- a/clients/algoliasearch-client-javascript/client-search/model/searchDictionaryEntries.ts +++ b/clients/algoliasearch-client-javascript/client-search/model/searchDictionaryEntriesParams.ts @@ -1,7 +1,7 @@ /** - * The `searchDictionaryEntries` request. + * The `searchDictionaryEntries` parameters. */ -export type SearchDictionaryEntries = { +export type SearchDictionaryEntriesParams = { /** * The text to search in the index. */ diff --git a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts index 22e5da4b11..7eede034e7 100644 --- a/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts +++ b/clients/algoliasearch-client-javascript/client-search/src/searchApi.ts @@ -15,7 +15,7 @@ import type { AddApiKeyResponse } from '../model/addApiKeyResponse'; import type { ApiKey } from '../model/apiKey'; import type { AssignUserIdParams } from '../model/assignUserIdParams'; import type { BatchAssignUserIdsParams } from '../model/batchAssignUserIdsParams'; -import type { BatchDictionaryEntries } from '../model/batchDictionaryEntries'; +import type { BatchDictionaryEntriesParams } from '../model/batchDictionaryEntriesParams'; import type { BatchParams } from '../model/batchParams'; import type { BatchResponse } from '../model/batchResponse'; import type { BatchWriteParams } from '../model/batchWriteParams'; @@ -26,7 +26,7 @@ import type { CreatedAtResponse } from '../model/createdAtResponse'; import type { DeleteApiKeyResponse } from '../model/deleteApiKeyResponse'; import type { DeleteSourceResponse } from '../model/deleteSourceResponse'; import type { DeletedAtResponse } from '../model/deletedAtResponse'; -import type { DictionarySettingsRequest } from '../model/dictionarySettingsRequest'; +import type { DictionarySettingsParams } from '../model/dictionarySettingsParams'; import type { GetDictionarySettingsResponse } from '../model/getDictionarySettingsResponse'; import type { GetLogsResponse } from '../model/getLogsResponse'; import type { GetObjectsParams } from '../model/getObjectsParams'; @@ -49,7 +49,7 @@ import type { ReplaceSourceResponse } from '../model/replaceSourceResponse'; import type { Rule } from '../model/rule'; import type { SaveObjectResponse } from '../model/saveObjectResponse'; import type { SaveSynonymResponse } from '../model/saveSynonymResponse'; -import type { SearchDictionaryEntries } from '../model/searchDictionaryEntries'; +import type { SearchDictionaryEntriesParams } from '../model/searchDictionaryEntriesParams'; import type { SearchForFacetValuesRequest } from '../model/searchForFacetValuesRequest'; import type { SearchForFacetValuesResponse } from '../model/searchForFacetValuesResponse'; import type { SearchParams } from '../model/searchParams'; @@ -408,11 +408,11 @@ export const createSearchApi = (options: CreateClientOptions) => { * @summary Send a batch of dictionary entries. * @param batchDictionaryEntries - The batchDictionaryEntries object. * @param batchDictionaryEntries.dictionaryName - The dictionary to search in. - * @param batchDictionaryEntries.batchDictionaryEntries - The batchDictionaryEntries object. + * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object. */ function batchDictionaryEntries({ dictionaryName, - batchDictionaryEntries, + batchDictionaryEntriesParams, }: BatchDictionaryEntriesProps): Promise { const path = '/1/dictionaries/{dictionaryName}/batch'.replace( '{dictionaryName}', @@ -427,22 +427,22 @@ export const createSearchApi = (options: CreateClientOptions) => { ); } - if (!batchDictionaryEntries) { + if (!batchDictionaryEntriesParams) { throw new Error( - 'Parameter `batchDictionaryEntries` is required when calling `batchDictionaryEntries`.' + 'Parameter `batchDictionaryEntriesParams` is required when calling `batchDictionaryEntries`.' ); } - if (!batchDictionaryEntries.requests) { + if (!batchDictionaryEntriesParams.requests) { throw new Error( - 'Parameter `batchDictionaryEntries.requests` is required when calling `batchDictionaryEntries`.' + 'Parameter `batchDictionaryEntriesParams.requests` is required when calling `batchDictionaryEntries`.' ); } const request: Request = { method: 'POST', path, - data: batchDictionaryEntries, + data: batchDictionaryEntriesParams, }; return transporter.request(request, { @@ -2177,11 +2177,11 @@ export const createSearchApi = (options: CreateClientOptions) => { * @summary Search the dictionary entries. * @param searchDictionaryEntries - The searchDictionaryEntries object. * @param searchDictionaryEntries.dictionaryName - The dictionary to search in. - * @param searchDictionaryEntries.searchDictionaryEntries - The searchDictionaryEntries object. + * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object. */ function searchDictionaryEntries({ dictionaryName, - searchDictionaryEntries, + searchDictionaryEntriesParams, }: SearchDictionaryEntriesProps): Promise { const path = '/1/dictionaries/{dictionaryName}/search'.replace( '{dictionaryName}', @@ -2196,22 +2196,22 @@ export const createSearchApi = (options: CreateClientOptions) => { ); } - if (!searchDictionaryEntries) { + if (!searchDictionaryEntriesParams) { throw new Error( - 'Parameter `searchDictionaryEntries` is required when calling `searchDictionaryEntries`.' + 'Parameter `searchDictionaryEntriesParams` is required when calling `searchDictionaryEntries`.' ); } - if (!searchDictionaryEntries.query) { + if (!searchDictionaryEntriesParams.query) { throw new Error( - 'Parameter `searchDictionaryEntries.query` is required when calling `searchDictionaryEntries`.' + 'Parameter `searchDictionaryEntriesParams.query` is required when calling `searchDictionaryEntries`.' ); } const request: Request = { method: 'POST', path, - data: searchDictionaryEntries, + data: searchDictionaryEntriesParams, }; return transporter.request(request, { @@ -2421,31 +2421,31 @@ export const createSearchApi = (options: CreateClientOptions) => { * Set dictionary settings. * * @summary Set dictionary settings. - * @param dictionarySettingsRequest - The dictionarySettingsRequest object. + * @param dictionarySettingsParams - The dictionarySettingsParams object. */ function setDictionarySettings( - dictionarySettingsRequest: DictionarySettingsRequest + dictionarySettingsParams: DictionarySettingsParams ): Promise { const path = '/1/dictionaries/*/settings'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; - if (!dictionarySettingsRequest) { + if (!dictionarySettingsParams) { throw new Error( - 'Parameter `dictionarySettingsRequest` is required when calling `setDictionarySettings`.' + 'Parameter `dictionarySettingsParams` is required when calling `setDictionarySettings`.' ); } - if (!dictionarySettingsRequest.disableStandardEntries) { + if (!dictionarySettingsParams.disableStandardEntries) { throw new Error( - 'Parameter `dictionarySettingsRequest.disableStandardEntries` is required when calling `setDictionarySettings`.' + 'Parameter `dictionarySettingsParams.disableStandardEntries` is required when calling `setDictionarySettings`.' ); } const request: Request = { method: 'PUT', path, - data: dictionarySettingsRequest, + data: dictionarySettingsParams, }; return transporter.request(request, { @@ -2668,7 +2668,7 @@ export type BatchDictionaryEntriesProps = { * The dictionary to search in. */ dictionaryName: 'compounds' | 'plurals' | 'stopwords'; - batchDictionaryEntries: BatchDictionaryEntries; + batchDictionaryEntriesParams: BatchDictionaryEntriesParams; }; export type BatchRulesProps = { @@ -3027,7 +3027,7 @@ export type SearchDictionaryEntriesProps = { * The dictionary to search in. */ dictionaryName: 'compounds' | 'plurals' | 'stopwords'; - searchDictionaryEntries: SearchDictionaryEntries; + searchDictionaryEntriesParams: SearchDictionaryEntriesParams; }; export type SearchForFacetValuesProps = { diff --git a/clients/algoliasearch-client-javascript/recommend/model/getRecommendations.ts b/clients/algoliasearch-client-javascript/recommend/model/getRecommendationsParams.ts similarity index 67% rename from clients/algoliasearch-client-javascript/recommend/model/getRecommendations.ts rename to clients/algoliasearch-client-javascript/recommend/model/getRecommendationsParams.ts index fd0545253f..4eb8d5fb8d 100644 --- a/clients/algoliasearch-client-javascript/recommend/model/getRecommendations.ts +++ b/clients/algoliasearch-client-javascript/recommend/model/getRecommendationsParams.ts @@ -1,9 +1,9 @@ import type { RecommendationRequest } from './recommendationRequest'; /** - * The `getRecommendations` requests. + * The `getRecommendations` parameters. */ -export type GetRecommendations = { +export type GetRecommendationsParams = { /** * The `getRecommendations` requests. */ diff --git a/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts b/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts index 8812c59837..f0359bd32b 100644 --- a/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts +++ b/clients/algoliasearch-client-javascript/recommend/src/recommendApi.ts @@ -11,7 +11,7 @@ import type { Request, } from '@algolia/client-common'; -import type { GetRecommendations } from '../model/getRecommendations'; +import type { GetRecommendationsParams } from '../model/getRecommendationsParams'; import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse'; export const version = '5.0.0'; @@ -72,31 +72,31 @@ export const createRecommendApi = (options: CreateClientOptions) => { * Returns recommendations for a specific model and objectID. * * @summary Returns recommendations for a specific model and objectID. - * @param getRecommendations - The getRecommendations object. + * @param getRecommendationsParams - The getRecommendationsParams object. */ function getRecommendations( - getRecommendations: GetRecommendations + getRecommendationsParams: GetRecommendationsParams ): Promise { const path = '/1/indexes/*/recommendations'; const headers: Headers = { Accept: 'application/json' }; const queryParameters: Record = {}; - if (!getRecommendations) { + if (!getRecommendationsParams) { throw new Error( - 'Parameter `getRecommendations` is required when calling `getRecommendations`.' + 'Parameter `getRecommendationsParams` is required when calling `getRecommendations`.' ); } - if (!getRecommendations.requests) { + if (!getRecommendationsParams.requests) { throw new Error( - 'Parameter `getRecommendations.requests` is required when calling `getRecommendations`.' + 'Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.' ); } const request: Request = { method: 'POST', path, - data: getRecommendations, + data: getRecommendationsParams, }; return transporter.request(request, { diff --git a/clients/algoliasearch-client-php/lib/Api/RecommendApi.php b/clients/algoliasearch-client-php/lib/Api/RecommendApi.php index a23c1a4d25..8d595cfed1 100644 --- a/clients/algoliasearch-client-php/lib/Api/RecommendApi.php +++ b/clients/algoliasearch-client-php/lib/Api/RecommendApi.php @@ -90,19 +90,19 @@ public function getClientConfig() * * Returns recommendations for a specific model and objectID. * - * @param \Algolia\AlgoliaSearch\Model\Recommend\GetRecommendations $getRecommendations getRecommendations (required) + * @param \Algolia\AlgoliaSearch\Model\Recommend\GetRecommendationsParams $getRecommendationsParams getRecommendationsParams (required) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return \Algolia\AlgoliaSearch\Model\Recommend\GetRecommendationsResponse|\Algolia\AlgoliaSearch\Model\Recommend\ErrorBase|\Algolia\AlgoliaSearch\Model\Recommend\ErrorBase|\Algolia\AlgoliaSearch\Model\Recommend\ErrorBase|\Algolia\AlgoliaSearch\Model\Recommend\ErrorBase */ - public function getRecommendations($getRecommendations) + public function getRecommendations($getRecommendationsParams) { - // verify the required parameter 'getRecommendations' is set - if ($getRecommendations === null || (is_array($getRecommendations) && count($getRecommendations) === 0)) { + // verify the required parameter 'getRecommendationsParams' is set + if ($getRecommendationsParams === null || (is_array($getRecommendationsParams) && count($getRecommendationsParams) === 0)) { throw new \InvalidArgumentException( - 'Missing the required parameter $getRecommendations when calling getRecommendations' + 'Missing the required parameter $getRecommendationsParams when calling getRecommendations' ); } @@ -114,8 +114,8 @@ public function getRecommendations($getRecommendations) $headers = []; $headers['Accept'] = 'application/json'; $headers['Content-Type'] = 'application/json'; - if (isset($getRecommendations)) { - $httpBody = $getRecommendations; + if (isset($getRecommendationsParams)) { + $httpBody = $getRecommendationsParams; } $defaultHeaders = []; diff --git a/clients/algoliasearch-client-php/lib/Api/SearchApi.php b/clients/algoliasearch-client-php/lib/Api/SearchApi.php index a35526eb4d..26c4526328 100644 --- a/clients/algoliasearch-client-php/lib/Api/SearchApi.php +++ b/clients/algoliasearch-client-php/lib/Api/SearchApi.php @@ -468,14 +468,14 @@ public function batchAssignUserIds($xAlgoliaUserID, $batchAssignUserIdsParams) * Send a batch of dictionary entries. * * @param string $dictionaryName The dictionary to search in. (required) - * @param \Algolia\AlgoliaSearch\Model\Search\BatchDictionaryEntries $batchDictionaryEntries batchDictionaryEntries (required) + * @param \Algolia\AlgoliaSearch\Model\Search\BatchDictionaryEntriesParams $batchDictionaryEntriesParams batchDictionaryEntriesParams (required) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return \Algolia\AlgoliaSearch\Model\Search\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase */ - public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) + public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntriesParams) { // verify the required parameter 'dictionaryName' is set if ($dictionaryName === null || (is_array($dictionaryName) && count($dictionaryName) === 0)) { @@ -483,10 +483,10 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) 'Missing the required parameter $dictionaryName when calling batchDictionaryEntries' ); } - // verify the required parameter 'batchDictionaryEntries' is set - if ($batchDictionaryEntries === null || (is_array($batchDictionaryEntries) && count($batchDictionaryEntries) === 0)) { + // verify the required parameter 'batchDictionaryEntriesParams' is set + if ($batchDictionaryEntriesParams === null || (is_array($batchDictionaryEntriesParams) && count($batchDictionaryEntriesParams) === 0)) { throw new \InvalidArgumentException( - 'Missing the required parameter $batchDictionaryEntries when calling batchDictionaryEntries' + 'Missing the required parameter $batchDictionaryEntriesParams when calling batchDictionaryEntries' ); } @@ -506,8 +506,8 @@ public function batchDictionaryEntries($dictionaryName, $batchDictionaryEntries) $headers = []; $headers['Accept'] = 'application/json'; $headers['Content-Type'] = 'application/json'; - if (isset($batchDictionaryEntries)) { - $httpBody = $batchDictionaryEntries; + if (isset($batchDictionaryEntriesParams)) { + $httpBody = $batchDictionaryEntriesParams; } $defaultHeaders = []; @@ -3051,14 +3051,14 @@ public function search($indexName, $searchParams) * Search the dictionary entries. * * @param string $dictionaryName The dictionary to search in. (required) - * @param \Algolia\AlgoliaSearch\Model\Search\SearchDictionaryEntries $searchDictionaryEntries searchDictionaryEntries (required) + * @param \Algolia\AlgoliaSearch\Model\Search\SearchDictionaryEntriesParams $searchDictionaryEntriesParams searchDictionaryEntriesParams (required) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return \Algolia\AlgoliaSearch\Model\Search\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase */ - public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntries) + public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntriesParams) { // verify the required parameter 'dictionaryName' is set if ($dictionaryName === null || (is_array($dictionaryName) && count($dictionaryName) === 0)) { @@ -3066,10 +3066,10 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie 'Missing the required parameter $dictionaryName when calling searchDictionaryEntries' ); } - // verify the required parameter 'searchDictionaryEntries' is set - if ($searchDictionaryEntries === null || (is_array($searchDictionaryEntries) && count($searchDictionaryEntries) === 0)) { + // verify the required parameter 'searchDictionaryEntriesParams' is set + if ($searchDictionaryEntriesParams === null || (is_array($searchDictionaryEntriesParams) && count($searchDictionaryEntriesParams) === 0)) { throw new \InvalidArgumentException( - 'Missing the required parameter $searchDictionaryEntries when calling searchDictionaryEntries' + 'Missing the required parameter $searchDictionaryEntriesParams when calling searchDictionaryEntries' ); } @@ -3089,8 +3089,8 @@ public function searchDictionaryEntries($dictionaryName, $searchDictionaryEntrie $headers = []; $headers['Accept'] = 'application/json'; $headers['Content-Type'] = 'application/json'; - if (isset($searchDictionaryEntries)) { - $httpBody = $searchDictionaryEntries; + if (isset($searchDictionaryEntriesParams)) { + $httpBody = $searchDictionaryEntriesParams; } $defaultHeaders = []; @@ -3393,19 +3393,19 @@ public function searchUserIds($searchUserIdsParams) * * Set dictionary settings. * - * @param \Algolia\AlgoliaSearch\Model\Search\DictionarySettingsRequest $dictionarySettingsRequest dictionarySettingsRequest (required) + * @param \Algolia\AlgoliaSearch\Model\Search\DictionarySettingsParams $dictionarySettingsParams dictionarySettingsParams (required) * * @throws \Algolia\AlgoliaSearch\ApiException on non-2xx response * @throws \InvalidArgumentException * * @return \Algolia\AlgoliaSearch\Model\Search\UpdatedAtResponse|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase|\Algolia\AlgoliaSearch\Model\Search\ErrorBase */ - public function setDictionarySettings($dictionarySettingsRequest) + public function setDictionarySettings($dictionarySettingsParams) { - // verify the required parameter 'dictionarySettingsRequest' is set - if ($dictionarySettingsRequest === null || (is_array($dictionarySettingsRequest) && count($dictionarySettingsRequest) === 0)) { + // verify the required parameter 'dictionarySettingsParams' is set + if ($dictionarySettingsParams === null || (is_array($dictionarySettingsParams) && count($dictionarySettingsParams) === 0)) { throw new \InvalidArgumentException( - 'Missing the required parameter $dictionarySettingsRequest when calling setDictionarySettings' + 'Missing the required parameter $dictionarySettingsParams when calling setDictionarySettings' ); } @@ -3417,8 +3417,8 @@ public function setDictionarySettings($dictionarySettingsRequest) $headers = []; $headers['Accept'] = 'application/json'; $headers['Content-Type'] = 'application/json'; - if (isset($dictionarySettingsRequest)) { - $httpBody = $dictionarySettingsRequest; + if (isset($dictionarySettingsParams)) { + $httpBody = $dictionarySettingsParams; } $defaultHeaders = []; diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/GetRecommendations.php b/clients/algoliasearch-client-php/lib/Model/Recommend/GetRecommendationsParams.php similarity index 95% rename from clients/algoliasearch-client-php/lib/Model/Recommend/GetRecommendations.php rename to clients/algoliasearch-client-php/lib/Model/Recommend/GetRecommendationsParams.php index 9fe2ebcdac..139cfc70c3 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/GetRecommendations.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/GetRecommendationsParams.php @@ -6,17 +6,17 @@ use \ArrayAccess; /** - * GetRecommendations Class Doc Comment + * GetRecommendationsParams Class Doc Comment * * @category Class - * @description The `getRecommendations` requests. + * @description The `getRecommendations` parameters. * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null * @template TValue mixed|null */ -class GetRecommendations implements ModelInterface, ArrayAccess, \JsonSerializable +class GetRecommendationsParams implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; @@ -25,7 +25,7 @@ class GetRecommendations implements ModelInterface, ArrayAccess, \JsonSerializab * * @var string */ - protected static $openAPIModelName = 'getRecommendations'; + protected static $openAPIModelName = 'getRecommendationsParams'; /** * Array of property to type mappings. Used for (de)serialization diff --git a/clients/algoliasearch-client-php/lib/Model/Search/BatchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/Search/BatchDictionaryEntriesParams.php similarity index 97% rename from clients/algoliasearch-client-php/lib/Model/Search/BatchDictionaryEntries.php rename to clients/algoliasearch-client-php/lib/Model/Search/BatchDictionaryEntriesParams.php index 152b06608f..8f0deea41c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/BatchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/BatchDictionaryEntriesParams.php @@ -6,17 +6,17 @@ use \ArrayAccess; /** - * BatchDictionaryEntries Class Doc Comment + * BatchDictionaryEntriesParams Class Doc Comment * * @category Class - * @description The `batchDictionaryEntries` requests. + * @description The `batchDictionaryEntries` parameters. * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null * @template TValue mixed|null */ -class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerializable +class BatchDictionaryEntriesParams implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; @@ -25,7 +25,7 @@ class BatchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerial * * @var string */ - protected static $openAPIModelName = 'batchDictionaryEntries'; + protected static $openAPIModelName = 'batchDictionaryEntriesParams'; /** * Array of property to type mappings. Used for (de)serialization diff --git a/clients/algoliasearch-client-php/lib/Model/Search/DictionarySettingsRequest.php b/clients/algoliasearch-client-php/lib/Model/Search/DictionarySettingsParams.php similarity index 97% rename from clients/algoliasearch-client-php/lib/Model/Search/DictionarySettingsRequest.php rename to clients/algoliasearch-client-php/lib/Model/Search/DictionarySettingsParams.php index a3f4436e69..befe68d329 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/DictionarySettingsRequest.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/DictionarySettingsParams.php @@ -6,7 +6,7 @@ use \ArrayAccess; /** - * DictionarySettingsRequest Class Doc Comment + * DictionarySettingsParams Class Doc Comment * * @category Class * @description Disable the builtin Algolia entries for a type of dictionary per language. @@ -16,7 +16,7 @@ * @template TKey int|null * @template TValue mixed|null */ -class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSerializable +class DictionarySettingsParams implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; @@ -25,7 +25,7 @@ class DictionarySettingsRequest implements ModelInterface, ArrayAccess, \JsonSer * * @var string */ - protected static $openAPIModelName = 'dictionarySettingsRequest'; + protected static $openAPIModelName = 'dictionarySettingsParams'; /** * Array of property to type mappings. Used for (de)serialization diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntries.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesParams.php similarity index 97% rename from clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntries.php rename to clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesParams.php index 40d507a253..7f7f15ad01 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntries.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchDictionaryEntriesParams.php @@ -6,17 +6,17 @@ use \ArrayAccess; /** - * SearchDictionaryEntries Class Doc Comment + * SearchDictionaryEntriesParams Class Doc Comment * * @category Class - * @description The `searchDictionaryEntries` request. + * @description The `searchDictionaryEntries` parameters. * * @package Algolia\AlgoliaSearch * @implements \ArrayAccess * @template TKey int|null * @template TValue mixed|null */ -class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSerializable +class SearchDictionaryEntriesParams implements ModelInterface, ArrayAccess, \JsonSerializable { public const DISCRIMINATOR = null; @@ -25,7 +25,7 @@ class SearchDictionaryEntries implements ModelInterface, ArrayAccess, \JsonSeria * * @var string */ - protected static $openAPIModelName = 'searchDictionaryEntries'; + protected static $openAPIModelName = 'searchDictionaryEntriesParams'; /** * Array of property to type mappings. Used for (de)serialization diff --git a/specs/recommend/paths/getRecommendations.yml b/specs/recommend/paths/getRecommendations.yml index 73082900d4..6f810feaac 100644 --- a/specs/recommend/paths/getRecommendations.yml +++ b/specs/recommend/paths/getRecommendations.yml @@ -9,8 +9,8 @@ post: content: application/json: schema: - title: getRecommendations - description: The `getRecommendations` requests. + title: getRecommendationsParams + description: The `getRecommendations` parameters. type: object additionalProperties: false properties: diff --git a/specs/search/paths/dictionaries/batchDictionaryEntries.yml b/specs/search/paths/dictionaries/batchDictionaryEntries.yml index d67a3d7070..3ee9c20c37 100644 --- a/specs/search/paths/dictionaries/batchDictionaryEntries.yml +++ b/specs/search/paths/dictionaries/batchDictionaryEntries.yml @@ -11,8 +11,8 @@ post: content: application/json: schema: - title: batchDictionaryEntries - description: The `batchDictionaryEntries` requests. + title: batchDictionaryEntriesParams + description: The `batchDictionaryEntries` parameters. type: object required: - requests diff --git a/specs/search/paths/dictionaries/dictionarySettings.yml b/specs/search/paths/dictionaries/dictionarySettings.yml index 60dcd1ea0b..de0c124785 100644 --- a/specs/search/paths/dictionaries/dictionarySettings.yml +++ b/specs/search/paths/dictionaries/dictionarySettings.yml @@ -9,7 +9,7 @@ put: content: application/json: schema: - title: dictionarySettingsRequest + title: dictionarySettingsParams type: object additionalProperties: false description: Disable the builtin Algolia entries for a type of dictionary per language. diff --git a/specs/search/paths/dictionaries/searchDictionaryEntries.yml b/specs/search/paths/dictionaries/searchDictionaryEntries.yml index b3aa1eee35..3f18189041 100644 --- a/specs/search/paths/dictionaries/searchDictionaryEntries.yml +++ b/specs/search/paths/dictionaries/searchDictionaryEntries.yml @@ -11,8 +11,8 @@ post: content: application/json: schema: - title: searchDictionaryEntries - description: The `searchDictionaryEntries` request. + title: searchDictionaryEntriesParams + description: The `searchDictionaryEntries` parameters. type: object required: - query diff --git a/tests/CTS/methods/requests/search/batchDictionaryEntries.json b/tests/CTS/methods/requests/search/batchDictionaryEntries.json index 689ae8a59c..5515dc414d 100644 --- a/tests/CTS/methods/requests/search/batchDictionaryEntries.json +++ b/tests/CTS/methods/requests/search/batchDictionaryEntries.json @@ -4,7 +4,7 @@ "testName": "get batchDictionaryEntries results with minimal parameters", "parameters": { "dictionaryName": "compounds", - "batchDictionaryEntries": { + "batchDictionaryEntriesParams": { "requests": [ { "action": "addEntry", @@ -51,7 +51,7 @@ "testName": "get batchDictionaryEntries results with all parameters", "parameters": { "dictionaryName": "compounds", - "batchDictionaryEntries": { + "batchDictionaryEntriesParams": { "clearExistingDictionaryEntries": false, "requests": [ { diff --git a/tests/CTS/methods/requests/search/searchDictionaryEntries.json b/tests/CTS/methods/requests/search/searchDictionaryEntries.json index 4a93335ce6..ed44e1b463 100644 --- a/tests/CTS/methods/requests/search/searchDictionaryEntries.json +++ b/tests/CTS/methods/requests/search/searchDictionaryEntries.json @@ -4,7 +4,7 @@ "testName": "get searchDictionaryEntries results with minimal parameters", "parameters": { "dictionaryName": "compounds", - "searchDictionaryEntries": { + "searchDictionaryEntriesParams": { "query": "foo" } }, @@ -21,7 +21,7 @@ "testName": "get searchDictionaryEntries results with all parameters", "parameters": { "dictionaryName": "compounds", - "searchDictionaryEntries": { + "searchDictionaryEntriesParams": { "query": "foo", "page": 4, "hitsPerPage": 2, diff --git a/tests/output/javascript/tests/methods/requests/search.test.ts b/tests/output/javascript/tests/methods/requests/search.test.ts index f8e8121ac2..189263c4dc 100644 --- a/tests/output/javascript/tests/methods/requests/search.test.ts +++ b/tests/output/javascript/tests/methods/requests/search.test.ts @@ -130,7 +130,7 @@ describe('batchDictionaryEntries', () => { test('get batchDictionaryEntries results with minimal parameters', async () => { const req = (await client.batchDictionaryEntries({ dictionaryName: 'compounds', - batchDictionaryEntries: { + batchDictionaryEntriesParams: { requests: [ { action: 'addEntry', body: { objectID: '1', language: 'en' } }, { action: 'deleteEntry', body: { objectID: '2', language: 'fr' } }, @@ -152,7 +152,7 @@ describe('batchDictionaryEntries', () => { test('get batchDictionaryEntries results with all parameters', async () => { const req = (await client.batchDictionaryEntries({ dictionaryName: 'compounds', - batchDictionaryEntries: { + batchDictionaryEntriesParams: { clearExistingDictionaryEntries: false, requests: [ { @@ -938,7 +938,7 @@ describe('searchDictionaryEntries', () => { test('get searchDictionaryEntries results with minimal parameters', async () => { const req = (await client.searchDictionaryEntries({ dictionaryName: 'compounds', - searchDictionaryEntries: { query: 'foo' }, + searchDictionaryEntriesParams: { query: 'foo' }, })) as unknown as EchoResponse; expect(req.path).toEqual('/1/dictionaries/compounds/search'); @@ -950,7 +950,7 @@ describe('searchDictionaryEntries', () => { test('get searchDictionaryEntries results with all parameters', async () => { const req = (await client.searchDictionaryEntries({ dictionaryName: 'compounds', - searchDictionaryEntries: { + searchDictionaryEntriesParams: { query: 'foo', page: 4, hitsPerPage: 2,