github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

update api docs (#95154)

Browse source
This commit is contained in:
Stacey Gammon 2021-03-23 14:31:08 -04:00 • committed by GitHub
parent dc1f7d51d4
commit 2ed2cfe52f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
39 changed files with 6558 additions and 1337 deletions
Download patch file Download diff file Expand all files Collapse all files

69
api_docs/actions.json
View file

@ -1646,6 +1646,21 @@
],
"enums": [],
"misc": [
{
"id": "def-common.AsApiContract",
"type": "Type",
"label": "AsApiContract",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
"lineNumber": 14
},
"signature": [
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: T[K]; }"
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.BASE_ACTION_API_PATH",
@ -1660,6 +1675,60 @@
"\"/api/actions\""
],
"initialIsOpen": false
},
{
"id": "def-common.RewriteRequestCase",
"type": "Type",
"label": "RewriteRequestCase",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
"lineNumber": 18
},
"signature": [
"(requested: ",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.AsApiContract",
"text": "AsApiContract"
},
"<T>) => T"
],
"initialIsOpen": false
},
{
"id": "def-common.RewriteResponseCase",
"type": "Type",
"label": "RewriteResponseCase",
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
"lineNumber": 19
},
"signature": [
"(responded: T) => T extends (infer Item)[] ? ",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.AsApiContract",
"text": "AsApiContract"
},
"<Item>[] : ",
{
"pluginId": "actions",
"scope": "common",
"docId": "kibActionsPluginApi",
"section": "def-common.AsApiContract",
"text": "AsApiContract"
},
"<T>"
],
"initialIsOpen": false
}
],
"objects": []

84
api_docs/alerting.json
View file

@ -222,7 +222,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 92
"lineNumber": 85
}
},
{
@ -233,7 +233,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 93
"lineNumber": 86
},
"signature": [
"Date"
@ -247,7 +247,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 94
"lineNumber": 87
},
"signature": [
"Date | null"
@ -261,7 +261,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 95
"lineNumber": 88
},
"signature": [
{
@ -282,7 +282,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 96
"lineNumber": 89
},
"signature": [
"Params"
@ -296,7 +296,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 97
"lineNumber": 90
},
"signature": [
"State"
@ -310,7 +310,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 98
"lineNumber": 91
}
},
{
@ -321,7 +321,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 99
"lineNumber": 92
},
"signature": [
"string | undefined"
@ -335,7 +335,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 100
"lineNumber": 93
}
},
{
@ -346,7 +346,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 101
"lineNumber": 94
},
"signature": [
"string[]"
@ -360,7 +360,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 102
"lineNumber": 95
},
"signature": [
"string | null"
@ -374,7 +374,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 103
"lineNumber": 96
},
"signature": [
"string | null"
@ -383,7 +383,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 85
"lineNumber": 78
},
"initialIsOpen": false
},
@ -404,7 +404,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 48
"lineNumber": 46
},
"signature": [
"() => ",
@ -425,7 +425,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 49
"lineNumber": 47
},
"signature": [
"() => Set<",
@ -447,7 +447,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 50
"lineNumber": 48
},
"signature": [
"() => Promise<",
@ -464,7 +464,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 47
"lineNumber": 45
},
"initialIsOpen": false
},
@ -483,7 +483,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 226
"lineNumber": 219
},
"signature": [
{
@ -503,7 +503,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 227
"lineNumber": 220
},
"signature": [
{
@ -518,7 +518,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 225
"lineNumber": 218
},
"initialIsOpen": false
},
@ -548,7 +548,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 80
"lineNumber": 73
},
"signature": [
"(id: string) => Pick<",
@ -565,7 +565,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 75
"lineNumber": 68
},
"initialIsOpen": false
},
@ -594,7 +594,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 127
"lineNumber": 120
}
},
{
@ -605,7 +605,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 128
"lineNumber": 121
}
},
{
@ -616,7 +616,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 129
"lineNumber": 122
},
"signature": [
"{ params?: ",
@ -638,7 +638,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 132
"lineNumber": 125
},
"signature": [
{
@ -659,7 +659,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 133
"lineNumber": 126
},
"signature": [
"ActionGroupIds"
@ -673,7 +673,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 134
"lineNumber": 127
},
"signature": [
{
@ -694,7 +694,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 135
"lineNumber": 128
},
"signature": [
{
@ -723,7 +723,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 146
"lineNumber": 139
}
},
{
@ -734,7 +734,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 147
"lineNumber": 140
},
"signature": [
"{ context?: ",
@ -772,7 +772,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 152
"lineNumber": 145
},
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
@ -781,7 +781,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 119
"lineNumber": 112
},
"initialIsOpen": false
},
@ -905,7 +905,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 112
"lineNumber": 111
}
}
],
@ -913,13 +913,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 104
"lineNumber": 103
}
}
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 103
"lineNumber": 102
},
"initialIsOpen": false
},
@ -938,7 +938,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 124
"lineNumber": 123
},
"signature": [
"() => Set<",
@ -994,7 +994,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 125
"lineNumber": 124
}
}
],
@ -1002,7 +1002,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 125
"lineNumber": 124
}
},
{
@ -1013,7 +1013,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 126
"lineNumber": 125
},
"signature": [
"() => Promise<",
@ -1030,7 +1030,7 @@
],
"source": {
"path": "x-pack/plugins/alerting/server/plugin.ts",
"lineNumber": 123
"lineNumber": 122
},
"initialIsOpen": false
}
@ -1177,7 +1177,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/alerting/server/types.ts",
"lineNumber": 185
"lineNumber": 178
},
"signature": [
"Pick<Alert<Params>, \"id\"> & Partial<Pick<Alert<Params>, \"enabled\" | \"name\" | \"params\" | \"actions\" | \"muteAll\" | \"apiKey\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"throttle\" | \"notifyWhen\" | \"mutedInstanceIds\" | \"executionStatus\">>"

8
api_docs/charts.json
View file

@ -9,7 +9,7 @@
"children": [
{
"type": "Object",
"label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n}",
"label": "{\n onChange,\n color: selectedColor,\n label,\n useLegacyColors = true,\n colorIsOverwritten = true,\n onKeyDown,\n}",
"isRequired": true,
"signature": [
"ColorPickerProps"
@ -17,18 +17,18 @@
"description": [],
"source": {
"path": "src/plugins/charts/public/static/components/color_picker.tsx",
"lineNumber": 108
"lineNumber": 111
}
}
],
"signature": [
"({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, }: ColorPickerProps) => JSX.Element"
"({ onChange, color: selectedColor, label, useLegacyColors, colorIsOverwritten, onKeyDown, }: ColorPickerProps) => JSX.Element"
],
"description": [],
"label": "ColorPicker",
"source": {
"path": "src/plugins/charts/public/static/components/color_picker.tsx",
"lineNumber": 108
"lineNumber": 111
},
"tags": [],
"returnComment": [],

14
api_docs/core.json
View file

File diff suppressed because one or more lines are too long

4
api_docs/core_application.json
View file

@ -1824,7 +1824,7 @@
"lineNumber": 322
},
"signature": [
"Pick<App<unknown>, \"status\" | \"id\" | \"title\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }"
"Pick<App<unknown>, \"status\" | \"title\" | \"id\" | \"order\" | \"category\" | \"navLinkStatus\" | \"defaultPath\" | \"tooltip\" | \"euiIconType\" | \"icon\" | \"capabilities\" | \"chromeless\" | \"appRoute\" | \"exactRoute\"> & { status: AppStatus; navLinkStatus: AppNavLinkStatus; appRoute: string; meta: PublicAppMetaInfo; }"
],
"initialIsOpen": false
},
@ -1862,7 +1862,7 @@
"lineNumber": 277
},
"signature": [
"Pick<AppSearchDeepLink, \"id\" | \"title\" | \"path\"> & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }"
"Pick<AppSearchDeepLink, \"title\" | \"id\" | \"path\"> & { searchDeepLinks: PublicAppSearchDeepLinkInfo[]; keywords: string[]; }"
],
"initialIsOpen": false
}

