maxmustermann/kibana
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

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

Browse source 
* Make sure arrow functions capture parameter comments.

* Update docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/core.json
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/licensing.json
#	api_docs/reporting.json
#	api_docs/spaces.json
This commit is contained in:
Stacey Gammon 2021-06-01 17:24:44 -04:00 committed by GitHub
parent 2cc6873e6c
commit 2cad521166
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
24 changed files with 491 additions and 225 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

98
api_docs/bfetch.json
View file

@ -78,7 +78,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 24
"lineNumber": 23
},
"deprecated": false,
"children": [
@ -98,7 +98,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 25
"lineNumber": 24
},
"deprecated": false,
"returnComment": [],
@ -115,7 +115,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 25
"lineNumber": 24
},
"deprecated": false
}
@ -143,7 +143,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 26
"lineNumber": 25
},
"deprecated": false,
"returnComment": [],
@ -161,7 +161,7 @@
],
"source": {
"path": "src/plugins/bfetch/public/plugin.ts",
"lineNumber": 27
"lineNumber": 26
},
"deprecated": false
}
@ -195,7 +195,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 39
"lineNumber": 41
},
"deprecated": false,
"children": [
@ -211,7 +211,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 40
"lineNumber": 42
},
"deprecated": false,
"returnComment": [],
@ -228,7 +228,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 40
"lineNumber": 42
},
"deprecated": false
}
@ -290,7 +290,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 44
"lineNumber": 46
},
"deprecated": false,
"children": [
@ -322,7 +322,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 45
"lineNumber": 47
},
"deprecated": false,
"returnComment": [],
@ -336,7 +336,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 46
"lineNumber": 48
},
"deprecated": false
},
@ -368,7 +368,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 47
"lineNumber": 49
},
"deprecated": false
}
@ -402,7 +402,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 49
"lineNumber": 51
},
"deprecated": false,
"returnComment": [],
@ -416,7 +416,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 50
"lineNumber": 52
},
"deprecated": false
},
@ -448,7 +448,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 51
"lineNumber": 53
},
"deprecated": false
}
@ -682,7 +682,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 81
"lineNumber": 83
},
"deprecated": false,
"returnComment": [],
@ -719,7 +719,7 @@
],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 89
"lineNumber": 91
},
"deprecated": false
}
@ -738,7 +738,7 @@
"description": [],
"source": {
"path": "src/plugins/bfetch/server/plugin.ts",
"lineNumber": 94
"lineNumber": 96
},
"deprecated": false,
"children": [],
@ -1343,6 +1343,48 @@
],
"initialIsOpen": false
},
{
"parentPluginId": "bfetch",
"id": "def-common.BatchItemWrapper",
"type": "Interface",
"tags": [],
"label": "BatchItemWrapper",
"description": [],
"source": {
"path": "src/plugins/bfetch/common/batch.ts",
"lineNumber": 23
},
"deprecated": false,
"children": [
{
"parentPluginId": "bfetch",
"id": "def-common.BatchItemWrapper.compressed",
"type": "boolean",
"tags": [],
"label": "compressed",
"description": [],
"source": {
"path": "src/plugins/bfetch/common/batch.ts",
"lineNumber": 24
},
"deprecated": false
},
{
"parentPluginId": "bfetch",
"id": "def-common.BatchItemWrapper.payload",
"type": "string",
"tags": [],
"label": "payload",
"description": [],
"source": {
"path": "src/plugins/bfetch/common/batch.ts",
"lineNumber": 25
},
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "bfetch",
"id": "def-common.BatchRequestData",
@ -1684,7 +1726,25 @@
}
],
"enums": [],
"misc": [],
"misc": [
{
"parentPluginId": "bfetch",
"id": "def-common.DISABLE_BFETCH_COMPRESSION",
"type": "string",
"tags": [],
"label": "DISABLE_BFETCH_COMPRESSION",
"description": [],
"signature": [
"\"bfetch:disableCompression\""
],
"source": {
"path": "src/plugins/bfetch/common/constants.ts",
"lineNumber": 9
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": []
}
}

3
api_docs/bfetch.mdx
View file

@ -47,3 +47,6 @@ import bfetchObj from './bfetch.json';
### Interfaces
<DocDefinitionList data={bfetchObj.common.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={bfetchObj.common.misc}/>

8
api_docs/charts.json
View file

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

94
api_docs/core.json
View file

@ -8748,7 +8748,9 @@
"type": "string",
"tags": [],
"label": "endpoint",
"description": [],
"description": [
"- String descriptor of the endpoint e.g. `cluster.getSettings` or `ping`."
],
"signature": [
"string"
],
@ -8765,7 +8767,9 @@
"type": "Object",
"tags": [],
"label": "clientParams",
"description": [],
"description": [
"- A dictionary of parameters that will be passed directly to the Elasticsearch JS client."
],
"signature": [
"Record<string, any>"
],
@ -8782,7 +8786,9 @@
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"description": [
"- Options that affect the way we call the API and process the result."
],
"signature": [
{
"pluginId": "core",
@ -9758,13 +9764,6 @@
"lineNumber": 29
}
},
{
"plugin": "infra",
"link": {
"path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts",
"lineNumber": 420
}
},
{
"plugin": "lists",
"link": {
@ -12163,6 +12162,24 @@
},
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.DeprecationsDetails.deprecationType",
"type": "CompoundType",
"tags": [],
"label": "deprecationType",
"description": [
"\n(optional) Used to identify between different deprecation types.\nExample use case: in Upgrade Assistant, we may want to allow the user to sort by\ndeprecation type or show each type in a separate tab.\n\nFeel free to add new types if necessary.\nPredefined types are necessary to reduce having similar definitions with different keywords\nacross kibana deprecations."
],
"signature": [
"\"config\" | \"feature\" | undefined"
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 37
},
"deprecated": false
},
{
"parentPluginId": "core",
"id": "def-server.DeprecationsDetails.documentationUrl",
@ -12175,7 +12192,7 @@
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 29
"lineNumber": 39
},
"deprecated": false
},
@ -12191,7 +12208,7 @@
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 31
"lineNumber": 41
},
"deprecated": false
}
@ -12259,7 +12276,7 @@
],
"source": {
"path": "src/core/server/deprecations/deprecations_service.ts",
"lineNumber": 103
"lineNumber": 101
},
"deprecated": false,
"children": [
@ -12283,7 +12300,7 @@
],
"source": {
"path": "src/core/server/deprecations/deprecations_service.ts",
"lineNumber": 104
"lineNumber": 102
},
"deprecated": false,
"returnComment": [],
@ -12306,7 +12323,7 @@
],
"source": {
"path": "src/core/server/deprecations/deprecations_service.ts",
"lineNumber": 104
"lineNumber": 102
},
"deprecated": false
}
@ -12943,7 +12960,7 @@
"description": [],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 60
"lineNumber": 70
},
"deprecated": false,
"children": [
@ -12965,7 +12982,7 @@
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 61
"lineNumber": 71
},
"deprecated": false
},
@ -13281,7 +13298,7 @@
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 62
"lineNumber": 72
},
"deprecated": false
}
@ -20546,7 +20563,7 @@
"description": [],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 56
"lineNumber": 66
},
"deprecated": false,
"children": [
@ -20578,7 +20595,7 @@
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 57
"lineNumber": 67
},
"deprecated": false,
"returnComment": [],
@ -20601,7 +20618,7 @@
],
"source": {
"path": "src/core/server/deprecations/types.ts",
"lineNumber": 57
"lineNumber": 67
},
"deprecated": false
}
@ -23704,27 +23721,6 @@
"lineNumber": 73
}
},
{
"plugin": "infra",
"link": {
"path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts",
"lineNumber": 9
}
},
{
"plugin": "infra",
"link": {
"path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts",
"lineNumber": 139
}
},
{
"plugin": "infra",
"link": {
"path": "x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts",
"lineNumber": 405
}
},
{
"plugin": "crossClusterReplication",
"link": {
@ -23773,20 +23769,6 @@
"path": "x-pack/plugins/index_management/target/types/server/types.d.ts",
"lineNumber": 32
}
},
{
"plugin": "infra",
"link": {
"path": "x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts",
"lineNumber": 1
}
},
{
"plugin": "infra",
"link": {
"path": "x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts",
"lineNumber": 58
}
}
],
"initialIsOpen": false

