[Search] Search aggregator return type

The search service returns objects containing
searchResult objects.
This commit is contained in:
slhale 2015-08-04 13:07:47 -07:00
parent 077a0ce3e3
commit 15e39e00c2
3 changed files with 5 additions and 3 deletions

View File

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

View File

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

View File

@ -128,7 +128,9 @@ define(
/** /**
* Sends a query to each of the providers. Returns a promise for * Sends a query to each of the providers. Returns a promise for
* a result object that has the format * 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 inputText The text input that is the query.
* @param maxResults (optional) The maximum number of results * @param maxResults (optional) The maximum number of results