360
api_docs/data.json
View file

File diff suppressed because it is too large Load diff

100
api_docs/data_enhanced.json
View file

@ -531,8 +531,8 @@
"\nID of the async search request"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 72
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 73
}
},
{
@ -544,8 +544,8 @@
"\nSearch strategy used to submit the search request"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 76
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 77
}
},
{
@ -557,8 +557,8 @@
"\nstatus"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 80
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 81
}
},
{
@ -570,8 +570,8 @@
"\nAn optional error. Set if status is set to error."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 84
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 85
},
"signature": [
"string | undefined"
@ -579,8 +579,8 @@
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 68
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 69
},
"initialIsOpen": false
},
@ -598,8 +598,8 @@
"label": "sessionId",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 12
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 13
}
},
{
@ -611,8 +611,8 @@
"\nUser-facing session name to be displayed in session management"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 16
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 17
},
"signature": [
"string | undefined"
@ -627,8 +627,8 @@
"\nApp that created the session. e.g 'discover'"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 20
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 21
},
"signature": [
"string | undefined"
@ -643,8 +643,8 @@
"\nCreation time of the session"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 24
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 25
}
},
{
@ -656,8 +656,8 @@
"\nLast touch time of the session"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 28
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 29
}
},
{
@ -669,8 +669,8 @@
"\nExpiration time of the session. Expiration itself is managed by Elasticsearch."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 32
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 33
}
},
{
@ -682,14 +682,14 @@
"\nstatus"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 36
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 37
},
"signature": [
{
"pluginId": "dataEnhanced",
"pluginId": "data",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionStatus",
"text": "SearchSessionStatus"
}
@ -704,8 +704,8 @@
"\nurlGeneratorId"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 40
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 41
},
"signature": [
"string | undefined"
@ -720,8 +720,8 @@
"\nThe application state that was used to create the session.\nShould be used, for example, to re-load an expired search session."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 45
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 46
},
"signature": [
"Record<string, unknown> | undefined"
@ -736,8 +736,8 @@
"\nApplication state that should be used to restore the session.\nFor example, relative dates are conveted to absolute ones."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 50
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 51
},
"signature": [
"Record<string, unknown> | undefined"
@ -752,15 +752,15 @@
"\nMapping of search request hashes to their corresponsing info (async search id, etc.)"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 54
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 55
},
"signature": [
"Record<string, ",
{
"pluginId": "dataEnhanced",
"pluginId": "data",
"scope": "common",
"docId": "kibDataEnhancedPluginApi",
"docId": "kibDataSearchPluginApi",
"section": "def-common.SearchSessionRequestInfo",
"text": "SearchSessionRequestInfo"
},
@ -776,8 +776,8 @@
"\nThis value is true if the session was actively stored by the user. If it is false, the session may be purged by the system."
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 59
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 60
}
},
{
@ -789,8 +789,8 @@
"\nThe realm type/name & username uniquely identifies the user who created this search session"
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 63
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 64
},
"signature": [
"string | undefined"
@ -803,8 +803,8 @@
"label": "realmName",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 64
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 65
},
"signature": [
"string | undefined"
@ -817,8 +817,8 @@
"label": "username",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 65
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 66
},
"signature": [
"string | undefined"
@ -826,8 +826,8 @@
}
],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 11
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 12
},
"initialIsOpen": false
}
@ -840,8 +840,8 @@
"tags": [],
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/status.ts",
"lineNumber": 8
"path": "src/plugins/data/common/search/session/status.ts",
"lineNumber": 9
},
"initialIsOpen": false
}
@ -916,8 +916,8 @@
"label": "SEARCH_SESSION_TYPE",
"description": [],
"source": {
"path": "x-pack/plugins/data_enhanced/common/search/session/types.ts",
"lineNumber": 10
"path": "src/plugins/data/common/search/session/types.ts",
"lineNumber": 11
},
"signature": [
"\"search-session\""

56
api_docs/data_index_patterns.json
View file

@ -368,7 +368,7 @@
"section": "def-server.DataPluginStart",
"text": "DataPluginStart"
},
">, { expressions }: ",
">, { logger, expressions }: ",
{
"pluginId": "data",
"scope": "server",
@ -413,12 +413,12 @@
"description": [],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 47
"lineNumber": 49
}
},
{
"type": "Object",
"label": "{ expressions }",
"label": "{ logger, expressions }",
"isRequired": true,
"signature": [
{
@ -432,7 +432,7 @@
"description": [],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 48
"lineNumber": 50
}
}
],
@ -440,7 +440,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 46
"lineNumber": 48
}
},
{
@ -507,7 +507,7 @@
"description": [],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 58
"lineNumber": 76
}
},
{
@ -526,7 +526,7 @@
"description": [],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 58
"lineNumber": 76
}
}
],
@ -534,13 +534,13 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 58
"lineNumber": 76
}
}
],
"source": {
"path": "src/plugins/data/server/index_patterns/index_patterns_service.ts",
"lineNumber": 45
"lineNumber": 47
},
"initialIsOpen": false
}
@ -3455,7 +3455,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 464
"lineNumber": 465
}
}
],
@ -3476,7 +3476,7 @@
"label": "get",
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 464
"lineNumber": 465
},
"tags": [],
"returnComment": []
@ -3524,7 +3524,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 483
"lineNumber": 484
}
},
{
@ -3537,7 +3537,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 483
"lineNumber": 484
}
}
],
@ -3547,7 +3547,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 483
"lineNumber": 484
}
},
{
@ -3593,7 +3593,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 508
"lineNumber": 509
}
},
{
@ -3608,7 +3608,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 508
"lineNumber": 509
}
},
{
@ -3623,7 +3623,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 508
"lineNumber": 509
}
}
],
@ -3631,7 +3631,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 508
"lineNumber": 509
}
},
{
@ -3677,7 +3677,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 521
"lineNumber": 522
}
},
{
@ -3692,7 +3692,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 521
"lineNumber": 522
}
}
],
@ -3700,7 +3700,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 521
"lineNumber": 522
}
},
{
@ -3738,7 +3738,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 547
"lineNumber": 548
}
},
{
@ -3751,7 +3751,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 548
"lineNumber": 549
}
},
{
@ -3764,7 +3764,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 549
"lineNumber": 550
}
}
],
@ -3772,7 +3772,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 546
"lineNumber": 547
}
},
{
@ -3798,7 +3798,7 @@
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 632
"lineNumber": 633
}
}
],
@ -3806,7 +3806,7 @@
"returnComment": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 632
"lineNumber": 633
}
}
],
@ -6710,7 +6710,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 638
"lineNumber": 639
},
"signature": [
"{ get: (id: string) => Promise<IndexPattern>; delete: (indexPatternId: string) => Promise<{}>; create: (spec: IndexPatternSpec, skipFetchFields?: boolean) => Promise<IndexPattern>; ensureDefaultIndexPattern: EnsureDefaultIndexPattern; getIds: (refresh?: boolean) => Promise<string[]>; getTitles: (refresh?: boolean) => Promise<string[]>; find: (search: string, size?: number) => Promise<IndexPattern[]>; getIdsWithTitle: (refresh?: boolean) => Promise<{ id: string; title: string; }[]>; clearCache: (id?: string | undefined) => void; getCache: () => Promise<SavedObject<IndexPatternSavedObjectAttrs>[] | null | undefined>; getDefault: () => Promise<IndexPattern | null>; setDefault: (id: string, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: GetFieldsOptions) => Promise<any>; getFieldsForIndexPattern: (indexPattern: IndexPattern | IndexPatternSpec, options?: GetFieldsOptions | undefined) => Promise<any>; refreshFields: (indexPattern: IndexPattern) => Promise<void>; fieldArrayToMap: (fields: FieldSpec[], fieldAttrs?: FieldAttrs | undefined) => Record<string, FieldSpec>; savedObjectToSpec: (savedObject: SavedObject<IndexPatternAttributes>) => IndexPatternSpec; createAndSave: (spec: IndexPatternSpec, override?: boolean, skipFetchFields?: boolean) => Promise<IndexPattern>; createSavedObject: (indexPattern: IndexPattern, override?: boolean) => Promise<IndexPattern>; updateSavedObject: (indexPattern: IndexPattern, saveAttempts?: number, ignoreErrors?: boolean) => Promise<void | Error>; }"

1575
api_docs/data_search.json
View file

File diff suppressed because it is too large Load diff

3
api_docs/data_search.mdx
View file

@ -36,9 +36,6 @@ import dataSearchObj from './data_search.json';
### Interfaces
<DocDefinitionList data={dataSearchObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={dataSearchObj.server.misc}/>
## Common
### Objects

32
api_docs/data_ui.json
View file

File diff suppressed because one or more lines are too long

20
api_docs/discover.json
View file

@ -807,8 +807,8 @@
"label": "docViews",
"description": [],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 75
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 76
},
"signature": [
"{ addDocView(docViewRaw: ",
@ -832,8 +832,8 @@
}
],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 74
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 75
},
"lifecycle": "setup",
"initialIsOpen": true
@ -852,8 +852,8 @@
"label": "savedSearchLoader",
"description": [],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 86
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 87
},
"signature": [
{
@ -874,8 +874,8 @@
"\n`share` plugin URL generator for Discover app. Use it to generate links into\nDiscover application, example:\n\n```ts\nconst url = await plugins.discover.urlGenerator.createUrl({\n savedSearchId: '571aaf70-4c88-11e8-b3d7-01146121b73d',\n indexPatternId: 'c367b774-a4c2-11ea-bb37-0242ac130002',\n timeRange: {\n to: 'now',\n from: 'now-15m',\n mode: 'relative',\n },\n});\n```"
],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 104
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 105
},
"signature": [
{
@ -890,8 +890,8 @@
}
],
"source": {
"path": "src/plugins/discover/public/plugin.ts",
"lineNumber": 85
"path": "src/plugins/discover/public/plugin.tsx",
"lineNumber": 86
},
"lifecycle": "start",
"initialIsOpen": true

