3abb79a179
* Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Create new rule HTTP APIs (#93980) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Move current alert HTTP APIs to legacy folder (#93943) * Move current HTTP APIs to legacy folder * Rename BASE_ALERT_API_PATH to LEGACY_BASE_ALERT_API_PATH * Fix failing tests and extra files * Add necessary files * Create rule route * Get rule API * Update rule API * Delete rule route * Aggregate rules API * Disable rule API * Enable rule API * Find rules API * Fix Update API * Get rule alert summary API * Get rule state API * Health API * Rule types API * Mute all API * Mute alert API * Unmute all API * Unmute alert route * Update API key API * corrected tpye by making it much more complicated * removed unneeded cocde * Fixes * Add back health route * mutedInstanceIds -> mutedAlertIds * lastRun -> last_run * alert_type_state -> rule_type_state & alert_instances -> alerts Co-authored-by: Gidi Meir Morris <github@gidi.io> * Create docs for new rule HTTP APIs, deprecate old docs (#94745) * Create docs for new APIs, deprecate old docs * Remove connector_type_id * Update docs * Add link to legacy APIs from rules API docs * Remove connector_type_id references * [DOCS] Add legacy APIs to index.asciidoc * Fix camel case Co-authored-by: lcawl <lcawley@elastic.co> * Make alerting tests use new rules APIs (#95159) * Make API integration tests use new HTTP APIs * Fix end to end tests * Fix test failures * Fix more test failures * Rename some files * Add tests for legacy APIs (#95333) * Initial commit (#95457) * Move some new alerting APIs to /internal (#95461) * Initial commit * Update README.md * Use internal API * Merge deprecated warning w/ alternative solution * Update API docs Co-authored-by: Gidi Meir Morris <github@gidi.io> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: lcawl <lcawley@elastic.co>
1308 lines
45 KiB
JSON
1308 lines
45 KiB
JSON
{
|
|
"id": "globalSearch",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.GlobalSearchBatchedResults",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchBatchedResults",
|
|
"description": [
|
|
"\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchBatchedResults.results",
|
|
"type": "Array",
|
|
"label": "results",
|
|
"description": [
|
|
"\nResults for this batch"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 89
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchResult",
|
|
"text": "GlobalSearchResult"
|
|
},
|
|
"[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchFindOptions",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchFindOptions",
|
|
"description": [
|
|
"\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchFindOptions.preference",
|
|
"type": "string",
|
|
"label": "preference",
|
|
"description": [
|
|
"\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster.\n\nIf not specified, a random token will be generated and used. The token is stored in the sessionStorage and is guaranteed\nto be consistent during a given http 'session'"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/services/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchFindOptions.aborted$",
|
|
"type": "Object",
|
|
"label": "aborted$",
|
|
"description": [
|
|
"\nOptional observable to notify that the associated `find` call should be canceled.\nIf/when provided and emitting, the result observable will be completed and no further result emission will be performed."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/services/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"Observable",
|
|
"<void> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/services/types.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchFindParams",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchFindParams",
|
|
"description": [
|
|
"\nSearch parameters for the {@link GlobalSearchPluginStart.find | `find` API}\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchFindParams.term",
|
|
"type": "string",
|
|
"label": "term",
|
|
"description": [
|
|
"\nThe term to search for. Can be undefined if searching by filters."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 101
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchFindParams.types",
|
|
"type": "Array",
|
|
"label": "types",
|
|
"description": [
|
|
"\nThe types of results to search for."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 105
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchFindParams.tags",
|
|
"type": "Array",
|
|
"label": "tags",
|
|
"description": [
|
|
"\nThe tag ids to filter search by."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 109
|
|
},
|
|
"signature": [
|
|
"string[] | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 97
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchProviderFindOptions",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchProviderFindOptions",
|
|
"description": [
|
|
"\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method."
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderFindOptions.preference",
|
|
"type": "string",
|
|
"label": "preference",
|
|
"description": [
|
|
"\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 20
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderFindOptions.aborted$",
|
|
"type": "Object",
|
|
"label": "aborted$",
|
|
"description": [
|
|
"\nObservable that emits once if and when the `find` call has been aborted, either manually by the consumer,\nor when the internal timeout period as been reached.\n\nWhen a `find` request is effectively aborted, the service will stop emitting any new result to the consumer anyway, but\nthis can (and should) be used to cancel any pending asynchronous task and complete the result observable from within the provider."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"Observable",
|
|
"<void>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderFindOptions.maxResults",
|
|
"type": "number",
|
|
"label": "maxResults",
|
|
"description": [
|
|
"\nThe total maximum number of results (including all batches, not per emission) that should be returned by the provider for a given `find` request.\nAny result emitted exceeding this quota will be ignored by the service and not emitted to the consumer."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 33
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchProviderResult",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchProviderResult",
|
|
"description": [
|
|
"\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"an id that should be unique for an individual provider's results"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 46
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [
|
|
"the title/label of the result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 48
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [
|
|
"the type of result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 50
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.icon",
|
|
"type": "string",
|
|
"label": "icon",
|
|
"description": [
|
|
"an optional EUI icon name to associate with the search result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.url",
|
|
"type": "CompoundType",
|
|
"label": "url",
|
|
"description": [
|
|
"\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderResultUrl",
|
|
"text": "GlobalSearchProviderResultUrl"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.score",
|
|
"type": "number",
|
|
"label": "score",
|
|
"description": [
|
|
"the score of the result, from 1 (lowest) to 100 (highest)"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 64
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchProviderResult.meta",
|
|
"type": "Object",
|
|
"label": "meta",
|
|
"description": [
|
|
"an optional record of metadata for this result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.Serializable",
|
|
"text": "Serializable"
|
|
},
|
|
"> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchResultProvider",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchResultProvider",
|
|
"description": [
|
|
"\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchResultProvider.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"\nid of the provider"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 26
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchResultProvider.find",
|
|
"type": "Function",
|
|
"label": "find",
|
|
"signature": [
|
|
"(search: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchFindParams",
|
|
"text": "GlobalSearchFindParams"
|
|
},
|
|
", options: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderFindOptions",
|
|
"text": "GlobalSearchProviderFindOptions"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderResult",
|
|
"text": "GlobalSearchProviderResult"
|
|
},
|
|
"[]>"
|
|
],
|
|
"description": [
|
|
"\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "search",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchFindParams",
|
|
"text": "GlobalSearchFindParams"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 45
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderFindOptions",
|
|
"text": "GlobalSearchProviderFindOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 46
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 44
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.GlobalSearchResultProvider.getSearchableTypes",
|
|
"type": "Function",
|
|
"label": "getSearchableTypes",
|
|
"description": [
|
|
"\nMethod that should return all the possible {@link GlobalSearchProviderResult.type | type} of results that\nthis provider can return."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 53
|
|
},
|
|
"signature": [
|
|
"() => string[] | Promise<string[]>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 22
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-public.GlobalSearchProviderFindParams",
|
|
"type": "Type",
|
|
"label": "GlobalSearchProviderFindParams",
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 115
|
|
},
|
|
"signature": [
|
|
"GlobalSearchFindParams"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchProviderResultUrl",
|
|
"type": "Type",
|
|
"label": "GlobalSearchProviderResultUrl",
|
|
"tags": [],
|
|
"description": [
|
|
"\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"signature": [
|
|
"string | { path: string; prependBasePath: boolean; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.GlobalSearchResult",
|
|
"type": "Type",
|
|
"label": "GlobalSearchResult",
|
|
"tags": [],
|
|
"description": [
|
|
"\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"signature": [
|
|
"Pick<GlobalSearchProviderResult, \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.GlobalSearchPluginSetup",
|
|
"type": "Type",
|
|
"label": "GlobalSearchPluginSetup",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 16
|
|
},
|
|
"signature": [
|
|
"{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }"
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.GlobalSearchPluginStart",
|
|
"type": "Type",
|
|
"label": "GlobalSearchPluginStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/public/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"signature": [
|
|
"{ find: (params: ",
|
|
"GlobalSearchFindParams",
|
|
", options: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "public",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-public.GlobalSearchFindOptions",
|
|
"text": "GlobalSearchFindOptions"
|
|
},
|
|
") => Observable<",
|
|
"GlobalSearchBatchedResults",
|
|
">; getSearchableTypes: () => Promise<string[]>; }"
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-server.GlobalSearchBatchedResults",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchBatchedResults",
|
|
"description": [
|
|
"\nResponse returned from the {@link GlobalSearchPluginStart | global search service}'s `find` API\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchBatchedResults.results",
|
|
"type": "Array",
|
|
"label": "results",
|
|
"description": [
|
|
"\nResults for this batch"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 89
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchResult",
|
|
"text": "GlobalSearchResult"
|
|
},
|
|
"[]"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 85
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchFindOptions",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchFindOptions",
|
|
"description": [
|
|
"\nOptions for the server-side {@link GlobalSearchPluginStart.find | find API}\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchFindOptions.preference",
|
|
"type": "string",
|
|
"label": "preference",
|
|
"description": [
|
|
"\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster.\nIf not specified, a random token will be generated and used."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 95
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchFindOptions.aborted$",
|
|
"type": "Object",
|
|
"label": "aborted$",
|
|
"description": [
|
|
"\nOptional observable to notify that the associated `find` call should be canceled.\nIf/when provided and emitting, no further result emission will be performed and the result observable will be completed."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 100
|
|
},
|
|
"signature": [
|
|
"Observable",
|
|
"<void> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 88
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchProviderContext",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchProviderContext",
|
|
"description": [
|
|
"\nContext passed to server-side {@GlobalSearchResultProvider | result provider}'s `find` method.\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderContext.core",
|
|
"type": "Object",
|
|
"label": "core",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"signature": [
|
|
"{ savedObjects: { client: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectsClient",
|
|
"text": "SavedObjectsClient"
|
|
},
|
|
", \"get\" | \"delete\" | \"create\" | \"find\" | \"update\" | \"bulkCreate\" | \"bulkGet\" | \"bulkUpdate\" | \"errors\" | \"checkConflicts\" | \"resolve\" | \"addToNamespaces\" | \"deleteFromNamespaces\" | \"removeReferencesTo\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">; typeRegistry: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCoreSavedObjectsPluginApi",
|
|
"section": "def-server.SavedObjectTypeRegistry",
|
|
"text": "SavedObjectTypeRegistry"
|
|
},
|
|
", \"getType\" | \"getVisibleTypes\" | \"getAllTypes\" | \"getImportableAndExportableTypes\" | \"isNamespaceAgnostic\" | \"isSingleNamespace\" | \"isMultiNamespace\" | \"isShareable\" | \"isHidden\" | \"getIndex\" | \"isImportableAndExportable\">; }; elasticsearch: { legacy: { client: Pick<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.LegacyScopedClusterClient",
|
|
"text": "LegacyScopedClusterClient"
|
|
},
|
|
", \"callAsCurrentUser\" | \"callAsInternalUser\">; }; }; uiSettings: { client: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.IUiSettingsClient",
|
|
"text": "IUiSettingsClient"
|
|
},
|
|
"; }; capabilities: ",
|
|
"Observable"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 65
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchProviderFindOptions",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchProviderFindOptions",
|
|
"description": [
|
|
"\nOptions provided to {@link GlobalSearchResultProvider | a result provider}'s `find` method."
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderFindOptions.preference",
|
|
"type": "string",
|
|
"label": "preference",
|
|
"description": [
|
|
"\nA custom preference token associated with a search 'session' that should be used to get consistent scoring\nwhen performing calls to ES. Can also be used as a 'session' token for providers returning data from elsewhere\nthan an elasticsearch cluster."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 20
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderFindOptions.aborted$",
|
|
"type": "Object",
|
|
"label": "aborted$",
|
|
"description": [
|
|
"\nObservable that emits once if and when the `find` call has been aborted, either manually by the consumer,\nor when the internal timeout period as been reached.\n\nWhen a `find` request is effectively aborted, the service will stop emitting any new result to the consumer anyway, but\nthis can (and should) be used to cancel any pending asynchronous task and complete the result observable from within the provider."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"Observable",
|
|
"<void>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderFindOptions.maxResults",
|
|
"type": "number",
|
|
"label": "maxResults",
|
|
"description": [
|
|
"\nThe total maximum number of results (including all batches, not per emission) that should be returned by the provider for a given `find` request.\nAny result emitted exceeding this quota will be ignored by the service and not emitted to the consumer."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 33
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchProviderResult",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchProviderResult",
|
|
"description": [
|
|
"\nRepresentation of a result returned by a {@link GlobalSearchResultProvider | result provider}"
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"an id that should be unique for an individual provider's results"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 46
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.title",
|
|
"type": "string",
|
|
"label": "title",
|
|
"description": [
|
|
"the title/label of the result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 48
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.type",
|
|
"type": "string",
|
|
"label": "type",
|
|
"description": [
|
|
"the type of result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 50
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.icon",
|
|
"type": "string",
|
|
"label": "icon",
|
|
"description": [
|
|
"an optional EUI icon name to associate with the search result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 52
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.url",
|
|
"type": "CompoundType",
|
|
"label": "url",
|
|
"description": [
|
|
"\nThe url associated with this result.\nThis can be either an absolute url, a path relative to the incoming request's basePath, or a structure specifying if the basePath should be prepended.\n"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 62
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderResultUrl",
|
|
"text": "GlobalSearchProviderResultUrl"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.score",
|
|
"type": "number",
|
|
"label": "score",
|
|
"description": [
|
|
"the score of the result, from 1 (lowest) to 100 (highest)"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 64
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchProviderResult.meta",
|
|
"type": "Object",
|
|
"label": "meta",
|
|
"description": [
|
|
"an optional record of metadata for this result"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 66
|
|
},
|
|
"signature": [
|
|
"Record<string, ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.Serializable",
|
|
"text": "Serializable"
|
|
},
|
|
"> | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 44
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchResultProvider",
|
|
"type": "Interface",
|
|
"label": "GlobalSearchResultProvider",
|
|
"description": [
|
|
"\nGlobalSearch result provider, to be registered using the {@link GlobalSearchPluginSetup | global search API}\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchResultProvider.id",
|
|
"type": "string",
|
|
"label": "id",
|
|
"description": [
|
|
"\nid of the provider"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 112
|
|
}
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchResultProvider.find",
|
|
"type": "Function",
|
|
"label": "find",
|
|
"signature": [
|
|
"(search: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchFindParams",
|
|
"text": "GlobalSearchFindParams"
|
|
},
|
|
", options: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderFindOptions",
|
|
"text": "GlobalSearchProviderFindOptions"
|
|
},
|
|
", context: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "server",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-server.GlobalSearchProviderContext",
|
|
"text": "GlobalSearchProviderContext"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderResult",
|
|
"text": "GlobalSearchProviderResult"
|
|
}
|
|
],
|
|
"description": [
|
|
"\nMethod that should return an observable used to emit new results from the provider.\n\nSee {@GlobalSearchProviderResult | the result type} for the expected result structure.\n"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "search",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchFindParams",
|
|
"text": "GlobalSearchFindParams"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 131
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchProviderFindOptions",
|
|
"text": "GlobalSearchProviderFindOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 132
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "context",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "server",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-server.GlobalSearchProviderContext",
|
|
"text": "GlobalSearchProviderContext"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 133
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 130
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.GlobalSearchResultProvider.getSearchableTypes",
|
|
"type": "Function",
|
|
"label": "getSearchableTypes",
|
|
"description": [
|
|
"\nMethod that should return all the possible {@link GlobalSearchProviderResult.type | type} of results that\nthis provider can return."
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 140
|
|
},
|
|
"signature": [
|
|
"(context: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "server",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-server.GlobalSearchProviderContext",
|
|
"text": "GlobalSearchProviderContext"
|
|
},
|
|
") => string[] | Promise<string[]>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 108
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.RouteHandlerGlobalSearchContext",
|
|
"type": "Interface",
|
|
"label": "RouteHandlerGlobalSearchContext",
|
|
"description": [
|
|
"\nglobalSearch route handler context.\n"
|
|
],
|
|
"tags": [
|
|
"public"
|
|
],
|
|
"children": [
|
|
{
|
|
"id": "def-server.RouteHandlerGlobalSearchContext.find",
|
|
"type": "Function",
|
|
"label": "find",
|
|
"signature": [
|
|
"(params: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchFindParams",
|
|
"text": "GlobalSearchFindParams"
|
|
},
|
|
", options: ",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "server",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-server.GlobalSearchFindOptions",
|
|
"text": "GlobalSearchFindOptions"
|
|
},
|
|
") => ",
|
|
"Observable",
|
|
"<",
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchBatchedResults",
|
|
"text": "GlobalSearchBatchedResults"
|
|
},
|
|
">"
|
|
],
|
|
"description": [
|
|
"\nSee {@link SearchServiceStart.find | the find API}"
|
|
],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "params",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "common",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-common.GlobalSearchFindParams",
|
|
"text": "GlobalSearchFindParams"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 51
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "globalSearch",
|
|
"scope": "server",
|
|
"docId": "kibGlobalSearchPluginApi",
|
|
"section": "def-server.GlobalSearchFindOptions",
|
|
"text": "GlobalSearchFindOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 52
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 50
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.RouteHandlerGlobalSearchContext.getSearchableTypes",
|
|
"type": "Function",
|
|
"label": "getSearchableTypes",
|
|
"description": [
|
|
"\nSee {@link SearchServiceStart.getSearchableTypes | the getSearchableTypes API}"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 57
|
|
},
|
|
"signature": [
|
|
"() => Promise<string[]>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 46
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"id": "def-server.GlobalSearchProviderResultUrl",
|
|
"type": "Type",
|
|
"label": "GlobalSearchProviderResultUrl",
|
|
"tags": [],
|
|
"description": [
|
|
"\nStructured type for the {@link GlobalSearchProviderResult.url | provider result's url property}"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 39
|
|
},
|
|
"signature": [
|
|
"string | { path: string; prependBasePath: boolean; }"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-server.GlobalSearchResult",
|
|
"type": "Type",
|
|
"label": "GlobalSearchResult",
|
|
"tags": [],
|
|
"description": [
|
|
"\nRepresentation of a result returned by the {@link GlobalSearchPluginStart.find | `find` API}"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/common/types.ts",
|
|
"lineNumber": 72
|
|
},
|
|
"signature": [
|
|
"Pick<GlobalSearchProviderResult, \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"start": {
|
|
"id": "def-server.GlobalSearchPluginStart",
|
|
"type": "Type",
|
|
"label": "GlobalSearchPluginStart",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 28
|
|
},
|
|
"signature": [
|
|
"{ find: (params: GlobalSearchFindParams, options: GlobalSearchFindOptions, request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Observable<GlobalSearchBatchedResults>; getSearchableTypes: (request: ",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "server",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-server.KibanaRequest",
|
|
"text": "KibanaRequest"
|
|
},
|
|
"<unknown, unknown, unknown, any>) => Promise<string[]>; }"
|
|
],
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
},
|
|
"setup": {
|
|
"id": "def-server.GlobalSearchPluginSetup",
|
|
"type": "Type",
|
|
"label": "GlobalSearchPluginSetup",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/global_search/server/types.ts",
|
|
"lineNumber": 27
|
|
},
|
|
"signature": [
|
|
"{ registerResultProvider: (provider: GlobalSearchResultProvider) => void; }"
|
|
],
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |