diff --git a/src/Coscine.Api.Search/api.ts b/src/Coscine.Api.Search/api.ts index 31fa7ac349ae2e7ebfc1448cf79bc46a2de0cb3b..2023850c3882d952d811b11222aba8fa2adb0046 100644 --- a/src/Coscine.Api.Search/api.ts +++ b/src/Coscine.Api.Search/api.ts @@ -58,19 +58,6 @@ export enum ItemType { Resource = 'Resource' } -/** - * Search result return object - * @export - * @interface SearchResult - */ -export interface SearchResult { - /** - * Search result files - * @type {Array<ItemSearchResult>} - * @memberof SearchResult - */ - items?: Array<ItemSearchResult> | null; -} /** * SearchApi - axios parameter creator @@ -81,14 +68,16 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio /** * * @summary Search Elasticsearch - * @param {string} [query] Elasticsearch query - * @param {boolean} [user] Specify user or only public metadata records could be found - * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [languages] Set the used languages + * @param {string} [searchQuery] The actual search query + * @param {boolean} [includeUsers] Specify user or only public metadata records could be found + * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax + * @param {Array<string>} [includedLanguages] Set the used languages + * @param {number} [pageNumber] The requested page number + * @param {number} [pageSize] The size of a page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchSearch: async (query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options: any = {}): Promise<RequestArgs> => { + searchSearch: async (searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options: any = {}): Promise<RequestArgs> => { const localVarPath = `/Search`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -104,20 +93,28 @@ export const SearchApiAxiosParamCreator = function (configuration?: Configuratio // authentication JWT token required await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration) - if (query !== undefined) { - localVarQueryParameter['query'] = query; + if (searchQuery !== undefined) { + localVarQueryParameter['SearchQuery'] = searchQuery; + } + + if (includeUsers !== undefined) { + localVarQueryParameter['IncludeUsers'] = includeUsers; + } + + if (useAdvancedSyntax !== undefined) { + localVarQueryParameter['UseAdvancedSyntax'] = useAdvancedSyntax; } - if (user !== undefined) { - localVarQueryParameter['user'] = user; + if (includedLanguages) { + localVarQueryParameter['IncludedLanguages'] = includedLanguages; } - if (adv !== undefined) { - localVarQueryParameter['adv'] = adv; + if (pageNumber !== undefined) { + localVarQueryParameter['PageNumber'] = pageNumber; } - if (languages) { - localVarQueryParameter['languages'] = languages; + if (pageSize !== undefined) { + localVarQueryParameter['PageSize'] = pageSize; } @@ -144,15 +141,17 @@ export const SearchApiFp = function(configuration?: Configuration) { /** * * @summary Search Elasticsearch - * @param {string} [query] Elasticsearch query - * @param {boolean} [user] Specify user or only public metadata records could be found - * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [languages] Set the used languages + * @param {string} [searchQuery] The actual search query + * @param {boolean} [includeUsers] Specify user or only public metadata records could be found + * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax + * @param {Array<string>} [includedLanguages] Set the used languages + * @param {number} [pageNumber] The requested page number + * @param {number} [pageSize] The size of a page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchResult>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchSearch(query, user, adv, languages, options); + async searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ItemSearchResult>>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, } @@ -168,15 +167,17 @@ export const SearchApiFactory = function (configuration?: Configuration, basePat /** * * @summary Search Elasticsearch - * @param {string} [query] Elasticsearch query - * @param {boolean} [user] Specify user or only public metadata records could be found - * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [languages] Set the used languages + * @param {string} [searchQuery] The actual search query + * @param {boolean} [includeUsers] Specify user or only public metadata records could be found + * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax + * @param {Array<string>} [includedLanguages] Set the used languages + * @param {number} [pageNumber] The requested page number + * @param {number} [pageSize] The size of a page * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any): AxiosPromise<SearchResult> { - return localVarFp.searchSearch(query, user, adv, languages, options).then((request) => request(axios, basePath)); + searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any): AxiosPromise<Array<ItemSearchResult>> { + return localVarFp.searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options).then((request) => request(axios, basePath)); }, }; }; @@ -191,16 +192,18 @@ export class SearchApi extends BaseAPI { /** * * @summary Search Elasticsearch - * @param {string} [query] Elasticsearch query - * @param {boolean} [user] Specify user or only public metadata records could be found - * @param {boolean} [adv] Set true for advanced Elasticsearch search syntax - * @param {Array<string>} [languages] Set the used languages + * @param {string} [searchQuery] The actual search query + * @param {boolean} [includeUsers] Specify user or only public metadata records could be found + * @param {boolean} [useAdvancedSyntax] Set true for advanced Elasticsearch search syntax + * @param {Array<string>} [includedLanguages] Set the used languages + * @param {number} [pageNumber] The requested page number + * @param {number} [pageSize] The size of a page * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SearchApi */ - public searchSearch(query?: string, user?: boolean, adv?: boolean, languages?: Array<string>, options?: any) { - return SearchApiFp(this.configuration).searchSearch(query, user, adv, languages, options).then((request) => request(this.axios, this.basePath)); + public searchSearch(searchQuery?: string, includeUsers?: boolean, useAdvancedSyntax?: boolean, includedLanguages?: Array<string>, pageNumber?: number, pageSize?: number, options?: any) { + return SearchApiFp(this.configuration).searchSearch(searchQuery, includeUsers, useAdvancedSyntax, includedLanguages, pageNumber, pageSize, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/Coscine.Api.Search/base.ts b/src/Coscine.Api.Search/base.ts index da26fb6a48dd734f7482b1ac228f9204d01b41da..b570612a0faff495206301306c44314cc6e7bd4f 100644 --- a/src/Coscine.Api.Search/base.ts +++ b/src/Coscine.Api.Search/base.ts @@ -18,7 +18,7 @@ import { Configuration } from "./configuration"; // @ts-ignore import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; -export const BASE_PATH = "https://d-sp16.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Search".replace(/\/+$/, ""); +export const BASE_PATH = "https://d-sp12.devlef.campus.rwth-aachen.de/coscine/api/Coscine.Api.Search".replace(/\/+$/, ""); /** *