26
api_docs/expressions.json
View file

@ -5364,7 +5364,7 @@
"section": "def-common.InferFunctionDefinition",
"text": "InferFunctionDefinition"
},
"<FnDef>[\"name\"], initialArgs: { [K in keyof FunctionArgs<FnDef>]: ",
"<FnDef>[\"name\"], initialArgs: { [K in keyof FunctionArgs<FnDef>]: FunctionArgs<FnDef>[K] | ",
{
"pluginId": "expressions",
"scope": "common",
@ -5372,7 +5372,7 @@
"section": "def-common.ExpressionAstExpressionBuilder",
"text": "ExpressionAstExpressionBuilder"
},
" | FunctionArgs<FnDef>[K] | ",
" | ",
{
"pluginId": "expressions",
"scope": "common",
@ -5421,7 +5421,7 @@
"label": "initialArgs",
"isRequired": true,
"signature": [
"{ [K in keyof FunctionArgs<FnDef>]: ",
"{ [K in keyof FunctionArgs<FnDef>]: FunctionArgs<FnDef>[K] | ",
{
"pluginId": "expressions",
"scope": "common",
@ -5429,7 +5429,7 @@
"section": "def-common.ExpressionAstExpressionBuilder",
"text": "ExpressionAstExpressionBuilder"
},
" | FunctionArgs<FnDef>[K] | ",
" | ",
{
"pluginId": "expressions",
"scope": "common",
@ -13485,7 +13485,7 @@
"section": "def-common.InferFunctionDefinition",
"text": "InferFunctionDefinition"
},
"<FnDef>[\"name\"], initialArgs: { [K in keyof FunctionArgs<FnDef>]: ",
"<FnDef>[\"name\"], initialArgs: { [K in keyof FunctionArgs<FnDef>]: FunctionArgs<FnDef>[K] | ",
{
"pluginId": "expressions",
"scope": "common",
@ -13493,7 +13493,7 @@
"section": "def-common.ExpressionAstExpressionBuilder",
"text": "ExpressionAstExpressionBuilder"
},
" | FunctionArgs<FnDef>[K] | ",
" | ",
{
"pluginId": "expressions",
"scope": "common",
@ -13542,7 +13542,7 @@
"label": "initialArgs",
"isRequired": true,
"signature": [
"{ [K in keyof FunctionArgs<FnDef>]: ",
"{ [K in keyof FunctionArgs<FnDef>]: FunctionArgs<FnDef>[K] | ",
{
"pluginId": "expressions",
"scope": "common",
@ -13550,7 +13550,7 @@
"section": "def-common.ExpressionAstExpressionBuilder",
"text": "ExpressionAstExpressionBuilder"
},
" | FunctionArgs<FnDef>[K] | ",
" | ",
{
"pluginId": "expressions",
"scope": "common",
@ -21552,7 +21552,7 @@
"section": "def-common.InferFunctionDefinition",
"text": "InferFunctionDefinition"
},
"<FnDef>[\"name\"], initialArgs: { [K in keyof FunctionArgs<FnDef>]: ",
"<FnDef>[\"name\"], initialArgs: { [K in keyof FunctionArgs<FnDef>]: FunctionArgs<FnDef>[K] | ",
{
"pluginId": "expressions",
"scope": "common",
@ -21560,7 +21560,7 @@
"section": "def-common.ExpressionAstExpressionBuilder",
"text": "ExpressionAstExpressionBuilder"
},
" | FunctionArgs<FnDef>[K] | ",
" | ",
{
"pluginId": "expressions",
"scope": "common",
@ -21609,7 +21609,7 @@
"label": "initialArgs",
"isRequired": true,
"signature": [
"{ [K in keyof FunctionArgs<FnDef>]: ",
"{ [K in keyof FunctionArgs<FnDef>]: FunctionArgs<FnDef>[K] | ",
{
"pluginId": "expressions",
"scope": "common",
@ -21617,7 +21617,7 @@
"section": "def-common.ExpressionAstExpressionBuilder",
"text": "ExpressionAstExpressionBuilder"
},
" | FunctionArgs<FnDef>[K] | ",
" | ",
{
"pluginId": "expressions",
"scope": "common",
@ -33883,4 +33883,4 @@
}
]
}
}
}

976
api_docs/file_upload.json
View file

File diff suppressed because it is too large Load diff

659
api_docs/fleet.json
View file

File diff suppressed because it is too large Load diff

4
api_docs/global_search.json
View file

@ -527,7 +527,7 @@
"lineNumber": 72
},
"signature": [
"Pick<GlobalSearchProviderResult, \"type\" | \"id\" | \"title\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
"Pick<GlobalSearchProviderResult, \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
],
"initialIsOpen": false
}
@ -1242,7 +1242,7 @@
"lineNumber": 72
},
"signature": [
"Pick<GlobalSearchProviderResult, \"type\" | \"id\" | \"title\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
"Pick<GlobalSearchProviderResult, \"type\" | \"title\" | \"id\" | \"meta\" | \"icon\" | \"score\"> & { url: string; }"
],
"initialIsOpen": false
}

