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

Ensure comments on parameters in arrow functions are captured in the docs and ci metrics. (#100823)

Browse source 
* Make sure arrow functions capture parameter comments.

* Update docs
This commit is contained in:
Stacey Gammon 2021-05-28 11:56:31 -04:00 • committed by GitHub
parent 7f6d7b3642
commit 8fba2d93a6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
30 changed files with 1981 additions and 1140 deletions
Download patch file Download diff file Expand all files Collapse all files

14
api_docs/apm.json
View file

@ -309,7 +309,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/apm/server/plugin.ts", "path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 270 "lineNumber": 269
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -331,7 +331,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/apm/server/plugin.ts", "path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 270 "lineNumber": 269
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -351,7 +351,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/apm/server/plugin.ts", "path": "x-pack/plugins/apm/server/plugin.ts",
"lineNumber": 289 "lineNumber": 288
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -653,7 +653,13 @@
"<unknown>>; delete: (deleteParams: { id: string; }) => Promise<", "<unknown>>; delete: (deleteParams: { id: string; }) => Promise<",
"DeleteResponse", "DeleteResponse",
">; } | undefined>; }; start: () => Promise<undefined>; }; ruleRegistry: { setup: ", ">; } | undefined>; }; start: () => Promise<undefined>; }; ruleRegistry: { setup: ",
"RuleDataPluginService", {
"pluginId": "ruleRegistry",
"scope": "server",
"docId": "kibRuleRegistryPluginApi",
"section": "def-server.RuleRegistryPluginSetupContract",
"text": "RuleRegistryPluginSetupContract"
},
"; start: () => Promise<void>; }; security?: { setup: ", "; start: () => Promise<void>; }; security?: { setup: ",
{ {
"pluginId": "security", "pluginId": "security",

8
api_docs/charts.json
View file

@ -179,7 +179,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "xValues", "label": "xValues",
"description": [], "description": [
"sorted and unquie x values"
],
"signature": [ "signature": [
"number[]" "number[]"
], ],
@ -417,7 +419,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "splitSeriesAccessorFnMap", "label": "splitSeriesAccessorFnMap",
"description": [], "description": [
"needed when using `splitSeriesAccessors` as `AccessorFn`"
],
"signature": [ "signature": [
"Map<React.ReactText, ", "Map<React.ReactText, ",
"AccessorFn", "AccessorFn",

56
api_docs/core.json
View file

@ -1770,7 +1770,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "src/core/public/doc_links/doc_links_service.ts", "path": "src/core/public/doc_links/doc_links_service.ts",
"lineNumber": 408 "lineNumber": 409
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1783,7 +1783,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "src/core/public/doc_links/doc_links_service.ts", "path": "src/core/public/doc_links/doc_links_service.ts",
"lineNumber": 409 "lineNumber": 410
}, },
"deprecated": false "deprecated": false
}, },
@ -1796,7 +1796,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "src/core/public/doc_links/doc_links_service.ts", "path": "src/core/public/doc_links/doc_links_service.ts",
"lineNumber": 410 "lineNumber": 411
}, },
"deprecated": false "deprecated": false
}, },
@ -1808,11 +1808,11 @@
"label": "links", "label": "links",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly canvas: { readonly guide: string; }; readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record<string, string>; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: { readonly overview: string; readonly mapping: string; }; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly search: { readonly sessions: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; }; readonly addData: string; readonly kibana: string; readonly upgradeAssistant: string; readonly elasticsearch: Record<string, string>; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly kueryQuerySyntax: string; readonly luceneQuerySyntax: string; readonly percolate: string; readonly queryDsl: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record<string, string>; readonly ml: Record<string, string>; readonly transforms: Record<string, string>; readonly visualize: Record<string, string>; readonly apis: Readonly<{ bulkIndexAlias: string; byteSizeUnits: string; createAutoFollowPattern: string; createFollower: string; createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createRollupJobsRequest: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putIndexTemplateV1: string; putWatch: string; simulatePipeline: string; timeUnits: string; updateTransform: string; }>; readonly observability: Record<string, string>; readonly alerting: Record<string, string>; readonly maps: Record<string, string>; readonly monitoring: Record<string, string>; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record<string, string>; readonly ccs: Record<string, string>; readonly plugins: Record<string, string>; readonly snapshotRestore: Record<string, string>; readonly ingest: Record<string, string>; }" "{ readonly canvas: { readonly guide: string; }; readonly dashboard: { readonly guide: string; readonly drilldowns: string; readonly drilldownsTriggerPicker: string; readonly urlDrilldownTemplateSyntax: string; readonly urlDrilldownVariables: string; }; readonly discover: Record<string, string>; readonly filebeat: { readonly base: string; readonly installation: string; readonly configuration: string; readonly elasticsearchOutput: string; readonly elasticsearchModule: string; readonly startup: string; readonly exportedFields: string; }; readonly auditbeat: { readonly base: string; }; readonly metricbeat: { readonly base: string; readonly configure: string; readonly httpEndpoint: string; readonly install: string; readonly start: string; }; readonly enterpriseSearch: { readonly base: string; readonly appSearchBase: string; readonly workplaceSearchBase: string; }; readonly heartbeat: { readonly base: string; }; readonly logstash: { readonly base: string; }; readonly functionbeat: { readonly base: string; }; readonly winlogbeat: { readonly base: string; }; readonly aggs: { readonly composite: string; readonly composite_missing_bucket: string; readonly date_histogram: string; readonly date_range: string; readonly date_format_pattern: string; readonly filter: string; readonly filters: string; readonly geohash_grid: string; readonly histogram: string; readonly ip_range: string; readonly range: string; readonly significant_terms: string; readonly terms: string; readonly avg: string; readonly avg_bucket: string; readonly max_bucket: string; readonly min_bucket: string; readonly sum_bucket: string; readonly cardinality: string; readonly count: string; readonly cumulative_sum: string; readonly derivative: string; readonly geo_bounds: string; readonly geo_centroid: string; readonly max: string; readonly median: string; readonly min: string; readonly moving_avg: string; readonly percentile_ranks: string; readonly serial_diff: string; readonly std_dev: string; readonly sum: string; readonly top_hits: string; }; readonly runtimeFields: { readonly overview: string; readonly mapping: string; }; readonly scriptedFields: { readonly scriptFields: string; readonly scriptAggs: string; readonly painless: string; readonly painlessApi: string; readonly painlessLangSpec: string; readonly painlessSyntax: string; readonly painlessWalkthrough: string; readonly luceneExpressions: string; }; readonly search: { readonly sessions: string; }; readonly indexPatterns: { readonly introduction: string; readonly fieldFormattersNumber: string; readonly fieldFormattersString: string; readonly runtimeFields: string; }; readonly addData: string; readonly kibana: string; readonly upgradeAssistant: string; readonly elasticsearch: Record<string, string>; readonly siem: { readonly guide: string; readonly gettingStarted: string; }; readonly query: { readonly eql: string; readonly kueryQuerySyntax: string; readonly luceneQuerySyntax: string; readonly percolate: string; readonly queryDsl: string; }; readonly date: { readonly dateMath: string; readonly dateMathIndexNames: string; }; readonly management: Record<string, string>; readonly ml: Record<string, string>; readonly transforms: Record<string, string>; readonly visualize: Record<string, string>; readonly apis: Readonly<{ bulkIndexAlias: string; byteSizeUnits: string; createAutoFollowPattern: string; createFollower: string; createIndex: string; createSnapshotLifecyclePolicy: string; createRoleMapping: string; createRoleMappingTemplates: string; createRollupJobsRequest: string; createApiKey: string; createPipeline: string; createTransformRequest: string; cronExpressions: string; executeWatchActionModes: string; indexExists: string; openIndex: string; putComponentTemplate: string; painlessExecute: string; painlessExecuteAPIContexts: string; putComponentTemplateMetadata: string; putSnapshotLifecyclePolicy: string; putIndexTemplateV1: string; putWatch: string; simulatePipeline: string; timeUnits: string; updateTransform: string; }>; readonly observability: Record<string, string>; readonly alerting: Record<string, string>; readonly maps: Record<string, string>; readonly monitoring: Record<string, string>; readonly security: Readonly<{ apiKeyServiceSettings: string; clusterPrivileges: string; elasticsearchSettings: string; elasticsearchEnableSecurity: string; indicesPrivileges: string; kibanaTLS: string; kibanaPrivileges: string; mappingRoles: string; mappingRolesFieldRules: string; runAsPrivilege: string; }>; readonly watcher: Record<string, string>; readonly ccs: Record<string, string>; readonly plugins: Record<string, string>; readonly snapshotRestore: Record<string, string>; readonly ingest: Record<string, string>; }"
], ],
"source": { "source": {
"path": "src/core/public/doc_links/doc_links_service.ts", "path": "src/core/public/doc_links/doc_links_service.ts",
"lineNumber": 411 "lineNumber": 412
}, },
"deprecated": false "deprecated": false
} }
@ -8748,7 +8748,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "endpoint", "label": "endpoint",
"description": [], "description": [
"- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`."
],
"signature": [ "signature": [
"string" "string"
], ],
@ -8765,7 +8767,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "clientParams", "label": "clientParams",
"description": [], "description": [
"- A dictionary of parameters that will be passed directly to the Elasticsearch JS client."
],
"signature": [ "signature": [
"Record<string, any>" "Record<string, any>"
], ],
@ -8782,7 +8786,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "options", "label": "options",
"description": [], "description": [
"- Options that affect the way we call the API and process the result."
],
"signature": [ "signature": [
{ {
"pluginId": "core", "pluginId": "core",
@ -10803,7 +10809,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 87 "lineNumber": 96
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -10824,7 +10830,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 100 "lineNumber": 109
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -10840,7 +10846,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 100 "lineNumber": 109
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -10857,7 +10863,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 100 "lineNumber": 109
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -10876,7 +10882,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 100 "lineNumber": 109
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -10901,7 +10907,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 116 "lineNumber": 125
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -10917,7 +10923,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 116 "lineNumber": 125
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -10934,7 +10940,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 116 "lineNumber": 125
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -10953,7 +10959,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 116 "lineNumber": 125
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -10978,7 +10984,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 129 "lineNumber": 138
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -10994,7 +11000,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 129 "lineNumber": 138
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -11013,7 +11019,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 129 "lineNumber": 138
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -11038,7 +11044,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 145 "lineNumber": 154
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -11054,7 +11060,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 145 "lineNumber": 154
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -11073,7 +11079,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 145 "lineNumber": 154
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -19544,7 +19550,7 @@
"The os platform" "The os platform"
], ],
"signature": [ "signature": [
"\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\"" "\"linux\" | \"aix\" | \"android\" | \"darwin\" | \"freebsd\" | \"openbsd\" | \"sunos\" | \"win32\" | \"cygwin\" | \"netbsd\""
], ],
"source": { "source": {
"path": "src/core/server/metrics/collectors/types.ts", "path": "src/core/server/metrics/collectors/types.ts",
@ -22315,7 +22321,7 @@
], ],
"source": { "source": {
"path": "node_modules/@kbn/config/target/deprecation/types.d.ts", "path": "node_modules/@kbn/config/target/deprecation/types.d.ts",
"lineNumber": 70 "lineNumber": 79
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false

20
api_docs/core_application.json
View file

@ -115,7 +115,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "basePath", "label": "basePath",
"description": [], "description": [
"the URL path scope for the sub history"
],
"signature": [ "signature": [
"string" "string"
], ],
@ -207,7 +209,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "pathOrLocation", "label": "pathOrLocation",
"description": [], "description": [
"a string or location descriptor"
],
"signature": [ "signature": [
"string | ", "string | ",
"LocationDescriptorObject", "LocationDescriptorObject",
@ -266,7 +270,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "pathOrLocation", "label": "pathOrLocation",
"description": [], "description": [
"a string or location descriptor"
],
"signature": [ "signature": [
"string | ", "string | ",
"LocationDescriptorObject", "LocationDescriptorObject",
@ -323,7 +329,9 @@
"type": "number", "type": "number",
"tags": [], "tags": [],
"label": "n", "label": "n",
"description": [], "description": [
"number of positions in the stack to go. Negative numbers indicate number of entries backward, positive\nnumbers for forwards. If passed 0, the current location will be reloaded. If `n` exceeds the number of\nentries available, this is a no-op."
],
"signature": [ "signature": [
"number" "number"
], ],
@ -449,7 +457,9 @@
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "listener", "label": "listener",
"description": [], "description": [
"a function that receives location updates."
],
"signature": [ "signature": [
"(location: ", "(location: ",
"Location", "Location",

16
api_docs/core_saved_objects.json
View file

@ -161,7 +161,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "objects", "label": "objects",
"description": [], "description": [
"- [{ type, id, attributes, references, migrationVersion }]"
],
"signature": [ "signature": [
{ {
"pluginId": "core", "pluginId": "core",
@ -451,7 +453,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "objects", "label": "objects",
"description": [], "description": [
"- an array ids, or an array of objects containing id and optionally type"
],
"signature": [ "signature": [
"{ id: string; type: string; }[]" "{ id: string; type: string; }[]"
], ],
@ -9362,7 +9366,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "namespace", "label": "namespace",
"description": [], "description": [
"The namespace ID, which must be either a non-empty string or `undefined`."
],
"signature": [ "signature": [
"string | undefined" "string | undefined"
], ],
@ -9400,7 +9406,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "namespace", "label": "namespace",
"description": [], "description": [
"The namespace string, which must be non-empty."
],
"signature": [ "signature": [
"string" "string"
], ],

550
api_docs/data.json
View file

File diff suppressed because it is too large Load diff

20
api_docs/data_field_formats.json
View file

@ -1687,7 +1687,9 @@
"type": "Enum", "type": "Enum",
"tags": [], "tags": [],
"label": "fieldType", "label": "fieldType",
"description": [], "description": [
"- the field type"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -1710,7 +1712,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "esTypes", "label": "esTypes",
"description": [], "description": [
"- Array of ES data types"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -1759,7 +1763,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "formatId", "label": "formatId",
"description": [], "description": [
"- the format id"
],
"signature": [ "signature": [
"string" "string"
], ],
@ -1878,7 +1884,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "esTypes", "label": "esTypes",
"description": [], "description": [
"- Array of ES data types"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -1941,7 +1949,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "esTypes", "label": "esTypes",
"description": [], "description": [
"- Array of ES data types"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",

168
api_docs/data_index_patterns.json
View file

@ -3291,7 +3291,9 @@
"type": "boolean", "type": "boolean",
"tags": [], "tags": [],
"label": "refresh", "label": "refresh",
"description": [], "description": [
"Force refresh of index pattern list"
],
"signature": [ "signature": [
"boolean" "boolean"
], ],
@ -3329,7 +3331,9 @@
"type": "boolean", "type": "boolean",
"tags": [], "tags": [],
"label": "refresh", "label": "refresh",
"description": [], "description": [
"Force refresh of index pattern list"
],
"signature": [ "signature": [
"boolean" "boolean"
], ],
@ -3432,7 +3436,9 @@
"type": "boolean", "type": "boolean",
"tags": [], "tags": [],
"label": "refresh", "label": "refresh",
"description": [], "description": [
"Force refresh of index pattern list"
],
"signature": [ "signature": [
"boolean" "boolean"
], ],
@ -3470,7 +3476,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "id", "label": "id",
"description": [], "description": [
"optionally clear a single id"
],
"signature": [ "signature": [
"string | undefined" "string | undefined"
], ],
@ -3534,6 +3542,26 @@
"children": [], "children": [],
"returnComment": [] "returnComment": []
}, },
{
"parentPluginId": "data",
"id": "def-common.IndexPatternsService.getDefaultId",
"type": "Function",
"tags": [],
"label": "getDefaultId",
"description": [
"\nGet default index pattern id"
],
"signature": [
"() => Promise<string | null>"
],
"source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 206
},
"deprecated": false,
"children": [],
"returnComment": []
},
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-common.IndexPatternsService.setDefault", "id": "def-common.IndexPatternsService.setDefault",
@ -3544,30 +3572,30 @@
"\nOptionally set default index pattern, unless force = true" "\nOptionally set default index pattern, unless force = true"
], ],
"signature": [ "signature": [
"(id: string, force?: boolean) => Promise<void>" "(id: string | null, force?: boolean) => Promise<void>"
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208 "lineNumber": 216
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
{ {
"parentPluginId": "data", "parentPluginId": "data",
"id": "def-common.IndexPatternsService.setDefault.$1", "id": "def-common.IndexPatternsService.setDefault.$1",
"type": "string", "type": "CompoundType",
"tags": [], "tags": [],
"label": "id", "label": "id",
"description": [], "description": [],
"signature": [ "signature": [
"string" "string | null"
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208 "lineNumber": 216
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": false
}, },
{ {
"parentPluginId": "data", "parentPluginId": "data",
@ -3581,7 +3609,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 208 "lineNumber": 216
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3611,7 +3639,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219 "lineNumber": 227
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3633,7 +3661,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 219 "lineNumber": 227
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3681,7 +3709,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 235 "lineNumber": 243
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3711,7 +3739,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 236 "lineNumber": 244
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3735,7 +3763,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 237 "lineNumber": 245
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -3767,7 +3795,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250 "lineNumber": 258
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3789,7 +3817,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 250 "lineNumber": 258
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3835,7 +3863,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327 "lineNumber": 335
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3845,7 +3873,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "fields", "label": "fields",
"description": [], "description": [
": FieldSpec[]"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -3858,7 +3888,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327 "lineNumber": 335
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3869,7 +3899,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "fieldAttrs", "label": "fieldAttrs",
"description": [], "description": [
": FieldAttrs"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -3882,7 +3914,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 327 "lineNumber": 335
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -3923,7 +3955,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343 "lineNumber": 351
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3948,7 +3980,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 343 "lineNumber": 351
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3980,7 +4012,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465 "lineNumber": 473
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3996,7 +4028,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 465 "lineNumber": 473
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4034,7 +4066,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484 "lineNumber": 492
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -4056,7 +4088,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484 "lineNumber": 492
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4073,7 +4105,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 484 "lineNumber": 492
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4113,7 +4145,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509 "lineNumber": 517
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -4135,7 +4167,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509 "lineNumber": 517
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4154,7 +4186,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509 "lineNumber": 517
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4173,7 +4205,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 509 "lineNumber": 517
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4211,7 +4243,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522 "lineNumber": 530
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -4233,7 +4265,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522 "lineNumber": 530
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4252,7 +4284,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 522 "lineNumber": 530
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4282,7 +4314,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 550 "lineNumber": 558
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -4304,7 +4336,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 551 "lineNumber": 559
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4321,7 +4353,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 552 "lineNumber": 560
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4338,7 +4370,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 553 "lineNumber": 561
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -4360,7 +4392,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636 "lineNumber": 644
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -4378,7 +4410,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 636 "lineNumber": 644
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -5513,20 +5545,6 @@
"lineNumber": 58 "lineNumber": 58
} }
}, },
{
"plugin": "maps",
"link": {
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts",
"lineNumber": 10
}
},
{
"plugin": "maps",
"link": {
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts",
"lineNumber": 360
}
},
{ {
"plugin": "maps", "plugin": "maps",
"link": { "link": {
@ -5541,6 +5559,20 @@
"lineNumber": 45 "lineNumber": 45
} }
}, },
{
"plugin": "maps",
"link": {
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts",
"lineNumber": 10
}
},
{
"plugin": "maps",
"link": {
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts",
"lineNumber": 367
}
},
{ {
"plugin": "maps", "plugin": "maps",
"link": { "link": {
@ -8911,14 +8943,7 @@
"plugin": "securitySolution", "plugin": "securitySolution",
"link": { "link": {
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts", "path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts",
"lineNumber": 40 "lineNumber": 44
}
},
{
"plugin": "securitySolution",
"link": {
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts",
"lineNumber": 55
} }
}, },
{ {
@ -8928,6 +8953,13 @@
"lineNumber": 60 "lineNumber": 60
} }
}, },
{
"plugin": "securitySolution",
"link": {
"path": "x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts",
"lineNumber": 65
}
},
{ {
"plugin": "securitySolution", "plugin": "securitySolution",
"link": { "link": {
@ -9940,7 +9972,7 @@
"plugin": "maps", "plugin": "maps",
"link": { "link": {
"path": "x-pack/plugins/maps/public/embeddable/types.ts", "path": "x-pack/plugins/maps/public/embeddable/types.ts",
"lineNumber": 44 "lineNumber": 45
} }
}, },
{ {
@ -12499,7 +12531,7 @@
"section": "def-common.IndexPattern", "section": "def-common.IndexPattern",
"text": "IndexPattern" "text": "IndexPattern"
}, },
" | null>; setDefault: (id: string, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: ", " | null>; getDefaultId: () => Promise<string | null>; setDefault: (id: string | null, force?: boolean) => Promise<void>; getFieldsForWildcard: (options: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -12625,7 +12657,7 @@
], ],
"source": { "source": {
"path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts", "path": "src/plugins/data/common/index_patterns/index_patterns/index_patterns.ts",
"lineNumber": 642 "lineNumber": 650
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false

40
api_docs/data_query.json
View file

@ -1056,7 +1056,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "stateContainer", "label": "stateContainer",
"description": [], "description": [
"to use for syncing"
],
"signature": [ "signature": [
{ {
"pluginId": "kibanaUtils", "pluginId": "kibanaUtils",
@ -1547,7 +1549,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "kbnUrlStateStorage", "label": "kbnUrlStateStorage",
"description": [], "description": [
"to use for syncing"
],
"signature": [ "signature": [
{ {
"pluginId": "kibanaUtils", "pluginId": "kibanaUtils",
@ -2563,7 +2567,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "first", "label": "first",
"description": [], "description": [
"The first filter or filter array to compare"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -2595,7 +2601,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "second", "label": "second",
"description": [], "description": [
"The second filter or filter array to compare"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -2627,7 +2635,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "comparatorOptions", "label": "comparatorOptions",
"description": [], "description": [
"Parameters to use for comparison"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -2706,7 +2716,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "existingFilters", "label": "existingFilters",
"description": [], "description": [
"- The filters to compare to"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -2730,7 +2742,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "filters", "label": "filters",
"description": [], "description": [
"- The filters being added"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -2754,7 +2768,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "comparatorOptions", "label": "comparatorOptions",
"description": [], "description": [
"- Parameters to use for comparison"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -3132,7 +3148,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "filters", "label": "filters",
"description": [], "description": [
"The filters to remove duplicates from"
],
"signature": [ "signature": [
{ {
"pluginId": "data", "pluginId": "data",
@ -3156,7 +3174,9 @@
"type": "Any", "type": "Any",
"tags": [], "tags": [],
"label": "comparatorOptions", "label": "comparatorOptions",
"description": [], "description": [
"- Parameters to use for comparison"
],
"signature": [ "signature": [
"any" "any"
], ],

14
api_docs/data_search.json
View file

@ -10230,7 +10230,7 @@
"plugin": "maps", "plugin": "maps",
"link": { "link": {
"path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts", "path": "x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts",
"lineNumber": 266 "lineNumber": 273
} }
}, },
{ {
@ -10506,7 +10506,7 @@
"section": "def-common.IndexPatternsService", "section": "def-common.IndexPatternsService",
"text": "IndexPatternsService" "text": "IndexPatternsService"
}, },
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ", ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, dependencies: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -10562,7 +10562,7 @@
"section": "def-common.IndexPatternsService", "section": "def-common.IndexPatternsService",
"text": "IndexPatternsService" "text": "IndexPatternsService"
}, },
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"
], ],
"source": { "source": {
"path": "src/plugins/data/common/search/search_source/search_source_service.ts", "path": "src/plugins/data/common/search/search_source/search_source_service.ts",
@ -11620,7 +11620,7 @@
"section": "def-common.IndexPatternsService", "section": "def-common.IndexPatternsService",
"text": "IndexPatternsService" "text": "IndexPatternsService"
}, },
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ", ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">, searchSourceDependencies: ",
{ {
"pluginId": "data", "pluginId": "data",
"scope": "common", "scope": "common",
@ -11658,7 +11658,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "indexPatterns", "label": "indexPatterns",
"description": [], "description": [
"The index patterns contract of the data plugin"
],
"signature": [ "signature": [
"Pick<", "Pick<",
{ {
@ -11668,7 +11670,7 @@
"section": "def-common.IndexPatternsService", "section": "def-common.IndexPatternsService",
"text": "IndexPatternsService" "text": "IndexPatternsService"
}, },
", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">" ", \"get\" | \"delete\" | \"create\" | \"find\" | \"ensureDefaultIndexPattern\" | \"getIds\" | \"getTitles\" | \"getIdsWithTitle\" | \"clearCache\" | \"getCache\" | \"getDefault\" | \"getDefaultId\" | \"setDefault\" | \"getFieldsForWildcard\" | \"getFieldsForIndexPattern\" | \"refreshFields\" | \"fieldArrayToMap\" | \"savedObjectToSpec\" | \"createAndSave\" | \"createSavedObject\" | \"updateSavedObject\">"
], ],
"source": { "source": {
"path": "src/plugins/data/common/search/search_source/create_search_source.ts", "path": "src/plugins/data/common/search/search_source/create_search_source.ts",

24
api_docs/deprecations.mdx
View file

@ -946,11 +946,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| Deprecated API | Reference location | Remove By | | Deprecated API | Reference location | Remove By |
| ---------------|-----------|-----------| | ---------------|-----------|-----------|
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L8) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L44) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L45) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_source.ts#L360](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L360) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_source.ts#L367](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L367) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L8) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L15) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L15) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L49) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L49) | - |
@ -1041,10 +1041,10 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [create_source_editor.tsx#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/create_source_editor.tsx#L35) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [create_source_editor.tsx#L35](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/top_hits/create_source_editor.tsx#L35) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L10) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_source.ts#L360](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L360) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [es_source.ts#L367](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L367) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L8) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L15) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L15) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L49) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L49) | - |
@ -1136,11 +1136,11 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L10) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-common.IFieldType" text="IFieldType"/> | [get_docvalue_source_fields.test.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_search_source/get_docvalue_source_fields.test.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L8) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L44) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#L45) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_source.ts#L360](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L360) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - | | <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_doc_field.ts#L45](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#L45) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_source.ts#L10](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L10) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_source.ts#L367](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/sources/es_source/es_source.ts#L367) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L8) | - | | <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L15) | - | | <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L15) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L49) | - | | <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index_pattern_util.ts#L49](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#L49) | - |
@ -1612,9 +1612,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/details/types.ts#L41) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/details/types.ts#L41) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L12) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L34) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L34) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L40) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L44) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L55) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L60) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L60) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L65) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L28) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L28) | - |
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx#L15) | - | | <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx#L15) | - |
@ -1824,9 +1824,9 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/details/types.ts#L41) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L41](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/pages/details/types.ts#L41) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L12) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L34) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L34](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/network/components/network_top_countries_table/index.tsx#L34) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L40](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L40) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L44](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L44) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L55](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L55) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L60) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L60](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L60) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [middleware.ts#L65](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/management/pages/endpoint_hosts/store/middleware.ts#L65) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L12) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L12](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L12) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L28) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts#L28](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/types.ts#L28) | - |
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx#L15) | - | | <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [index.tsx#L15](https://github.com/elastic/kibana/tree/master/x-pack/plugins/security_solution/public/detections/components/rules/description_step/index.tsx#L15) | - |

8
api_docs/embeddable.json
View file

@ -3847,7 +3847,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "appId", "label": "appId",
"description": [], "description": [
"- The id of the app to fetch the title for"
],
"signature": [ "signature": [
"string" "string"
], ],
@ -4716,7 +4718,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "props", "label": "props",
"description": [], "description": [
"- {@link EmbeddableRendererProps}"
],
"signature": [ "signature": [
{ {
"pluginId": "embeddable", "pluginId": "embeddable",

48
api_docs/expressions.json
View file

@ -4875,7 +4875,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to extract references from"
],
"signature": [ "signature": [
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -4954,7 +4956,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to extract references from"
],
"signature": [ "signature": [
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -5017,7 +5021,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to update"
],
"signature": [ "signature": [
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -5040,7 +5046,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "references", "label": "references",
"description": [], "description": [
"array of saved object references"
],
"signature": [ "signature": [
"SavedObjectReference", "SavedObjectReference",
"[]" "[]"
@ -5096,7 +5104,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to update"
],
"signature": [ "signature": [
{ {
"pluginId": "kibanaUtils", "pluginId": "kibanaUtils",
@ -5119,7 +5129,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "version", "label": "version",
"description": [], "description": [
"defines which migration version to run"
],
"signature": [ "signature": [
"string" "string"
], ],
@ -25765,7 +25777,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to extract references from"
],
"signature": [ "signature": [
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -25844,7 +25858,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to extract references from"
],
"signature": [ "signature": [
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -25907,7 +25923,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to update"
],
"signature": [ "signature": [
{ {
"pluginId": "expressions", "pluginId": "expressions",
@ -25930,7 +25948,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "references", "label": "references",
"description": [], "description": [
"array of saved object references"
],
"signature": [ "signature": [
"SavedObjectReference", "SavedObjectReference",
"[]" "[]"
@ -25986,7 +26006,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "state", "label": "state",
"description": [], "description": [
"expression AST to update"
],
"signature": [ "signature": [
{ {
"pluginId": "kibanaUtils", "pluginId": "kibanaUtils",
@ -26009,7 +26031,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "version", "label": "version",
"description": [], "description": [
"defines which migration version to run"
],
"signature": [ "signature": [
"string" "string"
], ],

1044
api_docs/fleet.json
View file

File diff suppressed because it is too large Load diff

6
api_docs/home.json
View file

@ -1070,7 +1070,7 @@
}, },
") => void; getSampleDatasets: () => ", ") => void; getSampleDatasets: () => ",
"Writable", "Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", "<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject", "SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", "<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
"SampleDatasetDashboardPanel", "SampleDatasetDashboardPanel",
@ -1093,7 +1093,7 @@
"signature": [ "signature": [
"() => ", "() => ",
"Writable", "Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>" "<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>"
], ],
"source": { "source": {
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts", "path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
@ -1426,7 +1426,7 @@
}, },
") => void; getSampleDatasets: () => ", ") => void; getSampleDatasets: () => ",
"Writable", "Writable",
"<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; defaultIndex: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ", "<Readonly<{ status?: string | undefined; darkPreviewImagePath?: string | undefined; statusMsg?: string | undefined; } & { description: string; id: string; name: string; savedObjects: Readonly<{ version?: any; attributes?: any; } & { type: string; id: string; references: any[]; }>[]; previewImagePath: string; overviewDashboard: string; appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]; defaultIndex: string; dataIndices: Readonly<{} & { id: string; fields: Record<string, any>; timeFields: string[]; dataPath: string; currentTimeMarker: string; preserveDayOfWeekTimeOfDay: boolean; }>[]; }>>[]; addSavedObjectsToSampleDataset: (id: string, savedObjects: ",
"SavedObject", "SavedObject",
"<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ", "<unknown>[]) => void; addAppLinksToSampleDataset: (id: string, appLinks: Readonly<{} & { label: string; path: string; icon: string; }>[]) => void; replacePanelInSampleDatasetDashboard: ({ sampleDataId, dashboardId, oldEmbeddableId, embeddableId, embeddableType, embeddableConfig, }: ",
"SampleDatasetDashboardPanel", "SampleDatasetDashboardPanel",

30
api_docs/kibana_react.json
View file

File diff suppressed because one or more lines are too long

48
api_docs/kibana_utils.json
View file

@ -2551,7 +2551,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "storage", "label": "storage",
"description": [], "description": [
"- Option {@link Storage} to use for storing state. By default window.sessionStorage."
],
"signature": [ "signature": [
"Storage" "Storage"
], ],
@ -2616,7 +2618,9 @@
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "accessor", "label": "accessor",
"description": [], "description": [
"Asynchronous start service accessor provided by platform."
],
"signature": [ "signature": [
{ {
"pluginId": "core", "pluginId": "core",
@ -3623,7 +3627,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "promise", "label": "promise",
"description": [], "description": [
"Promise to convert to 3-tuple."
],
"signature": [ "signature": [
"Promise<T>" "Promise<T>"
], ],
@ -4687,7 +4693,9 @@
"type": "Uncategorized", "type": "Uncategorized",
"tags": [], "tags": [],
"label": "container", "label": "container",
"description": [], "description": [
"- {@link StateContainer} which state to track."
],
"signature": [ "signature": [
"Container" "Container"
], ],
@ -4704,7 +4712,9 @@
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "selector", "label": "selector",
"description": [], "description": [
"- Function used to pick parts of state."
],
"signature": [ "signature": [
"(state: ", "(state: ",
{ {
@ -4729,7 +4739,9 @@
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "comparator", "label": "comparator",
"description": [], "description": [
"- {@link Comparator} function used to memoize previous result, to not\nre-render React component if state did not change. By default uses\n`fast-deep-equal` package."
],
"signature": [ "signature": [
{ {
"pluginId": "kibanaUtils", "pluginId": "kibanaUtils",
@ -4793,7 +4805,9 @@
"type": "Uncategorized", "type": "Uncategorized",
"tags": [], "tags": [],
"label": "container", "label": "container",
"description": [], "description": [
"- {@link StateContainer} which state to track."
],
"signature": [ "signature": [
"Container" "Container"
], ],
@ -10006,7 +10020,9 @@
"type": "Object", "type": "Object",
"tags": [], "tags": [],
"label": "promise", "label": "promise",
"description": [], "description": [
"Promise to convert to 3-tuple."
],
"signature": [ "signature": [
"Promise<T>" "Promise<T>"
], ],
@ -10069,7 +10085,9 @@
"type": "Uncategorized", "type": "Uncategorized",
"tags": [], "tags": [],
"label": "container", "label": "container",
"description": [], "description": [
"- {@link StateContainer} which state to track."
],
"signature": [ "signature": [
"Container" "Container"
], ],
@ -10086,7 +10104,9 @@
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "selector", "label": "selector",
"description": [], "description": [
"- Function used to pick parts of state."
],
"signature": [ "signature": [
"(state: ", "(state: ",
{ {
@ -10111,7 +10131,9 @@
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "comparator", "label": "comparator",
"description": [], "description": [
"- {@link Comparator} function used to memoize previous result, to not\nre-render React component if state did not change. By default uses\n`fast-deep-equal` package."
],
"signature": [ "signature": [
{ {
"pluginId": "kibanaUtils", "pluginId": "kibanaUtils",
@ -10175,7 +10197,9 @@
"type": "Uncategorized", "type": "Uncategorized",
"tags": [], "tags": [],
"label": "container", "label": "container",
"description": [], "description": [
"- {@link StateContainer} which state to track."
],
"signature": [ "signature": [
"Container" "Container"
], ],

52
api_docs/lens.json
View file

@ -1353,7 +1353,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 473 "lineNumber": 474
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1369,7 +1369,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 474 "lineNumber": 475
}, },
"deprecated": false "deprecated": false
}, },
@ -1391,7 +1391,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 475 "lineNumber": 476
}, },
"deprecated": false "deprecated": false
}, },
@ -1407,7 +1407,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 476 "lineNumber": 477
}, },
"deprecated": false "deprecated": false
}, },
@ -1423,7 +1423,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 477 "lineNumber": 478
}, },
"deprecated": false "deprecated": false
}, },
@ -1440,7 +1440,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 478 "lineNumber": 479
}, },
"deprecated": false "deprecated": false
}, },
@ -1457,7 +1457,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 479 "lineNumber": 480
}, },
"deprecated": false "deprecated": false
}, },
@ -1480,7 +1480,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 480 "lineNumber": 481
}, },
"deprecated": false "deprecated": false
}, },
@ -1496,7 +1496,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 481 "lineNumber": 482
}, },
"deprecated": false "deprecated": false
}, },
@ -1512,7 +1512,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 482 "lineNumber": 483
}, },
"deprecated": false "deprecated": false
}, },
@ -1528,7 +1528,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 483 "lineNumber": 484
}, },
"deprecated": false "deprecated": false
}, },
@ -1551,7 +1551,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 484 "lineNumber": 485
}, },
"deprecated": false "deprecated": false
}, },
@ -1574,7 +1574,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 485 "lineNumber": 486
}, },
"deprecated": false "deprecated": false
}, },
@ -1597,7 +1597,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 486 "lineNumber": 487
}, },
"deprecated": false "deprecated": false
}, },
@ -1613,7 +1613,23 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 487 "lineNumber": 488
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-public.XYState.fillOpacity",
"type": "number",
"tags": [],
"label": "fillOpacity",
"description": [],
"signature": [
"number | undefined"
],
"source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 489
}, },
"deprecated": false "deprecated": false
}, },
@ -1629,7 +1645,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 488 "lineNumber": 490
}, },
"deprecated": false "deprecated": false
} }
@ -2093,7 +2109,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts", "path": "x-pack/plugins/lens/public/indexpattern_datasource/operations/definitions/index.ts",
"lineNumber": 497 "lineNumber": 498
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -2280,7 +2296,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/lens/public/xy_visualization/types.ts", "path": "x-pack/plugins/lens/public/xy_visualization/types.ts",
"lineNumber": 470 "lineNumber": 471
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false

2
api_docs/licensing.json
View file

@ -3088,7 +3088,7 @@
"plugin": "reporting", "plugin": "reporting",
"link": { "link": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 228 "lineNumber": 226
} }
}, },
{ {

380
api_docs/maps.json
View file

File diff suppressed because it is too large Load diff

84
api_docs/observability.json
View file

@ -170,7 +170,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/components/shared/index.tsx", "path": "x-pack/plugins/observability/public/components/shared/index.tsx",
"lineNumber": 34 "lineNumber": 36
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -186,7 +186,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/components/shared/index.tsx", "path": "x-pack/plugins/observability/public/components/shared/index.tsx",
"lineNumber": 34 "lineNumber": 36
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -283,7 +283,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/components/shared/index.tsx", "path": "x-pack/plugins/observability/public/components/shared/index.tsx",
"lineNumber": 14 "lineNumber": 16
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -299,7 +299,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/components/shared/index.tsx", "path": "x-pack/plugins/observability/public/components/shared/index.tsx",
"lineNumber": 14 "lineNumber": 16
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -322,7 +322,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/components/shared/index.tsx", "path": "x-pack/plugins/observability/public/components/shared/index.tsx",
"lineNumber": 24 "lineNumber": 26
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -338,7 +338,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/components/shared/index.tsx", "path": "x-pack/plugins/observability/public/components/shared/index.tsx",
"lineNumber": 24 "lineNumber": 26
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1050,7 +1050,7 @@
"label": "unsafe", "label": "unsafe",
"description": [], "description": [],
"signature": [ "signature": [
"{ alertingExperience: { enabled: boolean; }; }" "{ alertingExperience: { enabled: boolean; }; cases: { enabled: boolean; }; }"
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/index.ts", "path": "x-pack/plugins/observability/public/index.ts",
@ -2040,7 +2040,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 40 "lineNumber": 42
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -2062,7 +2062,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 41 "lineNumber": 43
}, },
"deprecated": false "deprecated": false
}, },
@ -2084,7 +2084,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 42 "lineNumber": 44
}, },
"deprecated": false "deprecated": false
}, },
@ -2107,7 +2107,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 43 "lineNumber": 45
}, },
"deprecated": false "deprecated": false
} }
@ -2123,7 +2123,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 46 "lineNumber": 48
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -2146,7 +2146,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 47 "lineNumber": 49
}, },
"deprecated": false "deprecated": false
}, },
@ -2168,7 +2168,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 48 "lineNumber": 50
}, },
"deprecated": false "deprecated": false
}, },
@ -2190,7 +2190,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 49 "lineNumber": 51
}, },
"deprecated": false "deprecated": false
}, },
@ -2212,7 +2212,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 50 "lineNumber": 52
}, },
"deprecated": false "deprecated": false
} }
@ -2838,7 +2838,7 @@
"METRIC_TYPE" "METRIC_TYPE"
], ],
"source": { "source": {
"path": "node_modules/@kbn/analytics/target/types/metrics/index.d.ts", "path": "node_modules/@kbn/analytics/target_types/metrics/index.d.ts",
"lineNumber": 10 "lineNumber": 10
}, },
"deprecated": false, "deprecated": false,
@ -3142,11 +3142,15 @@
"section": "def-public.AlertTypeModel", "section": "def-public.AlertTypeModel",
"text": "AlertTypeModel" "text": "AlertTypeModel"
}, },
"<any> & { format: Formatter; }) => void; getFormatter: (typeId: string) => Formatter | undefined; }; isAlertingExperienceEnabled: () => boolean; }" "<any> & { format: Formatter; }) => void; getFormatter: (typeId: string) => Formatter | undefined; }; isAlertingExperienceEnabled: () => boolean; navigation: { registerSections: (sections$: ",
"Observable",
"<",
"NavigationSection",
"[]>) => void; }; }"
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 38 "lineNumber": 40
}, },
"deprecated": false, "deprecated": false,
"lifecycle": "setup", "lifecycle": "setup",
@ -3160,11 +3164,13 @@
"label": "ObservabilityPublicStart", "label": "ObservabilityPublicStart",
"description": [], "description": [],
"signature": [ "signature": [
"void" "{ navigation: { PageTemplate: (pageTemplateProps: ",
"WrappedPageTemplateProps",
") => JSX.Element; }; }"
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/public/plugin.ts", "path": "x-pack/plugins/observability/public/plugin.ts",
"lineNumber": 53 "lineNumber": 55
}, },
"deprecated": false, "deprecated": false,
"lifecycle": "start", "lifecycle": "start",
@ -3431,7 +3437,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/utils/queries.ts", "path": "x-pack/plugins/observability/server/utils/queries.ts",
"lineNumber": 25 "lineNumber": 35
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3447,7 +3453,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/utils/queries.ts", "path": "x-pack/plugins/observability/server/utils/queries.ts",
"lineNumber": 25 "lineNumber": 35
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -3470,7 +3476,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/utils/queries.ts", "path": "x-pack/plugins/observability/server/utils/queries.ts",
"lineNumber": 11 "lineNumber": 21
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3486,7 +3492,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/utils/queries.ts", "path": "x-pack/plugins/observability/server/utils/queries.ts",
"lineNumber": 11 "lineNumber": 21
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -3503,7 +3509,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/utils/queries.ts", "path": "x-pack/plugins/observability/server/utils/queries.ts",
"lineNumber": 11 "lineNumber": 21
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -3520,7 +3526,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/utils/queries.ts", "path": "x-pack/plugins/observability/server/utils/queries.ts",
"lineNumber": 11 "lineNumber": 21
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -3861,7 +3867,15 @@
"Type", "Type",
"<number, string, unknown>; end: ", "<number, string, unknown>; end: ",
"Type", "Type",
"<number, string, unknown>; }>, ", "<number, string, unknown>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"all\">, ",
"LiteralC",
"<\"open\">, ",
"LiteralC",
"<\"closed\">]>; }>, ",
"PartialC", "PartialC",
"<{ kuery: ", "<{ kuery: ",
"StringC", "StringC",
@ -3928,11 +3942,11 @@
"label": "ObservabilityConfig", "label": "ObservabilityConfig",
"description": [], "description": [],
"signature": [ "signature": [
"{ readonly enabled: boolean; readonly annotations: Readonly<{} & { enabled: boolean; index: string; }>; readonly unsafe: Readonly<{} & { alertingExperience: Readonly<{} & { enabled: boolean; }>; }>; }" "{ readonly enabled: boolean; readonly annotations: Readonly<{} & { enabled: boolean; index: string; }>; readonly unsafe: Readonly<{} & { cases: Readonly<{} & { enabled: boolean; }>; alertingExperience: Readonly<{} & { enabled: boolean; }>; }>; }"
], ],
"source": { "source": {
"path": "x-pack/plugins/observability/server/index.ts", "path": "x-pack/plugins/observability/server/index.ts",
"lineNumber": 34 "lineNumber": 35
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -3974,7 +3988,15 @@
"Type", "Type",
"<number, string, unknown>; end: ", "<number, string, unknown>; end: ",
"Type", "Type",
"<number, string, unknown>; }>, ", "<number, string, unknown>; status: ",
"UnionC",
"<[",
"LiteralC",
"<\"all\">, ",
"LiteralC",
"<\"open\">, ",
"LiteralC",
"<\"closed\">]>; }>, ",
"PartialC", "PartialC",
"<{ kuery: ", "<{ kuery: ",
"StringC", "StringC",

8
api_docs/presentation_util.json
View file

@ -528,7 +528,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "Component", "label": "Component",
"description": [], "description": [
"A component deferred by `React.lazy`"
],
"signature": [ "signature": [
"React.ComponentType<P>" "React.ComponentType<P>"
], ],
@ -545,7 +547,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "fallback", "label": "fallback",
"description": [], "description": [
"A fallback component to render while things load; default is `EuiLoadingSpinner`"
],
"signature": [ "signature": [
"React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null" "React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null"
], ],

102
api_docs/reporting.json
View file

@ -911,10 +911,10 @@
"children": [ "children": [
{ {
"parentPluginId": "reporting", "parentPluginId": "reporting",
"id": "def-server.ReportingCore.getStartContract", "id": "def-server.ReportingCore.getContract",
"type": "Function", "type": "Function",
"tags": [], "tags": [],
"label": "getStartContract", "label": "getContract",
"description": [], "description": [],
"signature": [ "signature": [
"() => ", "() => ",
@ -1010,7 +1010,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 92 "lineNumber": 90
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1026,7 +1026,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 92 "lineNumber": 90
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1048,7 +1048,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 106 "lineNumber": 104
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1064,7 +1064,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 106 "lineNumber": 104
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1084,7 +1084,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 119 "lineNumber": 117
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1102,7 +1102,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 130 "lineNumber": 128
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1120,7 +1120,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 137 "lineNumber": 135
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1146,7 +1146,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 144 "lineNumber": 142
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1168,7 +1168,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 144 "lineNumber": 142
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1190,7 +1190,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 153 "lineNumber": 151
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1215,7 +1215,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 187 "lineNumber": 185
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1233,7 +1233,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 199 "lineNumber": 197
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1253,7 +1253,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 206 "lineNumber": 204
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1272,7 +1272,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 214 "lineNumber": 212
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1302,7 +1302,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 218 "lineNumber": 216
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1321,7 +1321,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 218 "lineNumber": 216
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1343,7 +1343,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 222 "lineNumber": 220
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1363,7 +1363,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 226 "lineNumber": 224
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1383,7 +1383,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 236 "lineNumber": 234
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1401,7 +1401,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 242 "lineNumber": 240
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1420,7 +1420,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 250 "lineNumber": 248
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1454,7 +1454,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 262 "lineNumber": 260
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1478,7 +1478,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 262 "lineNumber": 260
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1508,7 +1508,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 268 "lineNumber": 266
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1531,7 +1531,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 268 "lineNumber": 266
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1548,7 +1548,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 268 "lineNumber": 266
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1578,7 +1578,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 282 "lineNumber": 280
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1594,7 +1594,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 282 "lineNumber": 280
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1611,7 +1611,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 282 "lineNumber": 280
}, },
"deprecated": false, "deprecated": false,
"isRequired": false "isRequired": false
@ -1628,7 +1628,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 282 "lineNumber": 280
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1666,7 +1666,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 302 "lineNumber": 300
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1689,7 +1689,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 302 "lineNumber": 300
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1706,7 +1706,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 302 "lineNumber": 300
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1734,7 +1734,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 312 "lineNumber": 310
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1760,7 +1760,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 317 "lineNumber": 315
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1778,7 +1778,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 322 "lineNumber": 320
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1794,7 +1794,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 322 "lineNumber": 320
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1814,7 +1814,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 326 "lineNumber": 324
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1830,7 +1830,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 326 "lineNumber": 324
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -1850,7 +1850,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 330 "lineNumber": 328
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1918,7 +1918,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 25 "lineNumber": 26
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1934,7 +1934,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 30 "lineNumber": 31
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1959,7 +1959,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 30 "lineNumber": 31
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -2002,7 +2002,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 34 "lineNumber": 35
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -2025,7 +2025,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 34 "lineNumber": 35
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -2048,7 +2048,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 34 "lineNumber": 35
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -2091,7 +2091,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 87 "lineNumber": 88
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -2113,7 +2113,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 87 "lineNumber": 88
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -2136,7 +2136,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/reporting/server/plugin.ts", "path": "x-pack/plugins/reporting/server/plugin.ts",
"lineNumber": 87 "lineNumber": 88
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true

43
api_docs/rule_registry.json
View file

@ -695,8 +695,8 @@
"{ readonly enabled: boolean; readonly index: string; readonly write: Readonly<{} & { enabled: boolean; }>; }" "{ readonly enabled: boolean; readonly index: string; readonly write: Readonly<{} & { enabled: boolean; }>; }"
], ],
"source": { "source": {
"path": "x-pack/plugins/rule_registry/server/index.ts", "path": "x-pack/plugins/rule_registry/server/config.ts",
"lineNumber": 28 "lineNumber": 20
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -706,18 +706,49 @@
"setup": { "setup": {
"parentPluginId": "ruleRegistry", "parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract", "id": "def-server.RuleRegistryPluginSetupContract",
"type": "Type", "type": "Interface",
"tags": [], "tags": [],
"label": "RuleRegistryPluginSetupContract", "label": "RuleRegistryPluginSetupContract",
"description": [], "description": [],
"source": {
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"lineNumber": 22
},
"deprecated": false,
"children": [
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract.ruleDataService",
"type": "Object",
"tags": [],
"label": "ruleDataService",
"description": [],
"signature": [ "signature": [
"RuleDataPluginService" "RuleDataPluginService"
], ],
"source": { "source": {
"path": "x-pack/plugins/rule_registry/server/plugin.ts", "path": "x-pack/plugins/rule_registry/server/plugin.ts",
"lineNumber": 12 "lineNumber": 23
}, },
"deprecated": false, "deprecated": false
},
{
"parentPluginId": "ruleRegistry",
"id": "def-server.RuleRegistryPluginSetupContract.eventLogService",
"type": "Object",
"tags": [],
"label": "eventLogService",
"description": [],
"signature": [
"IEventLogService"
],
"source": {
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
"lineNumber": 24
},
"deprecated": false
}
],
"lifecycle": "setup", "lifecycle": "setup",
"initialIsOpen": true "initialIsOpen": true
}, },
@ -733,7 +764,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/rule_registry/server/plugin.ts", "path": "x-pack/plugins/rule_registry/server/plugin.ts",
"lineNumber": 13 "lineNumber": 27
}, },
"deprecated": false, "deprecated": false,
"lifecycle": "start", "lifecycle": "start",

8
api_docs/spaces.json
View file

@ -1210,7 +1210,7 @@
"plugin": "reporting", "plugin": "reporting",
"link": { "link": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 271 "lineNumber": 269
} }
}, },
{ {
@ -2030,21 +2030,21 @@
"plugin": "reporting", "plugin": "reporting",
"link": { "link": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 269 "lineNumber": 267
} }
}, },
{ {
"plugin": "reporting", "plugin": "reporting",
"link": { "link": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 291 "lineNumber": 289
} }
}, },
{ {
"plugin": "reporting", "plugin": "reporting",
"link": { "link": {
"path": "x-pack/plugins/reporting/server/core.ts", "path": "x-pack/plugins/reporting/server/core.ts",
"lineNumber": 303 "lineNumber": 301
} }
}, },
{ {

200
api_docs/triggers_actions_ui.json
View file

@ -45,7 +45,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 77 "lineNumber": 80
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -61,7 +61,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 88 "lineNumber": 91
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -94,7 +94,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 93 "lineNumber": 96
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -117,7 +117,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 93 "lineNumber": 96
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -134,7 +134,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 93 "lineNumber": 96
}, },
"deprecated": false, "deprecated": false,
"isRequired": true "isRequired": true
@ -161,7 +161,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 169 "lineNumber": 172
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -179,7 +179,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 203 "lineNumber": 206
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -228,44 +228,6 @@
], ],
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertAdd",
"type": "Function",
"tags": [],
"label": "AlertAdd",
"description": [],
"signature": [
"(props: ",
"AlertAddProps",
"<Record<string, any>>) => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/alert_form/index.tsx",
"lineNumber": 11
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{ {
"parentPluginId": "triggersActionsUi", "parentPluginId": "triggersActionsUi",
"id": "def-public.AlertConditions", "id": "def-public.AlertConditions",
@ -346,44 +308,6 @@
], ],
"initialIsOpen": false "initialIsOpen": false
}, },
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.AlertEdit",
"type": "Function",
"tags": [],
"label": "AlertEdit",
"description": [],
"signature": [
"(props: ",
"AlertEditProps",
"<Record<string, any>>) => JSX.Element"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/sections/index.tsx",
"lineNumber": 17
},
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "triggersActionsUi",
"id": "def-public.props",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"T"
],
"source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/lib/suspended_component_with_props.tsx",
"lineNumber": 16
},
"deprecated": false
}
],
"initialIsOpen": false
},
{ {
"parentPluginId": "triggersActionsUi", "parentPluginId": "triggersActionsUi",
"id": "def-public.ConnectorAddFlyout", "id": "def-public.ConnectorAddFlyout",
@ -518,7 +442,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/jira/jira.tsx", "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/jira/jira.tsx",
"lineNumber": 63 "lineNumber": 62
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -545,7 +469,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/resilient/resilient.tsx", "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/resilient/resilient.tsx",
"lineNumber": 68 "lineNumber": 67
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -752,7 +676,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx", "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx",
"lineNumber": 64 "lineNumber": 63
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -779,7 +703,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx", "path": "x-pack/plugins/triggers_actions_ui/public/application/components/builtin_action_types/servicenow/servicenow.tsx",
"lineNumber": 99 "lineNumber": 98
}, },
"deprecated": false, "deprecated": false,
"children": [], "children": [],
@ -1459,7 +1383,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 234 "lineNumber": 235
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1472,7 +1396,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 235 "lineNumber": 236
}, },
"deprecated": false "deprecated": false
}, },
@ -1485,7 +1409,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 236 "lineNumber": 237
}, },
"deprecated": false "deprecated": false
}, },
@ -1498,7 +1422,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 237 "lineNumber": 238
}, },
"deprecated": false "deprecated": false
}, },
@ -1522,7 +1446,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 238 "lineNumber": 239
}, },
"deprecated": false "deprecated": false
}, },
@ -1545,7 +1469,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 239 "lineNumber": 240
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -1562,7 +1486,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 239 "lineNumber": 240
}, },
"deprecated": false "deprecated": false
} }
@ -1588,7 +1512,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 240 "lineNumber": 241
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -1620,7 +1544,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 243 "lineNumber": 244
}, },
"deprecated": false "deprecated": false
}, },
@ -1636,7 +1560,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 244 "lineNumber": 245
}, },
"deprecated": false "deprecated": false
} }
@ -1662,7 +1586,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 212 "lineNumber": 213
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -1678,7 +1602,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 217 "lineNumber": 218
}, },
"deprecated": false "deprecated": false
}, },
@ -1691,7 +1615,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 218 "lineNumber": 219
}, },
"deprecated": false "deprecated": false
}, },
@ -1704,7 +1628,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 219 "lineNumber": 220
}, },
"deprecated": false "deprecated": false
}, },
@ -1720,7 +1644,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 220 "lineNumber": 221
}, },
"deprecated": false "deprecated": false
}, },
@ -1736,7 +1660,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 221 "lineNumber": 222
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -1753,7 +1677,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 221 "lineNumber": 222
}, },
"deprecated": false "deprecated": false
}, },
@ -1769,7 +1693,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 221 "lineNumber": 222
}, },
"deprecated": false "deprecated": false
} }
@ -1795,7 +1719,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 222 "lineNumber": 223
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -1812,7 +1736,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 223 "lineNumber": 224
}, },
"deprecated": false "deprecated": false
}, },
@ -1836,7 +1760,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 224 "lineNumber": 225
}, },
"deprecated": false "deprecated": false
} }
@ -1860,7 +1784,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 226 "lineNumber": 227
}, },
"deprecated": false "deprecated": false
}, },
@ -1873,7 +1797,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 227 "lineNumber": 228
}, },
"deprecated": false "deprecated": false
}, },
@ -1896,7 +1820,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 228 "lineNumber": 229
}, },
"deprecated": false "deprecated": false
}, },
@ -1912,7 +1836,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 229 "lineNumber": 230
}, },
"deprecated": false "deprecated": false
}, },
@ -1934,7 +1858,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 230 "lineNumber": 231
}, },
"deprecated": false "deprecated": false
}, },
@ -1956,7 +1880,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 231 "lineNumber": 232
}, },
"deprecated": false "deprecated": false
} }
@ -2098,7 +2022,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 247 "lineNumber": 248
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -2114,7 +2038,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 248 "lineNumber": 249
}, },
"deprecated": false "deprecated": false
} }
@ -2483,7 +2407,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 127 "lineNumber": 128
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -2499,7 +2423,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 128 "lineNumber": 129
}, },
"deprecated": false "deprecated": false
} }
@ -2531,7 +2455,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 79 "lineNumber": 80
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -2581,7 +2505,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 161 "lineNumber": 162
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -2637,7 +2561,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 64 "lineNumber": 65
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -2654,7 +2578,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 179 "lineNumber": 180
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -2695,7 +2619,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 40 "lineNumber": 41
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -2753,7 +2677,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/types.ts", "path": "x-pack/plugins/triggers_actions_ui/public/types.ts",
"lineNumber": 68 "lineNumber": 69
}, },
"deprecated": false, "deprecated": false,
"initialIsOpen": false "initialIsOpen": false
@ -3782,7 +3706,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 41 "lineNumber": 44
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3801,7 +3725,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 42 "lineNumber": 45
}, },
"deprecated": false "deprecated": false
}, },
@ -3826,7 +3750,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 43 "lineNumber": 46
}, },
"deprecated": false "deprecated": false
} }
@ -3843,7 +3767,7 @@
"description": [], "description": [],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 46 "lineNumber": 49
}, },
"deprecated": false, "deprecated": false,
"children": [ "children": [
@ -3862,7 +3786,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 47 "lineNumber": 50
}, },
"deprecated": false "deprecated": false
}, },
@ -3887,7 +3811,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 48 "lineNumber": 51
}, },
"deprecated": false "deprecated": false
}, },
@ -3907,7 +3831,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 49 "lineNumber": 52
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -3948,7 +3872,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 50 "lineNumber": 53
}, },
"deprecated": false "deprecated": false
} }
@ -3970,7 +3894,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 52 "lineNumber": 55
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -4005,7 +3929,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 53 "lineNumber": 56
}, },
"deprecated": false "deprecated": false
} }
@ -4027,7 +3951,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 55 "lineNumber": 58
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -4060,7 +3984,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 56 "lineNumber": 59
}, },
"deprecated": false "deprecated": false
} }
@ -4082,7 +4006,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 58 "lineNumber": 61
}, },
"deprecated": false, "deprecated": false,
"returnComment": [], "returnComment": [],
@ -4115,7 +4039,7 @@
], ],
"source": { "source": {
"path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts", "path": "x-pack/plugins/triggers_actions_ui/public/plugin.ts",
"lineNumber": 59 "lineNumber": 62
}, },
"deprecated": false "deprecated": false
} }