20
api_docs/core_application.json
View file

@ -115,7 +115,9 @@
"type": "string",
"tags": [],
"label": "basePath",
"description": [],
"description": [
"the URL path scope for the sub history"
],
"signature": [
"string"
],
@ -207,7 +209,9 @@
"type": "CompoundType",
"tags": [],
"label": "pathOrLocation",
"description": [],
"description": [
"a string or location descriptor"
],
"signature": [
"string | ",
"LocationDescriptorObject",
@ -266,7 +270,9 @@
"type": "CompoundType",
"tags": [],
"label": "pathOrLocation",
"description": [],
"description": [
"a string or location descriptor"
],
"signature": [
"string | ",
"LocationDescriptorObject",
@ -323,7 +329,9 @@
"type": "number",
"tags": [],
"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": [
"number"
],
@ -449,7 +457,9 @@
"type": "Function",
"tags": [],
"label": "listener",
"description": [],
"description": [
"a function that receives location updates."
],
"signature": [
"(location: ",
"Location",

24
api_docs/core_saved_objects.json
View file

@ -161,7 +161,9 @@
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"description": [
"- [{ type, id, attributes, references, migrationVersion }]"
],
"signature": [
{
"pluginId": "core",
@ -451,7 +453,9 @@
"type": "Array",
"tags": [],
"label": "objects",
"description": [],
"description": [
"- an array ids, or an array of objects containing id and optionally type"
],
"signature": [
"{ id: string; type: string; }[]"
],
@ -9362,7 +9366,9 @@
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"description": [
"The namespace ID, which must be either a non-empty string or `undefined`."
],
"signature": [
"string | undefined"
],
@ -9400,7 +9406,9 @@
"type": "string",
"tags": [],
"label": "namespace",
"description": [],
"description": [
"The namespace string, which must be non-empty."
],
"signature": [
"string"
],
@ -14499,15 +14507,15 @@
{
"plugin": "lens",
"link": {
"path": "x-pack/plugins/lens/server/migrations.ts",
"lineNumber": 245
"path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts",
"lineNumber": 167
}
},
{
"plugin": "lens",
"link": {
"path": "x-pack/plugins/lens/server/migrations.ts",
"lineNumber": 312
"path": "x-pack/plugins/lens/server/migrations/saved_object_migrations.ts",
"lineNumber": 234
}
}
],

76
api_docs/data.json
View file

@ -5646,7 +5646,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -5684,7 +5686,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -5787,7 +5791,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -5825,7 +5831,9 @@
"type": "string",
"tags": [],
"label": "id",
"description": [],
"description": [
"optionally clear a single id"
],
"signature": [
"string | undefined"
],
@ -6220,7 +6228,9 @@
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"description": [
": FieldSpec[]"
],
"signature": [
{
"pluginId": "data",
@ -6244,7 +6254,9 @@
"type": "Object",
"tags": [],
"label": "fieldAttrs",
"description": [],
"description": [
": FieldAttrs"
],
"signature": [
{
"pluginId": "data",
@ -28667,7 +28679,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -28705,7 +28719,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -28808,7 +28824,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -28846,7 +28864,9 @@
"type": "string",
"tags": [],
"label": "id",
"description": [],
"description": [
"optionally clear a single id"
],
"signature": [
"string | undefined"
],
@ -29241,7 +29261,9 @@
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"description": [
": FieldSpec[]"
],
"signature": [
{
"pluginId": "data",
@ -29265,7 +29287,9 @@
"type": "Object",
"tags": [],
"label": "fieldAttrs",
"description": [],
"description": [
": FieldAttrs"
],
"signature": [
{
"pluginId": "data",
@ -29943,7 +29967,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -29981,7 +30007,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -30084,7 +30112,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -30122,7 +30152,9 @@
"type": "string",
"tags": [],
"label": "id",
"description": [],
"description": [
"optionally clear a single id"
],
"signature": [
"string | undefined"
],
@ -30517,7 +30549,9 @@
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"description": [
": FieldSpec[]"
],
"signature": [
{
"pluginId": "data",
@ -30541,7 +30575,9 @@
"type": "Object",
"tags": [],
"label": "fieldAttrs",
"description": [],
"description": [
": FieldAttrs"
],
"signature": [
{
"pluginId": "data",
@ -42488,7 +42524,9 @@
"type": "Object",
"tags": [],
"label": "filter",
"description": [],
"description": [
"The filter to clean"
],
"signature": [
{
"pluginId": "data",

66
api_docs/data_field_formats.json
View file

@ -513,7 +513,7 @@
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 157
"lineNumber": 211
},
"deprecated": false,
"children": [
@ -535,7 +535,7 @@
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 158
"lineNumber": 212
},
"deprecated": false
},
@ -548,7 +548,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 159
"lineNumber": 213
},
"deprecated": false
},
@ -570,7 +570,7 @@
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 162
"lineNumber": 216
},
"deprecated": false
},
@ -586,7 +586,7 @@
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 163
"lineNumber": 217
},
"deprecated": false
},
@ -598,11 +598,11 @@
"label": "outputFormats",
"description": [],
"signature": [
"{ text: string; method: string; }[]"
"({ text: string; method: string; shortText?: undefined; } | { text: string; shortText: string; method: string; })[]"
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 164
"lineNumber": 218
},
"deprecated": false
},
@ -615,7 +615,7 @@
"description": [],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 165
"lineNumber": 219
},
"deprecated": false
},
@ -631,7 +631,25 @@
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 167
"lineNumber": 221
},
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "data",
"id": "def-common.DurationFormat.isHumanPrecise",
"type": "Function",
"tags": [],
"label": "isHumanPrecise",
"description": [],
"signature": [
"() => boolean"
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 225
},
"deprecated": false,
"children": [],
@ -645,11 +663,11 @@
"label": "getParamDefaults",
"description": [],
"signature": [
"() => { inputFormat: string; outputFormat: string; outputPrecision: number; }"
"() => { inputFormat: string; outputFormat: string; outputPrecision: number; includeSpaceWithSuffix: boolean; }"
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 170
"lineNumber": 229
},
"deprecated": false,
"children": [],
@ -663,11 +681,11 @@
"label": "textConvert",
"description": [],
"signature": [
"(val: any) => string"
"(val: any) => any"
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 178
"lineNumber": 238
},
"deprecated": false,
"children": [
@ -683,7 +701,7 @@
],
"source": {
"path": "src/plugins/data/common/field_formats/converters/duration.ts",
"lineNumber": 178
"lineNumber": 238
},
"deprecated": false,
"isRequired": true
@ -1687,7 +1705,9 @@
"type": "Enum",
"tags": [],
"label": "fieldType",
"description": [],
"description": [
"- the field type"
],
"signature": [
{
"pluginId": "data",
@ -1710,7 +1730,9 @@
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"description": [
"- Array of ES data types"
],
"signature": [
{
"pluginId": "data",
@ -1759,7 +1781,9 @@
"type": "string",
"tags": [],
"label": "formatId",
"description": [],
"description": [
"- the format id"
],
"signature": [
"string"
],
@ -1878,7 +1902,9 @@
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"description": [
"- Array of ES data types"
],
"signature": [
{
"pluginId": "data",
@ -1941,7 +1967,9 @@
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [],
"description": [
"- Array of ES data types"
],
"signature": [
{
"pluginId": "data",

24
api_docs/data_index_patterns.json
View file

@ -3327,7 +3327,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -3365,7 +3367,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -3468,7 +3472,9 @@
"type": "boolean",
"tags": [],
"label": "refresh",
"description": [],
"description": [
"Force refresh of index pattern list"
],
"signature": [
"boolean"
],
@ -3506,7 +3512,9 @@
"type": "string",
"tags": [],
"label": "id",
"description": [],
"description": [
"optionally clear a single id"
],
"signature": [
"string | undefined"
],
@ -3901,7 +3909,9 @@
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"description": [
": FieldSpec[]"
],
"signature": [
{
"pluginId": "data",
@ -3925,7 +3935,9 @@
"type": "Object",
"tags": [],
"label": "fieldAttrs",
"description": [],
"description": [
": FieldAttrs"
],
"signature": [
{
"pluginId": "data",

40
api_docs/data_query.json
View file

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

4
api_docs/data_search.json
View file

@ -11658,7 +11658,9 @@
"type": "Object",
"tags": [],
"label": "indexPatterns",
"description": [],
"description": [
"The index patterns contract of the data plugin"
],
"signature": [
"Pick<",
{

4
api_docs/data_ui.json
View file

File diff suppressed because one or more lines are too long

5
api_docs/deprecations.mdx
View file

@ -588,11 +588,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [custom_metric_form.d.ts#L8](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/custom_metric_form.d.ts#L8) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L1) | - |
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [index.d.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/public/pages/metrics/inventory_view/components/waffle/metric_control/index.d.ts#L9) | - |
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | [log_entry_categories_analysis.ts#L9](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L9) | 7.16 |
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | [log_entry_categories_analysis.ts#L139](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L139) | 7.16 |
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | [log_entry_categories_analysis.ts#L405](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/server/lib/log_analysis/log_entry_categories_analysis.ts#L405) | 7.16 |
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | [log_entry_categories_analysis.d.ts#L1](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts#L1) | 7.16 |
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | [log_entry_categories_analysis.d.ts#L58](https://github.com/elastic/kibana/tree/master/x-pack/plugins/infra/target/types/server/lib/log_analysis/log_entry_categories_analysis.d.ts#L58) | 7.16 |

8
api_docs/embeddable.json
View file

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

48
api_docs/expressions.json
View file

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

10
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",
"tags": [],
"label": "storage",
"description": [],
"description": [
"- Option {@link Storage} to use for storing state. By default window.sessionStorage."
],
"signature": [
"Storage"
],
@ -2616,7 +2618,9 @@
"type": "Function",
"tags": [],
"label": "accessor",
"description": [],
"description": [
"Asynchronous start service accessor provided by platform."
],
"signature": [
{
"pluginId": "core",
@ -3623,7 +3627,9 @@
"type": "Object",
"tags": [],
"label": "promise",
"description": [],
"description": [
"Promise to convert to 3-tuple."
],
"signature": [
"Promise<T>"
],
@ -4687,7 +4693,9 @@
"type": "Uncategorized",
"tags": [],
"label": "container",
"description": [],
"description": [
"- {@link StateContainer} which state to track."
],
"signature": [
"Container"
],
@ -4704,7 +4712,9 @@
"type": "Function",
"tags": [],
"label": "selector",
"description": [],
"description": [
"- Function used to pick parts of state."
],
"signature": [
"(state: ",
{
@ -4729,7 +4739,9 @@
"type": "Function",
"tags": [],
"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": [
{
"pluginId": "kibanaUtils",
@ -4793,7 +4805,9 @@
"type": "Uncategorized",
"tags": [],
"label": "container",
"description": [],
"description": [
"- {@link StateContainer} which state to track."
],
"signature": [
"Container"
],
@ -10006,7 +10020,9 @@
"type": "Object",
"tags": [],
"label": "promise",
"description": [],
"description": [
"Promise to convert to 3-tuple."
],
"signature": [
"Promise<T>"
],
@ -10069,7 +10085,9 @@
"type": "Uncategorized",
"tags": [],
"label": "container",
"description": [],
"description": [
"- {@link StateContainer} which state to track."
],
"signature": [
"Container"
],
@ -10086,7 +10104,9 @@
"type": "Function",
"tags": [],
"label": "selector",
"description": [],
"description": [
"- Function used to pick parts of state."
],
"signature": [
"(state: ",
{
@ -10111,7 +10131,9 @@
"type": "Function",
"tags": [],
"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": [
{
"pluginId": "kibanaUtils",
@ -10175,7 +10197,9 @@
"type": "Uncategorized",
"tags": [],
"label": "container",
"description": [],
"description": [
"- {@link StateContainer} which state to track."
],
"signature": [
"Container"
],

54
api_docs/lens.json
View file

@ -2350,7 +2350,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 31
"lineNumber": 34
},
"deprecated": false,
"children": [
@ -2366,7 +2366,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 35
"lineNumber": 38
},
"deprecated": false,
"children": [
@ -2389,7 +2389,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 35
"lineNumber": 38
},
"deprecated": false,
"isRequired": true
@ -2433,7 +2433,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39
"lineNumber": 42
},
"deprecated": false,
"children": [
@ -2464,7 +2464,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39
"lineNumber": 42
},
"deprecated": false,
"isRequired": true
@ -2487,7 +2487,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 39
"lineNumber": 42
},
"deprecated": false,
"isRequired": true
@ -2523,7 +2523,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59
"lineNumber": 63
},
"deprecated": false,
"children": [
@ -2545,7 +2545,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59
"lineNumber": 63
},
"deprecated": false,
"isRequired": true
@ -2568,7 +2568,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 59
"lineNumber": 63
},
"deprecated": false,
"isRequired": true
@ -2588,7 +2588,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 66
"lineNumber": 70
},
"deprecated": false,
"children": [],
@ -2609,7 +2609,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 21
"lineNumber": 23
},
"deprecated": false,
"children": [
@ -2632,7 +2632,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 22
"lineNumber": 24
},
"deprecated": false
},
@ -2655,7 +2655,29 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 23
"lineNumber": 25
},
"deprecated": false
},
{
"parentPluginId": "lens",
"id": "def-server.PluginSetupContract.embeddable",
"type": "Object",
"tags": [],
"label": "embeddable",
"description": [],
"signature": [
{
"pluginId": "embeddable",
"scope": "server",
"docId": "kibEmbeddablePluginApi",
"section": "def-server.EmbeddableSetup",
"text": "EmbeddableSetup"
}
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 26
},
"deprecated": false
}
@ -2671,7 +2693,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 26
"lineNumber": 29
},
"deprecated": false,
"children": [
@ -2694,7 +2716,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 27
"lineNumber": 30
},
"deprecated": false
},
@ -2716,7 +2738,7 @@
],
"source": {
"path": "x-pack/plugins/lens/server/plugin.tsx",
"lineNumber": 28
"lineNumber": 31
},
"deprecated": false
}

4
api_docs/observability.json
View file

File diff suppressed because one or more lines are too long

8
api_docs/presentation_util.json
View file

@ -528,7 +528,9 @@
"type": "CompoundType",
"tags": [],
"label": "Component",
"description": [],
"description": [
"A component deferred by `React.lazy`"
],
"signature": [
"React.ComponentType<P>"
],
@ -545,7 +547,9 @@
"type": "CompoundType",
"tags": [],
"label": "fallback",
"description": [],
"description": [
"A fallback component to render while things load; default is `EuiLoadingSpinner`"
],
"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"
],

32
api_docs/security.json
View file

@ -832,7 +832,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 56
"lineNumber": 62
},
"deprecated": false,
"children": [
@ -847,7 +847,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 60
"lineNumber": 66
},
"deprecated": false
},
@ -862,7 +862,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 64
"lineNumber": 70
},
"deprecated": false
},
@ -880,7 +880,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 68
"lineNumber": 74
},
"deprecated": false
},
@ -895,7 +895,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 72
"lineNumber": 78
},
"deprecated": false
}
@ -911,7 +911,7 @@
"description": [],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 75
"lineNumber": 81
},
"deprecated": false,
"children": [
@ -926,7 +926,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 79
"lineNumber": 85
},
"deprecated": false
},
@ -941,7 +941,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 83
"lineNumber": 89
},
"deprecated": false
},
@ -956,7 +956,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 87
"lineNumber": 93
},
"deprecated": false
}
@ -974,7 +974,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 93
"lineNumber": 99
},
"deprecated": false,
"children": [
@ -992,7 +992,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 97
"lineNumber": 103
},
"deprecated": false
},
@ -1010,7 +1010,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 101
"lineNumber": 107
},
"deprecated": false
},
@ -1025,7 +1025,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 105
"lineNumber": 111
},
"deprecated": false
},
@ -1043,7 +1043,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 109
"lineNumber": 115
},
"deprecated": false
}
@ -1061,7 +1061,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 46
"lineNumber": 52
},
"deprecated": false,
"children": [
@ -1077,7 +1077,7 @@
],
"source": {
"path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
"lineNumber": 47
"lineNumber": 53
},
"deprecated": false
}

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 { buildApiDecsForParameters } from './build_parameter_decs';
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';
/**
@ -66,7 +66,8 @@ export function getArrowFunctionDec(
anchorLink,
currentPluginId,
log,
captureReferences
captureReferences,
getJSDocs(node)
),
// need to override the signature - use the initializer, not the node.
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!.signature?.length).toBe(1);
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');
expect(p2).toBeDefined();
@ -53,12 +55,15 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p2!.type).toBe(TypeKind.NumberKind);
expect(p2!.signature?.length).toBe(1);
expect(linkCount(p2!.signature!)).toBe(0);
expect(p2?.description?.length).toBe(1);
const p3 = fn?.children!.find((c) => c.label === 'c');
expect(p3).toBeDefined();
expect(p3!.isRequired).toBe(true);
expect(p3!.type).toBe(TypeKind.ArrayKind);
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');
expect(p4).toBeDefined();
@ -66,6 +71,7 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p4!.type).toBe(TypeKind.CompoundTypeKind);
expect(p4!.signature?.length).toBe(1);
expect(linkCount(p4!.signature!)).toBe(1);
expect(p4?.description?.length).toBe(1);
const p5 = fn?.children!.find((c) => c.label === 'e');
expect(p5).toBeDefined();
@ -73,6 +79,7 @@ function fnIsCorrect(fn: ApiDeclaration | undefined) {
expect(p5!.type).toBe(TypeKind.StringKind);
expect(p5!.signature?.length).toBe(1);
expect(linkCount(p5!.signature!)).toBe(0);
expect(p5?.description?.length).toBe(1);
}
beforeAll(() => {

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

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