2
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/lens.json
View file

@ -1618,7 +1618,7 @@
"lineNumber": 38
},
"signature": [
"Pick<LensByValueInput, \"palette\" | \"id\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"renderMode\"> & { attributes: LensAttributes<'lnsXY', XYState> | LensAttributes<'lnsPie', PieVisualizationState> | LensAttributes<'lnsDatatable', DatatableVisualizationState> | LensAttributes<'lnsMetric', MetricState>; }"
"Pick<LensByValueInput, \"palette\" | \"timeRange\" | \"syncColors\" | \"viewMode\" | \"filters\" | \"title\" | \"query\" | \"hidePanelTitles\" | \"id\" | \"lastReloadRequestTime\" | \"enhancements\" | \"disabledActions\" | \"disableTriggers\" | \"searchSessionId\" | \"className\" | \"style\" | \"renderMode\"> & { attributes: LensAttributes<'lnsXY', XYState> | LensAttributes<'lnsPie', PieVisualizationState> | LensAttributes<'lnsDatatable', DatatableVisualizationState> | LensAttributes<'lnsMetric', MetricState>; }"
],
"initialIsOpen": false
},

2
api_docs/lists.json
View file

@ -2296,7 +2296,7 @@
"children": [
{
"type": "Object",
"label": "{ spaceId, user, config, callCluster }",
"label": "{ spaceId, user, config, esClient }",
"isRequired": true,
"signature": [
{

6
api_docs/management.json
View file

@ -175,7 +175,7 @@
"section": "def-public.CreateManagementItemArgs",
"text": "CreateManagementItemArgs"
},
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"id\" | \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">"
", \"title\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\"> & Pick<{ id: string; }, \"id\"> & Pick<{ id: string; }, never>, \"title\" | \"id\" | \"order\" | \"euiIconType\" | \"icon\" | \"tip\">"
],
"description": [],
"source": {
@ -204,7 +204,7 @@
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
", \"id\" | \"title\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">) => ",
{
"pluginId": "management",
"scope": "public",
@ -228,7 +228,7 @@
"section": "def-public.RegisterManagementAppArgs",
"text": "RegisterManagementAppArgs"
},
", \"id\" | \"title\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">"
", \"title\" | \"id\" | \"order\" | \"meta\" | \"mount\" | \"euiIconType\" | \"icon\" | \"tip\">"
],
"description": [],
"source": {

1573
api_docs/maps.json
View file

File diff suppressed because it is too large Load diff

17
api_docs/maps.mdx
View file

@ -22,3 +22,20 @@ import mapsObj from './maps.json';
### Consts, variables and types
<DocDefinitionList data={mapsObj.client.misc}/>
## Common
### Objects
<DocDefinitionList data={mapsObj.common.objects}/>
### Functions
<DocDefinitionList data={mapsObj.common.functions}/>
### Interfaces
<DocDefinitionList data={mapsObj.common.interfaces}/>
### Enums
<DocDefinitionList data={mapsObj.common.enums}/>
### Consts, variables and types
<DocDefinitionList data={mapsObj.common.misc}/>

1157
api_docs/maps_ems.json Normal file
View file

File diff suppressed because it is too large Load diff

46
api_docs/maps_ems.mdx Normal file
View file

@ -0,0 +1,46 @@
---
id: kibMapsEmsPluginApi
slug: /kibana-dev-docs/mapsEmsPluginApi
title: mapsEms
image: https://source.unsplash.com/400x175/?github
summary: API docs for the mapsEms plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsEms']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import mapsEmsObj from './maps_ems.json';
## Client
### Setup
<DocDefinitionList data={[mapsEmsObj.client.setup]}/>
### Start
<DocDefinitionList data={[mapsEmsObj.client.start]}/>
### Objects
<DocDefinitionList data={mapsEmsObj.client.objects}/>
### Interfaces
<DocDefinitionList data={mapsEmsObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={mapsEmsObj.client.misc}/>
## Server
### Classes
<DocDefinitionList data={mapsEmsObj.server.classes}/>
### Interfaces
<DocDefinitionList data={mapsEmsObj.server.interfaces}/>
## Common
### Objects
<DocDefinitionList data={mapsEmsObj.common.objects}/>
### Consts, variables and types
<DocDefinitionList data={mapsEmsObj.common.misc}/>

277
api_docs/maps_legacy.json
View file

@ -1,277 +0,0 @@
{
"id": "mapsLegacy",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [
{
"id": "def-server.MapsLegacyPlugin",
"type": "Class",
"tags": [],
"label": "MapsLegacyPlugin",
"description": [],
"signature": [
{
"pluginId": "mapsLegacy",
"scope": "server",
"docId": "kibMapsLegacyPluginApi",
"section": "def-server.MapsLegacyPlugin",
"text": "MapsLegacyPlugin"
},
" implements ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.Plugin",
"text": "Plugin"
},
"<",
{
"pluginId": "mapsLegacy",
"scope": "server",
"docId": "kibMapsLegacyPluginApi",
"section": "def-server.MapsLegacyPluginSetup",
"text": "MapsLegacyPluginSetup"
},
", void, object, object>"
],
"children": [
{
"tags": [],
"id": "def-server.MapsLegacyPlugin._initializerContext",
"type": "Object",
"label": "_initializerContext",
"description": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 36
},
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
]
},
{
"id": "def-server.MapsLegacyPlugin.Unnamed",
"type": "Function",
"label": "Constructor",
"signature": [
"any"
],
"description": [],
"children": [
{
"type": "Object",
"label": "initializerContext",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.PluginInitializerContext",
"text": "PluginInitializerContext"
},
"<Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>>"
],
"description": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 38
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 38
}
},
{
"id": "def-server.MapsLegacyPlugin.setup",
"type": "Function",
"label": "setup",
"signature": [
"(core: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>) => { config: Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>; }"
],
"description": [],
"children": [
{
"type": "Object",
"label": "core",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.CoreSetup",
"text": "CoreSetup"
},
"<object, unknown>"
],
"description": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 42
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 42
}
},
{
"id": "def-server.MapsLegacyPlugin.start",
"type": "Function",
"label": "start",
"signature": [
"() => void"
],
"description": [],
"children": [],
"tags": [],
"returnComment": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 51
}
}
],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 35
},
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"id": "def-server.MapsLegacyPluginSetup",
"type": "Interface",
"label": "MapsLegacyPluginSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.MapsLegacyPluginSetup.config",
"type": "Object",
"label": "config",
"description": [],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 32
},
"signature": [
"Readonly<{} & { includeElasticMapsService: boolean; proxyElasticMapsServiceInMaps: boolean; tilemap: Readonly<{ url?: string | undefined; } & { options: Readonly<{ default?: boolean | undefined; tileSize?: number | undefined; subdomains?: string[] | undefined; errorTileUrl?: string | undefined; tms?: boolean | undefined; reuseTiles?: boolean | undefined; bounds?: number[] | undefined; } & { attribution: string; minZoom: number; maxZoom: number; }>; }>; regionmap: Readonly<{} & { includeElasticMapsService: boolean; layers: Readonly<{} & { name: string; format: Readonly<{} & { type: string; }>; fields: Readonly<{} & { description: string; name: string; }>[]; meta: Readonly<{} & { feature_collection_path: string; }>; url: string; attribution: string; }>[]; }>; manifestServiceUrl: string; emsUrl: string; emsFileApiUrl: string; emsTileApiUrl: string; emsLandingPageUrl: string; emsFontLibraryUrl: string; emsTileLayerId: Readonly<{} & { bright: string; desaturated: string; dark: string; }>; }>"
]
}
],
"source": {
"path": "src/plugins/maps_legacy/server/index.ts",
"lineNumber": 31
},
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"tags": [],
"id": "def-common.DEFAULT_EMS_FILE_API_URL",
"type": "string",
"label": "DEFAULT_EMS_FILE_API_URL",
"description": [],
"source": {
"path": "src/plugins/maps_legacy/common/ems_defaults.ts",
"lineNumber": 10
},
"signature": [
"\"https://vector.maps.elastic.co\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_EMS_FONT_LIBRARY_URL",
"type": "string",
"label": "DEFAULT_EMS_FONT_LIBRARY_URL",
"description": [],
"source": {
"path": "src/plugins/maps_legacy/common/ems_defaults.ts",
"lineNumber": 13
},
"signature": [
"\"https://tiles.maps.elastic.co/fonts/{fontstack}/{range}.pbf\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_EMS_LANDING_PAGE_URL",
"type": "string",
"label": "DEFAULT_EMS_LANDING_PAGE_URL",
"description": [],
"source": {
"path": "src/plugins/maps_legacy/common/ems_defaults.ts",
"lineNumber": 12
},
"signature": [
"\"https://maps.elastic.co/v7.12\""
],
"initialIsOpen": false
},
{
"tags": [],
"id": "def-common.DEFAULT_EMS_TILE_API_URL",
"type": "string",
"label": "DEFAULT_EMS_TILE_API_URL",
"description": [],
"source": {
"path": "src/plugins/maps_legacy/common/ems_defaults.ts",
"lineNumber": 11
},
"signature": [
"\"https://tiles.maps.elastic.co\""
],
"initialIsOpen": false
}
],
"objects": []
}
}