20
api_docs/visualizations.json
View file

@ -85,7 +85,15 @@
"label": "getSupportedTriggers", "label": "getSupportedTriggers",
"description": [], "description": [],
"signature": [ "signature": [
"(() => string[]) | undefined" "((params?: ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.VisParams",
"text": "VisParams"
},
" | undefined) => string[]) | undefined"
], ],
"source": { "source": {
"path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts", "path": "src/plugins/visualizations/public/vis_types/base_vis_type.ts",
@ -3327,7 +3335,15 @@
"\nIf given, it will return the supported triggers for this vis." "\nIf given, it will return the supported triggers for this vis."
], ],
"signature": [ "signature": [
"(() => string[]) | undefined" "((params?: ",
{
"pluginId": "visualizations",
"scope": "common",
"docId": "kibVisualizationsPluginApi",
"section": "def-common.VisParams",
"text": "VisParams"
},
" | undefined) => string[]) | undefined"
], ],
"source": { "source": {
"path": "src/plugins/visualizations/public/vis_types/types.ts", "path": "src/plugins/visualizations/public/vis_types/types.ts",

5
packages/kbn-docs-utils/src/api_docs/build_api_declarations/build_arrow_fn_dec.ts
View file

@ -19,7 +19,7 @@ import {
import { AnchorLink, ApiDeclaration, TypeKind } from '../types'; import { AnchorLink, ApiDeclaration, TypeKind } from '../types';
import { buildApiDecsForParameters } from './build_parameter_decs'; import { buildApiDecsForParameters } from './build_parameter_decs';
import { getSignature } from './get_signature'; import { getSignature } from './get_signature';
import { getJSDocReturnTagComment } from './js_doc_utils'; import { getJSDocReturnTagComment, getJSDocs } from './js_doc_utils';
import { buildBasicApiDeclaration } from './build_basic_api_declaration'; import { buildBasicApiDeclaration } from './build_basic_api_declaration';
/** /**
@ -66,7 +66,8 @@ export function getArrowFunctionDec(
anchorLink, anchorLink,
currentPluginId, currentPluginId,
log, log,
captureReferences captureReferences,
getJSDocs(node)
), ),
// need to override the signature - use the initializer, not the node. // need to override the signature - use the initializer, not the node.
signature: getSignature(initializer, plugins, log), signature: getSignature(initializer, plugins, log),

7
packages/kbn-docs-utils/src/api_docs/tests/api_doc_suite.test.ts
View file

@ -46,6 +46,8 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p1!.isRequired).toBe(true); expect(p1!.isRequired).toBe(true);
expect(p1!.signature?.length).toBe(1); expect(p1!.signature?.length).toBe(1);
expect(linkCount(p1!.signature!)).toBe(0); expect(linkCount(p1!.signature!)).toBe(0);
expect(p1?.description).toBeDefined();
expect(p1?.description?.length).toBe(1);
const p2 = fn?.children!.find((c) => c.label === 'b'); const p2 = fn?.children!.find((c) => c.label === 'b');
expect(p2).toBeDefined(); expect(p2).toBeDefined();
@ -53,12 +55,15 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p2!.type).toBe(TypeKind.NumberKind); expect(p2!.type).toBe(TypeKind.NumberKind);
expect(p2!.signature?.length).toBe(1); expect(p2!.signature?.length).toBe(1);
expect(linkCount(p2!.signature!)).toBe(0); expect(linkCount(p2!.signature!)).toBe(0);
expect(p2?.description?.length).toBe(1);
const p3 = fn?.children!.find((c) => c.label === 'c'); const p3 = fn?.children!.find((c) => c.label === 'c');
expect(p3).toBeDefined(); expect(p3).toBeDefined();
expect(p3!.isRequired).toBe(true); expect(p3!.isRequired).toBe(true);
expect(p3!.type).toBe(TypeKind.ArrayKind); expect(p3!.type).toBe(TypeKind.ArrayKind);
expect(linkCount(p3!.signature!)).toBe(1); expect(linkCount(p3!.signature!)).toBe(1);
expect(p3?.description).toBeDefined();
expect(p3?.description?.length).toBe(1);
const p4 = fn?.children!.find((c) => c.label === 'd'); const p4 = fn?.children!.find((c) => c.label === 'd');
expect(p4).toBeDefined(); expect(p4).toBeDefined();
@ -66,6 +71,7 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p4!.type).toBe(TypeKind.CompoundTypeKind); expect(p4!.type).toBe(TypeKind.CompoundTypeKind);
expect(p4!.signature?.length).toBe(1); expect(p4!.signature?.length).toBe(1);
expect(linkCount(p4!.signature!)).toBe(1); expect(linkCount(p4!.signature!)).toBe(1);
expect(p4?.description?.length).toBe(1);
const p5 = fn?.children!.find((c) => c.label === 'e'); const p5 = fn?.children!.find((c) => c.label === 'e');
expect(p5).toBeDefined(); expect(p5).toBeDefined();
@ -73,6 +79,7 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p5!.type).toBe(TypeKind.StringKind); expect(p5!.type).toBe(TypeKind.StringKind);
expect(p5!.signature?.length).toBe(1); expect(p5!.signature?.length).toBe(1);
expect(linkCount(p5!.signature!)).toBe(0); expect(linkCount(p5!.signature!)).toBe(0);
expect(p5?.description?.length).toBe(1);
} }
beforeAll(() => { beforeAll(() => {

26
packages/kbn-docs-utils/src/api_docs/tests/snapshots/plugin_a.json
View file

@ -165,7 +165,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "a", "label": "a",
"description": [], "description": [
"im a string"
],
"signature": [ "signature": [
{ {
"pluginId": "pluginA", "pluginId": "pluginA",
@ -292,7 +294,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "a", "label": "a",
"description": [], "description": [
"The letter A"
],
"signature": [ "signature": [
"string" "string"
], ],
@ -309,7 +313,9 @@
"type": "number", "type": "number",
"tags": [], "tags": [],
"label": "b", "label": "b",
"description": [], "description": [
"Feed me to the function"
],
"signature": [ "signature": [
"number | undefined" "number | undefined"
], ],
@ -326,7 +332,9 @@
"type": "Array", "type": "Array",
"tags": [], "tags": [],
"label": "c", "label": "c",
"description": [], "description": [
"So many params"
],
"signature": [ "signature": [
{ {
"pluginId": "pluginA", "pluginId": "pluginA",
@ -350,7 +358,9 @@
"type": "CompoundType", "type": "CompoundType",
"tags": [], "tags": [],
"label": "d", "label": "d",
"description": [], "description": [
"a great param"
],
"signature": [ "signature": [
{ {
"pluginId": "pluginA", "pluginId": "pluginA",
@ -373,7 +383,9 @@
"type": "string", "type": "string",
"tags": [], "tags": [],
"label": "e", "label": "e",
"description": [], "description": [
"Another comment"
],
"signature": [ "signature": [
"string | undefined" "string | undefined"
], ],
@ -586,7 +598,7 @@
"section": "def-public.ImAType", "section": "def-public.ImAType",
"text": "ImAType" "text": "ImAType"
}, },
", e: string | undefined) => ", ", e?: string | undefined) => ",
{ {
"pluginId": "pluginA", "pluginId": "pluginA",
"scope": "public", "scope": "public",