ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-02-20 09:26:45 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[Search] Search aggregator return type

Browse Source 
The search service returns objects containing
searchResult objects.
This commit is contained in:
slhale 2015-08-04 11:39:09 -07:00
parent bbce5c3154
commit 56265c2277
3 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
platform/persistence/elastic/src/ElasticsearchSearchProvider.js
View File

@ -183,7 +183,7 @@ define(
* promise for a result object that has the format
* {hits: searchResult[], total: number, timedOut: boolean}
* where a searchResult has the format
* {id: domainObject ID, object: domainObject, score: number}
* {id: string, object: domainObject, score: number}
*
* Notes:
* * The order of the results is from highest to lowest score,

2
platform/search/src/GenericSearchProvider.js
View File

@ -201,7 +201,7 @@ define(
* Returns a promise for a result object that has the format
* {hits: searchResult[], total: number, timedOut: boolean}
* where a searchResult has the format
* {id: domainObject ID, object: domainObject, score: number}
* {id: string, object: domainObject, score: number}
*
* Notes:
* * The order of the results is not guarenteed.

4
platform/search/src/SearchAggregator.js
View File

@ -128,7 +128,9 @@ define(
/**
* Sends a query to each of the providers. Returns a promise for
* a result object that has the format
* {hits: domainObject[], total: number}
* {hits: searchResult[], total: number, timedOut: boolean}
* where a searchResult has the format
* {id: string, object: domainObject, score: number}
*
* @param inputText The text input that is the query.
* @param maxResults (optional) The maximum number of results