26
api_docs/maps_legacy.mdx
View file

@ -1,26 +0,0 @@
---
id: kibMapsLegacyPluginApi
slug: /kibana-dev-docs/mapsLegacyPluginApi
title: mapsLegacy
image: https://source.unsplash.com/400x175/?github
summary: API docs for the mapsLegacy plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'mapsLegacy']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import mapsLegacyObj from './maps_legacy.json';
## Server
### Classes
<DocDefinitionList data={mapsLegacyObj.server.classes}/>
### Interfaces
<DocDefinitionList data={mapsLegacyObj.server.interfaces}/>
## Common
### Consts, variables and types
<DocDefinitionList data={mapsLegacyObj.common.misc}/>

121
api_docs/ml.json
View file

@ -786,7 +786,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 147
"lineNumber": 151
},
"signature": [
{
@ -806,7 +806,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 148
"lineNumber": 152
}
},
{
@ -817,7 +817,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 149
"lineNumber": 153
}
},
{
@ -828,13 +828,13 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 150
"lineNumber": 154
}
}
],
"source": {
"path": "x-pack/plugins/ml/common/types/capabilities.ts",
"lineNumber": 146
"lineNumber": 150
},
"initialIsOpen": false
},
@ -1178,7 +1178,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 78
"lineNumber": 83
},
"signature": [
{
@ -1193,7 +1193,7 @@
],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 52
"lineNumber": 57
},
"initialIsOpen": false
}
@ -1266,7 +1266,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 48
"lineNumber": 53
},
"signature": [
"Dictionary<{ order: 'asc' | 'desc'; }>"
@ -1297,10 +1297,12 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
"lineNumber": 38
"lineNumber": 43
},
"signature": [
"(__0: { rowIndex: number; columnId: string; setCellProps: any; }) => any"
"(__0: { rowIndex: number; columnId: string; setCellProps: (props: ",
"CommonProps",
" & React.HTMLAttributes<HTMLDivElement>) => void; }) => any"
],
"initialIsOpen": false
}
@ -3455,7 +3457,14 @@
"lineNumber": 28
},
"signature": [
"IndicesOptions | undefined"
{
"pluginId": "ml",
"scope": "common",
"docId": "kibMlPluginApi",
"section": "def-common.IndicesOptions",
"text": "IndicesOptions"
},
" | undefined"
]
}
],
@ -3805,6 +3814,76 @@
},
"initialIsOpen": false
},
{
"id": "def-server.IndicesOptions",
"type": "Interface",
"label": "IndicesOptions",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-server.IndicesOptions.expand_wildcards",
"type": "CompoundType",
"label": "expand_wildcards",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 49
},
"signature": [
"\"all\" | \"none\" | \"hidden\" | \"open\" | \"closed\" | undefined"
]
},
{
"tags": [],
"id": "def-server.IndicesOptions.ignore_unavailable",
"type": "CompoundType",
"label": "ignore_unavailable",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 50
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IndicesOptions.allow_no_indices",
"type": "CompoundType",
"label": "allow_no_indices",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 51
},
"signature": [
"boolean | undefined"
]
},
{
"tags": [],
"id": "def-server.IndicesOptions.ignore_throttled",
"type": "CompoundType",
"label": "ignore_throttled",
"description": [],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 52
},
"signature": [
"boolean | undefined"
]
}
],
"source": {
"path": "x-pack/plugins/ml/common/types/anomaly_detection_jobs/datafeed.ts",
"lineNumber": 48
},
"initialIsOpen": false
},
{
"id": "def-server.Influencer",
"type": "Interface",
@ -5424,7 +5503,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/server/plugin.ts",
"lineNumber": 64
"lineNumber": 63
},
"signature": [
"JobServiceProvider",
@ -5448,7 +5527,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/ml/server/plugin.ts",
"lineNumber": 65
"lineNumber": 64
},
"signature": [
"void"
@ -5498,11 +5577,17 @@
"type": "Function",
"children": [
{
"type": "Any",
"type": "CompoundType",
"label": "error",
"isRequired": true,
"isRequired": false,
"signature": [
"any"
{
"pluginId": "ml",
"scope": "common",
"docId": "kibMlPluginApi",
"section": "def-common.ErrorType",
"text": "ErrorType"
}
],
"description": [],
"source": {
@ -5512,7 +5597,9 @@
}
],
"signature": [
"(error: any) => string"
"(error: ",
"ErrorType",
") => string"
],
"description": [],
"label": "extractErrorMessage",

24
api_docs/monitoring.json
View file

@ -27,7 +27,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 93
"lineNumber": 94
},
"signature": [
"() => any"
@ -41,7 +41,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 94
"lineNumber": 95
},
"signature": [
"() => void"
@ -55,10 +55,18 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 95
"lineNumber": 96
},
"signature": [
"() => void"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
") => void"
]
},
{
@ -69,7 +77,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 96
"lineNumber": 97
},
"signature": [
"() => void"
@ -78,7 +86,7 @@
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 92
"lineNumber": 93
},
"initialIsOpen": false
}
@ -134,7 +142,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 100
"lineNumber": 101
},
"signature": [
"() => any"
@ -143,7 +151,7 @@
],
"source": {
"path": "x-pack/plugins/monitoring/server/types.ts",
"lineNumber": 99
"lineNumber": 100
},
"lifecycle": "setup",
"initialIsOpen": true

55
api_docs/observability.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/presentation_util.json
View file

@ -154,7 +154,7 @@
"section": "def-public.OnSaveProps",
"text": "OnSaveProps"
},
" & { dashboardId: string | null; }) => void"
" & { dashboardId: string | null; addToLibrary: boolean; }) => void"
]
},
{

18
api_docs/reporting.json
View file

@ -1823,7 +1823,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 30
"lineNumber": 31
}
}
],
@ -1831,7 +1831,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 30
"lineNumber": 31
}
},
{
@ -1876,7 +1876,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 36
"lineNumber": 37
}
},
{
@ -1895,7 +1895,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 36
"lineNumber": 37
}
}
],
@ -1903,7 +1903,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 36
"lineNumber": 37
}
},
{
@ -1947,7 +1947,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 106
"lineNumber": 86
}
},
{
@ -1966,7 +1966,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 106
"lineNumber": 86
}
}
],
@ -1974,13 +1974,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 106
"lineNumber": 86
}
}
],
"source": {
"path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 24
"lineNumber": 25
},
"initialIsOpen": false
}

4
api_docs/saved_objects.json
View file

@ -777,7 +777,7 @@
"section": "def-public.SavedObject",
"text": "SavedObject"
},
", \"id\" | \"title\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">, isTitleDuplicateConfirmed: boolean, onTitleDuplicate: (() => void) | undefined, services: Pick<",
", \"title\" | \"id\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">, isTitleDuplicateConfirmed: boolean, onTitleDuplicate: (() => void) | undefined, services: Pick<",
"SavedObjectKibanaServices",
", \"savedObjectsClient\" | \"overlays\">) => Promise<true>"
],
@ -798,7 +798,7 @@
"section": "def-public.SavedObject",
"text": "SavedObject"
},
", \"id\" | \"title\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">"
", \"title\" | \"id\" | \"getDisplayName\" | \"lastSavedTitle\" | \"copyOnSave\" | \"getEsType\">"
],
"description": [],
"source": {

4
api_docs/saved_objects_management.json
View file

File diff suppressed because one or more lines are too long

2
api_docs/saved_objects_tagging.json
View file

@ -717,7 +717,7 @@
"lineNumber": 20
},
"signature": [
"Partial<Record<\"color\" | \"id\" | \"description\" | \"name\", string | undefined>>"
"Partial<Record<\"color\" | \"description\" | \"id\" | \"name\", string | undefined>>"
]
}
],

501
api_docs/security_solution.json
View file

@ -362,7 +362,7 @@
"label": "config",
"isRequired": true,
"signature": [
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; packagerTaskInterval: string; validateArtifactDownloads: boolean; }>"
"Readonly<{} & { enabled: boolean; signalsIndex: string; maxRuleImportExportSize: number; maxRuleImportPayloadBytes: number; maxTimelineImportExportSize: number; maxTimelineImportPayloadBytes: number; enableExperimental: string[]; endpointResultListDefaultFirstPageIndex: number; endpointResultListDefaultPageSize: number; alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; packagerTaskInterval: string; validateArtifactDownloads: boolean; }>"
],
"description": [],
"source": {
@ -451,7 +451,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 144
"lineNumber": 145
}
}
],
@ -459,7 +459,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 144
"lineNumber": 145
}
},
{
@ -536,7 +536,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 156
"lineNumber": 157
}
},
{
@ -555,7 +555,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 156
"lineNumber": 157
}
}
],
@ -563,7 +563,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 156
"lineNumber": 157
}
},
{
@ -607,7 +607,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 337
"lineNumber": 338
}
},
{
@ -626,7 +626,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 337
"lineNumber": 338
}
}
],
@ -634,7 +634,7 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 337
"lineNumber": 338
}
},
{
@ -650,13 +650,13 @@
"returnComment": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 398
"lineNumber": 404
}
}
],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 128
"lineNumber": 129
},
"initialIsOpen": false
}
@ -795,18 +795,17 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<{ path: string; method: \"PUT\"; body: unknown; }, boolean>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
@ -829,9 +828,15 @@
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<{ path: string; method: \"PUT\"; body: unknown; }, boolean>, index: string) => Promise<unknown>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", index: string) => Promise<unknown>"
],
"description": [],
"label": "createBootstrapIndex",
@ -848,25 +853,22 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<",
"IndicesDeleteParams",
", Promise<any>>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts",
"lineNumber": 12
"lineNumber": 11
}
},
{
@ -879,7 +881,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts",
"lineNumber": 13
"lineNumber": 12
}
},
{
@ -892,22 +894,26 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts",
"lineNumber": 14
"lineNumber": 13
}
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<",
"IndicesDeleteParams",
", Promise<any>>, pattern: string, maxAttempts?: number) => Promise<boolean>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", pattern: string, maxAttempts?: number) => Promise<boolean>"
],
"description": [],
"label": "deleteAllIndex",
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_all_index.ts",
"lineNumber": 11
"lineNumber": 10
},
"tags": [],
"returnComment": [],
@ -918,18 +924,17 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<{ path: string; method: \"DELETE\"; }, unknown>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
@ -952,9 +957,15 @@
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<{ path: string; method: \"DELETE\"; }, unknown>, policy: string) => Promise<unknown>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", policy: string) => Promise<unknown>"
],
"description": [],
"label": "deletePolicy",
@ -971,25 +982,22 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<",
"IndicesDeleteTemplateParams",
", unknown>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_template.ts",
"lineNumber": 12
"lineNumber": 10
}
},
{
@ -1002,22 +1010,26 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_template.ts",
"lineNumber": 13
"lineNumber": 11
}
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<",
"IndicesDeleteTemplateParams",
", unknown>, name: string) => Promise<unknown>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", name: string) => Promise<unknown>"
],
"description": [],
"label": "deleteTemplate",
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/delete_template.ts",
"lineNumber": 11
"lineNumber": 9
},
"tags": [],
"returnComment": [],
@ -1028,18 +1040,17 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<{ index: string; size: number; terminate_after: number; allow_no_indices: boolean; }, { _shards: { total: number; }; }>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
@ -1057,14 +1068,20 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_index_exists.ts",
"lineNumber": 15
"lineNumber": 12
}
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<{ index: string; size: number; terminate_after: number; allow_no_indices: boolean; }, { _shards: { total: number; }; }>, index: string) => Promise<boolean>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", index: string) => Promise<boolean>"
],
"description": [],
"label": "getIndexExists",
@ -1081,18 +1098,17 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<{ path: string; method: \"GET\"; }, unknown>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
@ -1115,9 +1131,15 @@
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<{ path: string; method: \"GET\"; }, unknown>, policy: string) => Promise<boolean>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", policy: string) => Promise<boolean>"
],
"description": [],
"label": "getPolicyExists",
@ -1134,25 +1156,22 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<",
"IndicesExistsTemplateParams",
", boolean>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_template_exists.ts",
"lineNumber": 12
"lineNumber": 11
}
},
{
@ -1165,22 +1184,26 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_template_exists.ts",
"lineNumber": 13
"lineNumber": 12
}
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<",
"IndicesExistsTemplateParams",
", boolean>, template: string) => Promise<boolean>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", template: string) => Promise<boolean>"
],
"description": [],
"label": "getTemplateExists",
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/get_template_exists.ts",
"lineNumber": 11
"lineNumber": 10
},
"tags": [],
"returnComment": [],
@ -1244,18 +1267,17 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<{ path: string; method: \"PUT\"; body: unknown; }, unknown>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
@ -1277,11 +1299,11 @@
}
},
{
"type": "Unknown",
"type": "Object",
"label": "body",
"isRequired": true,
"signature": [
"unknown"
"Record<string, unknown>"
],
"description": [],
"source": {
@ -1291,9 +1313,15 @@
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<{ path: string; method: \"PUT\"; body: unknown; }, unknown>, policy: string, body: unknown) => Promise<unknown>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", policy: string, body: Record<string, unknown>) => Promise<unknown>"
],
"description": [],
"label": "setPolicy",
@ -1310,25 +1338,22 @@
"type": "Function",
"children": [
{
"type": "Function",
"label": "callWithRequest",
"type": "CompoundType",
"label": "esClient",
"isRequired": true,
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.CallWithRequest",
"text": "CallWithRequest"
},
"<",
"IndicesPutTemplateParams",
", unknown>"
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
}
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts",
"lineNumber": 12
"lineNumber": 11
}
},
{
@ -1341,35 +1366,39 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts",
"lineNumber": 13
"lineNumber": 12
}
},
{
"type": "Unknown",
"type": "Object",
"label": "body",
"isRequired": true,
"signature": [
"unknown"
"Record<string, unknown>"
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts",
"lineNumber": 14
"lineNumber": 13
}
}
],
"signature": [
"(callWithRequest: ",
"CallWithRequest",
"<",
"IndicesPutTemplateParams",
", unknown>, name: string, body: unknown) => Promise<unknown>"
"(esClient: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCorePluginApi",
"section": "def-server.ElasticsearchClient",
"text": "ElasticsearchClient"
},
", name: string, body: Record<string, unknown>) => Promise<unknown>"
],
"description": [],
"label": "setTemplate",
"source": {
"path": "x-pack/plugins/security_solution/server/lib/detection_engine/index/set_template.ts",
"lineNumber": 11
"lineNumber": 10
},
"tags": [],
"returnComment": [],
@ -1463,10 +1492,10 @@
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/server/config.ts",
"lineNumber": 43
"lineNumber": 75
},
"signature": [
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; readonly packagerTaskInterval: string; readonly validateArtifactDownloads: boolean; }"
"{ readonly enabled: boolean; readonly signalsIndex: string; readonly maxRuleImportExportSize: number; readonly maxRuleImportPayloadBytes: number; readonly maxTimelineImportExportSize: number; readonly maxTimelineImportPayloadBytes: number; readonly enableExperimental: string[]; readonly endpointResultListDefaultFirstPageIndex: number; readonly endpointResultListDefaultPageSize: number; readonly alertResultListDefaultDateRange: Readonly<{} & { from: string; to: string; }>; readonly packagerTaskInterval: string; readonly validateArtifactDownloads: boolean; }"
],
"initialIsOpen": false
}
@ -1481,7 +1510,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 105
"lineNumber": 106
},
"lifecycle": "setup",
"initialIsOpen": true
@ -1495,7 +1524,7 @@
"children": [],
"source": {
"path": "x-pack/plugins/security_solution/server/plugin.ts",
"lineNumber": 107
"lineNumber": 108
},
"lifecycle": "start",
"initialIsOpen": true
@ -1725,162 +1754,6 @@
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.migratePackagePolicyToV7110",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packagePolicyDoc",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_11_0.ts",
"lineNumber": 13
}
}
],
"signature": [
"(packagePolicyDoc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"label": "migratePackagePolicyToV7110",
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_11_0.ts",
"lineNumber": 12
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.migratePackagePolicyToV7120",
"type": "Function",
"children": [
{
"type": "CompoundType",
"label": "packagePolicyDoc",
"isRequired": true,
"signature": [
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_12_0.ts",
"lineNumber": 14
}
}
],
"signature": [
"(packagePolicyDoc: ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">) => ",
{
"pluginId": "core",
"scope": "server",
"docId": "kibCoreSavedObjectsPluginApi",
"section": "def-server.SavedObjectUnsanitizedDoc",
"text": "SavedObjectUnsanitizedDoc"
},
"<",
{
"pluginId": "fleet",
"scope": "common",
"docId": "kibFleetPluginApi",
"section": "def-common.PackagePolicy",
"text": "PackagePolicy"
},
">"
],
"description": [],
"label": "migratePackagePolicyToV7120",
"source": {
"path": "x-pack/plugins/security_solution/common/endpoint/policy/migrations/to_v7_12_0.ts",
"lineNumber": 13
},
"tags": [],
"returnComment": [],
"initialIsOpen": false
},
{
"id": "def-common.removeExternalLinkText",
"type": "Function",

44
api_docs/telemetry_collection_xpack.json
View file

@ -41,6 +41,17 @@
"lineNumber": 13
}
},
{
"tags": [],
"id": "def-server.ESLicense.hkey",
"type": "string",
"label": "hkey",
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 14
}
},
{
"tags": [],
"id": "def-server.ESLicense.type",
@ -49,7 +60,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 14
"lineNumber": 15
}
},
{
@ -60,7 +71,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 15
"lineNumber": 16
}
},
{
@ -71,7 +82,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 16
"lineNumber": 17
}
},
{
@ -82,18 +93,18 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 17
"lineNumber": 18
}
},
{
"tags": [],
"id": "def-server.ESLicense.expirty_date_in_millis",
"id": "def-server.ESLicense.expiry_date_in_millis",
"type": "number",
"label": "expirty_date_in_millis",
"label": "expiry_date_in_millis",
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 18
"lineNumber": 19
}
},
{
@ -104,7 +115,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 19
"lineNumber": 20
}
},
{
@ -115,7 +126,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 20
"lineNumber": 21
}
},
{
@ -126,7 +137,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 21
"lineNumber": 22
}
},
{
@ -137,7 +148,18 @@
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 22
"lineNumber": 23
}
},
{
"tags": [],
"id": "def-server.ESLicense.max_resource_units",
"type": "number",
"label": "max_resource_units",
"description": [],
"source": {
"path": "x-pack/plugins/telemetry_collection_xpack/server/telemetry_collection/get_license.ts",
"lineNumber": 24
}
}
],

12
api_docs/triggers_actions_ui.json
View file

@ -746,8 +746,8 @@
"label": "http",
"description": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts",
"lineNumber": 13
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts",
"lineNumber": 29
},
"signature": [
{
@ -761,16 +761,16 @@
}
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts",
"lineNumber": 13
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts",
"lineNumber": 29
}
}
],
"tags": [],
"returnComment": [],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api.ts",
"lineNumber": 13
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/action_connector_api/connector_types.ts",
"lineNumber": 29
},
"initialIsOpen": false
},

2
api_docs/vis_type_timeseries.json
View file

@ -37,7 +37,7 @@
{
"pluginId": "data",
"scope": "server",
"docId": "kibDataSearchPluginApi",
"docId": "kibDataPluginApi",
"section": "def-server.DataRequestHandlerContext",
"text": "DataRequestHandlerContext"
},

8
api_docs/visualizations.json
View file

@ -514,7 +514,7 @@
"section": "def-common.VisParams",
"text": "VisParams"
},
">, \"type\" | \"id\" | \"description\" | \"title\" | \"params\" | \"uiState\"> & Pick<{ data: Partial<",
">, \"type\" | \"description\" | \"title\" | \"id\" | \"params\" | \"uiState\"> & Pick<{ data: Partial<",
{
"pluginId": "visualizations",
"scope": "public",
@ -530,7 +530,7 @@
"section": "def-public.SerializedVisData",
"text": "SerializedVisData"
},
">; }, never>, \"type\" | \"id\" | \"data\" | \"description\" | \"title\" | \"params\" | \"uiState\">) => Promise<void>"
">; }, never>, \"type\" | \"data\" | \"description\" | \"title\" | \"id\" | \"params\" | \"uiState\">) => Promise<void>"
],
"description": [],
"children": [
@ -555,7 +555,7 @@
"section": "def-common.VisParams",
"text": "VisParams"
},
">, \"type\" | \"id\" | \"description\" | \"title\" | \"params\" | \"uiState\"> & Pick<{ data: Partial<",
">, \"type\" | \"description\" | \"title\" | \"id\" | \"params\" | \"uiState\"> & Pick<{ data: Partial<",
{
"pluginId": "visualizations",
"scope": "public",
@ -571,7 +571,7 @@
"section": "def-public.SerializedVisData",
"text": "SerializedVisData"
},
">; }, never>, \"type\" | \"id\" | \"data\" | \"description\" | \"title\" | \"params\" | \"uiState\">"
">; }, never>, \"type\" | \"data\" | \"description\" | \"title\" | \"id\" | \"params\" | \"uiState\">"
],
"description": [],
"source": {