mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 09:48:58 -04:00
Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236)
* Fix the bug and update tests * update api docs * Fix tests
This commit is contained in:
parent
3d8a2cfcf1
commit
899a6f3f11
139 changed files with 14601 additions and 5062 deletions
|
@ -214,8 +214,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/actions/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
|
@ -1838,6 +1838,22 @@
|
|||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-common.requested",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "requested",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [K in keyof T as CamelToSnake<RenameActionToConnector<Extract<K, string>>>]: T[K]; }"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -1868,6 +1884,22 @@
|
|||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "actions",
|
||||
"id": "def-common.responded",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "responded",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "x-pack/plugins/actions/common/rewrite_request_case.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ import actionsObj from './actions.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 117 | 0 | 117 | 7 |
|
||||
| 119 | 0 | 119 | 7 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
@ -29,6 +29,48 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A URL that is meant to be relative to your application id, or a state object that your application uses to render\nthe rule. This information is intended to be used with cores NavigateToApp function, along with the application id that was\noriginally registered to {@link PluginSetupContract.registerNavigation}."
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.alert",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "alert",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ enabled: boolean; id: string; name: string; params: never; actions: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertAction",
|
||||
"text": "AlertAction"
|
||||
},
|
||||
"[]; throttle: string | null; tags: string[]; alertTypeId: string; consumer: string; schedule: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.IntervalSchedule",
|
||||
"text": "IntervalSchedule"
|
||||
},
|
||||
"; scheduledTaskId?: string | undefined; createdBy: string | null; updatedBy: string | null; createdAt: Date; updatedAt: Date; apiKeyOwner: string | null; notifyWhen: \"onActionGroupChange\" | \"onActiveAlert\" | \"onThrottleInterval\" | null; muteAll: boolean; mutedInstanceIds: string[]; executionStatus: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.AlertExecutionStatus",
|
||||
"text": "AlertExecutionStatus"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/alert_navigation_registry/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
@ -67,35 +109,42 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.applicationId",
|
||||
"id": "def-public.PluginSetupContract.registerNavigation.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "applicationId",
|
||||
"description": [
|
||||
"The application id that the user should be navigated to, to view a particular alert in a custom way."
|
||||
],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.ruleType",
|
||||
"id": "def-public.PluginSetupContract.registerNavigation.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "ruleType",
|
||||
"description": [
|
||||
"The rule type that has been registered with Alerting.Server.PluginSetupContract.registerType. If\nno such rule with that id exists, a warning is output to the console log. It used to throw an error, but that was temporarily moved\nbecause it was causing flaky test failures with https://github.com/elastic/kibana/issues/59229 and needs to be\ninvestigated more."
|
||||
],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.handler",
|
||||
"id": "def-public.PluginSetupContract.registerNavigation.$3",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
|
@ -103,21 +152,20 @@
|
|||
"The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details."
|
||||
],
|
||||
"signature": [
|
||||
"(alert: Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"scope": "public",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
|
||||
"JsonObject"
|
||||
"section": "def-public.AlertNavigationHandler",
|
||||
"text": "AlertNavigationHandler"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
@ -141,23 +189,26 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.applicationId",
|
||||
"id": "def-public.PluginSetupContract.registerDefaultNavigation.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "applicationId",
|
||||
"description": [
|
||||
"The application id that the user should be navigated to, to view a particular alert in a custom way."
|
||||
],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.handler",
|
||||
"id": "def-public.PluginSetupContract.registerDefaultNavigation.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
|
@ -165,21 +216,20 @@
|
|||
"The navigation handler should return either a relative URL, or a state object. This information can be used,\nin conjunction with the consumer id, to navigate the user to a custom URL to view a rule's details."
|
||||
],
|
||||
"signature": [
|
||||
"(alert: Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "common",
|
||||
"scope": "public",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-common.Alert",
|
||||
"text": "Alert"
|
||||
},
|
||||
"<never>, \"enabled\" | \"id\" | \"name\" | \"params\" | \"actions\" | \"throttle\" | \"tags\" | \"alertTypeId\" | \"consumer\" | \"schedule\" | \"scheduledTaskId\" | \"createdBy\" | \"updatedBy\" | \"createdAt\" | \"updatedAt\" | \"apiKeyOwner\" | \"notifyWhen\" | \"muteAll\" | \"mutedInstanceIds\" | \"executionStatus\">) => string | ",
|
||||
"JsonObject"
|
||||
"section": "def-public.AlertNavigationHandler",
|
||||
"text": "AlertNavigationHandler"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
@ -223,19 +273,23 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-public.alertId",
|
||||
"id": "def-public.PluginStartContract.getNavigation.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "alertId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
@ -955,8 +1009,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
@ -995,8 +1049,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
|
@ -1010,8 +1064,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1102,19 +1156,23 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "alerting",
|
||||
"id": "def-server.id",
|
||||
"id": "def-server.AlertServices.alertInstanceFactory.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/alerting/server/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1660,8 +1718,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/alerting/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -18,7 +18,7 @@ import alertingObj from './alerting.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 242 | 0 | 234 | 16 |
|
||||
| 243 | 0 | 235 | 16 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -3928,8 +3928,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/apm/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "apm",
|
||||
|
@ -3959,32 +3959,67 @@
|
|||
],
|
||||
"path": "x-pack/plugins/apm/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "apm",
|
||||
"id": "def-server.params",
|
||||
"id": "def-server.APMPluginSetup.createApmEventClient.$1.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ debug?: boolean | undefined; request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>; context: ",
|
||||
"ApmPluginRequestHandlerContext",
|
||||
"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/apm/server/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "apm",
|
||||
"id": "def-server.APMPluginSetup.createApmEventClient.$1.params.debug",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "debug",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/apm/server/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "apm",
|
||||
"id": "def-server.APMPluginSetup.createApmEventClient.$1.params.request",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "request",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"path": "x-pack/plugins/apm/server/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "apm",
|
||||
"id": "def-server.APMPluginSetup.createApmEventClient.$1.params.context",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ApmPluginRequestHandlerContext"
|
||||
],
|
||||
"path": "x-pack/plugins/apm/server/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact APM UI for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 39 | 0 | 39 | 30 |
|
||||
| 42 | 0 | 42 | 30 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -56,6 +56,35 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/public/batching/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-public.payload",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "payload",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Payload"
|
||||
],
|
||||
"path": "src/plugins/bfetch/public/batching/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-public.signal",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "signal",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"AbortSignal | undefined"
|
||||
],
|
||||
"path": "src/plugins/bfetch/public/batching/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
@ -86,11 +115,10 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-public.params",
|
||||
"id": "def-public.BfetchPublicContract.fetchStreaming.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
|
@ -99,9 +127,11 @@
|
|||
"FetchStreamingParams"
|
||||
],
|
||||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
@ -125,11 +155,10 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-public.params",
|
||||
"id": "def-public.BfetchPublicContract.batchedFunction.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
|
@ -139,9 +168,11 @@
|
|||
"<Payload, Result>"
|
||||
],
|
||||
"path": "src/plugins/bfetch/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
@ -184,11 +215,10 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.data",
|
||||
"id": "def-server.BatchProcessingRouteParams.onBatchItem.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "data",
|
||||
|
@ -197,9 +227,11 @@
|
|||
"BatchItemData"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -241,6 +273,48 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.context",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.RequestHandlerContext",
|
||||
"text": "RequestHandlerContext"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.request",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "request",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<P, Q, B, Method>"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
@ -283,21 +357,24 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.path",
|
||||
"id": "def-server.BfetchServerSetup.addBatchProcessingRoute.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "path",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.handler",
|
||||
"id": "def-server.BfetchServerSetup.addBatchProcessingRoute.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
|
@ -322,9 +399,11 @@
|
|||
"<BatchItemData, BatchItemResult>"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
@ -354,21 +433,24 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.path",
|
||||
"id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "path",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.params",
|
||||
"id": "def-server.BfetchServerSetup.addStreamingResponseRoute.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
|
@ -393,9 +475,11 @@
|
|||
"<Payload, Response>"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
@ -625,42 +709,30 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-server.streamHandler",
|
||||
"id": "def-server.BfetchServerSetup.createStreamingRequestHandler.$1",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "streamHandler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(context: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"pluginId": "bfetch",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.RequestHandlerContext",
|
||||
"text": "RequestHandlerContext"
|
||||
"docId": "kibBfetchPluginApi",
|
||||
"section": "def-server.StreamingRequestHandler",
|
||||
"text": "StreamingRequestHandler"
|
||||
},
|
||||
", request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<P, Q, B, Method>) => ",
|
||||
"Observable",
|
||||
"<Response> | Promise<",
|
||||
"Observable",
|
||||
"<Response>>"
|
||||
"<Response, P, Q, B, Method>"
|
||||
],
|
||||
"path": "src/plugins/bfetch/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
@ -1118,22 +1190,23 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-common.args",
|
||||
"id": "def-common.BatchedFunctionParams.onCall.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "args",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Func extends (...args: infer P) => any ? P : never"
|
||||
"Parameters<Func>"
|
||||
],
|
||||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
@ -1147,11 +1220,10 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-common.items",
|
||||
"id": "def-common.BatchedFunctionParams.onBatch.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "items",
|
||||
|
@ -1160,9 +1232,11 @@
|
|||
"BatchEntry[]"
|
||||
],
|
||||
"path": "src/plugins/bfetch/common/buffer/create_batched_function.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
|
@ -1393,11 +1467,10 @@
|
|||
],
|
||||
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "bfetch",
|
||||
"id": "def-common.items",
|
||||
"id": "def-common.ItemBufferParams.onFlush.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "items",
|
||||
|
@ -1406,9 +1479,11 @@
|
|||
"Item[]"
|
||||
],
|
||||
"path": "src/plugins/bfetch/common/buffer/item_buffer.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 73 | 1 | 62 | 2 |
|
||||
| 77 | 1 | 66 | 2 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -444,11 +444,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.theCase",
|
||||
"id": "def-public.AllCasesSelectorModalProps.onRowClick.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "theCase",
|
||||
|
@ -472,9 +471,11 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -495,7 +496,30 @@
|
|||
") => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.AllCasesSelectorModalProps.updateCase.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "newCase",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.Case",
|
||||
"text": "Case"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/all_cases/selector_modal/index.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -550,7 +574,30 @@
|
|||
") => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/case_view/index.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.CaseViewProps.onCaseDataSuccess.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.Case",
|
||||
"text": "Case"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/case_view/index.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -643,7 +690,44 @@
|
|||
", postComment: (args: PostComment) => Promise<void>) => Promise<void>) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/create/index.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.CreateCaseProps.afterCaseCreated.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "theCase",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.Case",
|
||||
"text": "Case"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/create/index.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.CreateCaseProps.afterCaseCreated.$2",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "postComment",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(args: PostComment) => Promise<void>"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/create/index.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -703,8 +787,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/components/create/index.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -726,11 +810,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/components/create/index.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.theCase",
|
||||
"id": "def-public.CreateCaseProps.onSuccess.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "theCase",
|
||||
|
@ -745,9 +828,11 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/components/create/index.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -911,13 +996,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A react component that displays all cases"
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.CasesUiStart.getAllCases.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -934,8 +1016,12 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"A react component that displays all cases"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -968,13 +1054,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A react component that is a modal for selecting a case"
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.CasesUiStart.getAllCasesSelectorModal.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -991,8 +1074,12 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"A react component that is a modal for selecting a case"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -1025,13 +1112,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A react component for viewing a specific case"
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.CasesUiStart.getCaseView.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -1048,8 +1132,12 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"A react component for viewing a specific case"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -1082,13 +1170,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A react component for configuring a specific case"
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.CasesUiStart.getConfigureCases.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -1105,8 +1190,12 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"A react component for configuring a specific case"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -1139,13 +1228,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A react component for creating a new case"
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.CasesUiStart.getCreateCase.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -1162,8 +1248,12 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"A react component for creating a new case"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -1196,13 +1286,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"A react component for showing recent cases"
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.CasesUiStart.getRecentCases.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -1219,8 +1306,12 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"A react component for showing recent cases"
|
||||
]
|
||||
}
|
||||
],
|
||||
|
@ -3941,7 +4032,52 @@
|
|||
"((caseId: string, caseConnectorId: string, subCaseId?: string | undefined) => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-common.UpdateByKey.fetchCaseUserActions.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "caseId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-common.UpdateByKey.fetchCaseUserActions.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "caseConnectorId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-common.UpdateByKey.fetchCaseUserActions.$3",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "subCaseId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -3962,7 +4098,30 @@
|
|||
") => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
"id": "def-common.UpdateByKey.updateCase.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "newCase",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "cases",
|
||||
"scope": "common",
|
||||
"docId": "kibCasesPluginApi",
|
||||
"section": "def-common.Case",
|
||||
"text": "Case"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -3994,7 +4153,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "cases",
|
||||
|
@ -4007,7 +4168,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/cases/common/ui/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Security Solution Threat Hunting](https://github.com/orgs/elastic/teams
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 451 | 0 | 409 | 14 |
|
||||
| 459 | 0 | 417 | 14 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -1354,11 +1354,10 @@
|
|||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.state",
|
||||
"id": "def-public.PaletteDefinition.toExpression.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
|
@ -1369,9 +1368,11 @@
|
|||
"T | undefined"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
@ -1403,11 +1404,10 @@
|
|||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.series",
|
||||
"id": "def-public.PaletteDefinition.getCategoricalColor.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "series",
|
||||
|
@ -1425,11 +1425,12 @@
|
|||
"[]"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.chartConfiguration",
|
||||
"id": "def-public.PaletteDefinition.getCategoricalColor.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "chartConfiguration",
|
||||
|
@ -1445,11 +1446,12 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.state",
|
||||
"id": "def-public.PaletteDefinition.getCategoricalColor.$3",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
|
@ -1460,9 +1462,11 @@
|
|||
"T | undefined"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
@ -1478,21 +1482,24 @@
|
|||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.size",
|
||||
"id": "def-public.PaletteDefinition.getCategoricalColors.$1",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "size",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.state",
|
||||
"id": "def-public.PaletteDefinition.getCategoricalColors.$2",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
|
@ -1501,9 +1508,11 @@
|
|||
"T | undefined"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
@ -1533,7 +1542,70 @@
|
|||
"((value: number | undefined, state: T, { min, max }: { min: number; max: number; }) => string | undefined) | undefined"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.PaletteDefinition.getColorForValue.$1",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "value",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number | undefined"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.PaletteDefinition.getColorForValue.$2",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.PaletteDefinition.getColorForValue.$3.minmax",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "{ min, max }",
|
||||
"description": [],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.PaletteDefinition.getColorForValue.$3.minmax.min",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "min",
|
||||
"description": [],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.PaletteDefinition.getColorForValue.$3.minmax.max",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "max",
|
||||
"description": [],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1627,19 +1699,23 @@
|
|||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
"id": "def-public.name",
|
||||
"id": "def-public.PaletteRegistry.get.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "charts",
|
||||
|
@ -1661,8 +1737,8 @@
|
|||
],
|
||||
"path": "src/plugins/charts/public/services/palettes/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 190 | 2 | 159 | 1 |
|
||||
| 195 | 2 | 164 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
1181
api_docs/core.json
1181
api_docs/core.json
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ import coreObj from './core.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2363 | 148 | 1081 | 31 |
|
||||
| 2450 | 149 | 1165 | 31 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -871,7 +871,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1495,31 +1497,29 @@
|
|||
"path": "x-pack/plugins/maps/target/types/public/routes/map_page/map_app/map_app.d.ts"
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.handler",
|
||||
"id": "def-public.AppMountParameters.onAppLeave.$1",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "handler",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(factory: ",
|
||||
"AppLeaveActionFactory",
|
||||
", nextAppId?: string | undefined) => ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppLeaveAction",
|
||||
"text": "AppLeaveAction"
|
||||
"section": "def-public.AppLeaveHandler",
|
||||
"text": "AppLeaveHandler"
|
||||
}
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
|
@ -1543,11 +1543,10 @@
|
|||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.menuMount",
|
||||
"id": "def-public.AppMountParameters.setHeaderActionMenu.$1",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "menuMount",
|
||||
|
@ -1563,9 +1562,11 @@
|
|||
"<HTMLElement> | undefined"
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1951,6 +1952,35 @@
|
|||
"path": "x-pack/plugins/security_solution/public/app/app.tsx"
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.factory",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "factory",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"AppLeaveActionFactory"
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.nextAppId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "nextAppId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -1991,6 +2021,31 @@
|
|||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"An unmounting function that will be called to unmount the application. See {@link AppUnmount}."
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.AppMountParameters",
|
||||
"text": "AppMountParameters"
|
||||
},
|
||||
"<HistoryLocationState>"
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -2007,6 +2062,8 @@
|
|||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -2079,6 +2136,29 @@
|
|||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.app",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "app",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCoreApplicationPluginApi",
|
||||
"section": "def-public.App",
|
||||
"text": "App"
|
||||
},
|
||||
"<unknown>"
|
||||
],
|
||||
"path": "src/core/public/application/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ import coreApplicationObj from './core_application.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2363 | 148 | 1081 | 31 |
|
||||
| 2450 | 149 | 1165 | 31 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -212,7 +212,24 @@
|
|||
"((element: HTMLDivElement) => () => void) | undefined"
|
||||
],
|
||||
"path": "src/core/public/chrome/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "core",
|
||||
"id": "def-public.ChromeHelpExtension.content.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "element",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"HTMLDivElement"
|
||||
],
|
||||
"path": "src/core/public/chrome/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -18,7 +18,7 @@ import coreChromeObj from './core_chrome.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2363 | 148 | 1081 | 31 |
|
||||
| 2450 | 149 | 1165 | 31 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ import coreHttpObj from './core_http.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2363 | 148 | 1081 | 31 |
|
||||
| 2450 | 149 | 1165 | 31 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ import coreSavedObjectsObj from './core_saved_objects.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2363 | 148 | 1081 | 31 |
|
||||
| 2450 | 149 | 1165 | 31 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -1222,7 +1222,8 @@
|
|||
"\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters."
|
||||
],
|
||||
"signature": [
|
||||
"any[] | undefined"
|
||||
"Filter",
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/locator.ts",
|
||||
"deprecated": false
|
||||
|
@ -1230,14 +1231,15 @@
|
|||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.DashboardAppLocatorParams.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
"\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."
|
||||
],
|
||||
"signature": [
|
||||
"any"
|
||||
"Query",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/locator.ts",
|
||||
"deprecated": false
|
||||
|
@ -1532,7 +1534,8 @@
|
|||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/types.ts",
|
||||
"deprecated": false
|
||||
|
@ -1550,12 +1553,12 @@
|
|||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.DashboardContainerInput.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"{ query: string | { [key: string]: any; }; language: string; }"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/types.ts",
|
||||
"deprecated": false
|
||||
|
@ -1961,7 +1964,8 @@
|
|||
"label": "getQuery",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => any"
|
||||
"() => ",
|
||||
"Query"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1976,7 +1980,9 @@
|
|||
"label": "getFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => any[]"
|
||||
"() => ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1995,11 +2001,10 @@
|
|||
],
|
||||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.editMode",
|
||||
"id": "def-public.DashboardSavedObject.getFullEditPath.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "editMode",
|
||||
|
@ -2008,9 +2013,11 @@
|
|||
"boolean | undefined"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/saved_dashboards/saved_dashboard.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -2097,7 +2104,8 @@
|
|||
"\nOptionally apply filers. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has filters saved with it, this will _replace_ those filters."
|
||||
],
|
||||
"signature": [
|
||||
"any[] | undefined"
|
||||
"Filter",
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/url_generator.ts",
|
||||
"deprecated": false
|
||||
|
@ -2105,14 +2113,15 @@
|
|||
{
|
||||
"parentPluginId": "dashboard",
|
||||
"id": "def-public.DashboardUrlGeneratorState.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
"\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."
|
||||
],
|
||||
"signature": [
|
||||
"any"
|
||||
"Query",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/dashboard/public/url_generator.ts",
|
||||
"deprecated": false
|
||||
|
@ -2508,8 +2517,8 @@
|
|||
],
|
||||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
|
@ -2523,8 +2532,8 @@
|
|||
],
|
||||
"path": "src/plugins/dashboard/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dashboard",
|
||||
|
|
|
@ -18,7 +18,7 @@ import dashboardObj from './dashboard.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 160 | 4 | 137 | 9 |
|
||||
| 160 | 1 | 137 | 9 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
3457
api_docs/data.json
3457
api_docs/data.json
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -381,6 +381,28 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.args",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "args",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
"docId": "kibDataAutocompletePluginApi",
|
||||
"section": "def-public.QuerySuggestionGetFnArgs",
|
||||
"text": "QuerySuggestionGetFnArgs"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/data/public/autocomplete/providers/query_suggestion_provider.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -3598,6 +3598,32 @@
|
|||
],
|
||||
"path": "src/plugins/data/common/field_formats/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.key",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "key",
|
||||
"description": [],
|
||||
"path": "src/plugins/data/common/types.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-common.defaultOverride",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "defaultOverride",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/common/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
File diff suppressed because one or more lines are too long
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
@ -82,7 +82,9 @@
|
|||
"label": "getFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => any[]"
|
||||
"() => ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -97,7 +99,9 @@
|
|||
"label": "getAppFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => any[]"
|
||||
"() => ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -112,7 +116,9 @@
|
|||
"label": "getGlobalFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => any[]"
|
||||
"() => ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -177,7 +183,11 @@
|
|||
"label": "addFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filters: any, pinFilterStatus?: boolean) => void"
|
||||
"(filters: ",
|
||||
"Filter",
|
||||
" | ",
|
||||
"Filter",
|
||||
"[], pinFilterStatus?: boolean) => void"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -185,12 +195,15 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.FilterManager.addFilters.$1",
|
||||
"type": "Any",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"Filter",
|
||||
" | ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -221,7 +234,9 @@
|
|||
"label": "setFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(newFilters: any[], pinFilterStatus?: boolean) => void"
|
||||
"(newFilters: ",
|
||||
"Filter",
|
||||
"[], pinFilterStatus?: boolean) => void"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -234,7 +249,8 @@
|
|||
"label": "newFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -267,7 +283,9 @@
|
|||
"\nSets new global filters and leaves app filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"
|
||||
],
|
||||
"signature": [
|
||||
"(newGlobalFilters: any[]) => void"
|
||||
"(newGlobalFilters: ",
|
||||
"Filter",
|
||||
"[]) => void"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -280,7 +298,8 @@
|
|||
"label": "newGlobalFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -299,7 +318,9 @@
|
|||
"\nSets new app filters and leaves global filters untouched,\nRemoves app filters for which there is a duplicate within new global filters"
|
||||
],
|
||||
"signature": [
|
||||
"(newAppFilters: any[]) => void"
|
||||
"(newAppFilters: ",
|
||||
"Filter",
|
||||
"[]) => void"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -312,7 +333,8 @@
|
|||
"label": "newAppFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -329,7 +351,9 @@
|
|||
"label": "removeFilter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filter: any) => void"
|
||||
"(filter: ",
|
||||
"Filter",
|
||||
") => void"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -337,12 +361,12 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.FilterManager.removeFilter.$1",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "filter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"Filter"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -374,7 +398,9 @@
|
|||
"label": "setFiltersStore",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filters: any[], store: ",
|
||||
"(filters: ",
|
||||
"Filter",
|
||||
"[], store: ",
|
||||
"FilterStateStore",
|
||||
", shouldOverrideStore?: boolean) => void"
|
||||
],
|
||||
|
@ -389,7 +415,8 @@
|
|||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/filter_manager.ts",
|
||||
"deprecated": false,
|
||||
|
@ -678,7 +705,9 @@
|
|||
"section": "def-public.QueryState",
|
||||
"text": "QueryState"
|
||||
},
|
||||
">({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ",
|
||||
">({ timefilter: { timefilter }, filterManager, queryString, state$, }: Pick<{ addToQueryLog: (appName: string, { language, query }: ",
|
||||
"Query",
|
||||
") => void; filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -734,7 +763,11 @@
|
|||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
"DslQuery",
|
||||
"[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ",
|
||||
"[]; filter: ",
|
||||
"Filter",
|
||||
"[]; should: never[]; must_not: ",
|
||||
"Filter",
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -787,7 +820,9 @@
|
|||
"label": "{\n timefilter: { timefilter },\n filterManager,\n queryString,\n state$,\n }",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ",
|
||||
"Pick<{ addToQueryLog: (appName: string, { language, query }: ",
|
||||
"Query",
|
||||
") => void; filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -843,7 +878,11 @@
|
|||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
"DslQuery",
|
||||
"[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ",
|
||||
"[]; filter: ",
|
||||
"Filter",
|
||||
"[]; should: never[]; must_not: ",
|
||||
"Filter",
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -1034,7 +1073,11 @@
|
|||
"label": "extractTimeRange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filters: any[], timeFieldName: string | undefined) => { restOfFilters: any[]; timeRange?: ",
|
||||
"(filters: ",
|
||||
"Filter",
|
||||
"[], timeFieldName: string | undefined) => { restOfFilters: ",
|
||||
"Filter",
|
||||
"[]; timeRange?: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
@ -1055,7 +1098,8 @@
|
|||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/timefilter/lib/extract_time_filter.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1105,7 +1149,9 @@
|
|||
"section": "def-common.IFieldType",
|
||||
"text": "IFieldType"
|
||||
},
|
||||
", values: any, operation: string, index: string) => any[]"
|
||||
", values: any, operation: string, index: string) => ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/lib/generate_filters.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1252,7 +1298,9 @@
|
|||
"label": "getDisplayValueFromFilter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filter: any, indexPatterns: ",
|
||||
"(filter: ",
|
||||
"Filter",
|
||||
", indexPatterns: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
@ -1268,12 +1316,12 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.getDisplayValueFromFilter.$1",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "filter",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"Filter"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/filter_manager/lib/get_display_value.ts",
|
||||
"deprecated": false,
|
||||
|
@ -1314,7 +1362,9 @@
|
|||
"\nHelper to setup syncing of global data with the URL"
|
||||
],
|
||||
"signature": [
|
||||
"(query: Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ",
|
||||
"(query: Pick<{ addToQueryLog: (appName: string, { language, query }: ",
|
||||
"Query",
|
||||
") => void; filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -1370,7 +1420,11 @@
|
|||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
"DslQuery",
|
||||
"[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ",
|
||||
"[]; filter: ",
|
||||
"Filter",
|
||||
"[]; should: never[]; must_not: ",
|
||||
"Filter",
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -1421,7 +1475,9 @@
|
|||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ",
|
||||
"Pick<{ addToQueryLog: (appName: string, { language, query }: ",
|
||||
"Query",
|
||||
") => void; filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -1477,7 +1533,11 @@
|
|||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
"DslQuery",
|
||||
"[]; filter: any[]; should: never[]; must_not: any[]; }; }; } | { filterManager: ",
|
||||
"[]; filter: ",
|
||||
"Filter",
|
||||
"[]; should: never[]; must_not: ",
|
||||
"Filter",
|
||||
"[]; }; }; } | { filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -1601,7 +1661,8 @@
|
|||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[] | undefined"
|
||||
"Filter",
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/state_sync/types.ts",
|
||||
"deprecated": false
|
||||
|
@ -1609,12 +1670,13 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.QueryState.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"Query",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/state_sync/types.ts",
|
||||
"deprecated": false
|
||||
|
@ -1739,11 +1801,10 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.attributes",
|
||||
"id": "def-public.SavedQueryService.saveQuery.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "attributes",
|
||||
|
@ -1752,22 +1813,33 @@
|
|||
"SavedQueryAttributes"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.config",
|
||||
"id": "def-public.SavedQueryService.saveQuery.$2.config",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ overwrite: boolean; } | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.SavedQueryService.saveQuery.$2.config.overwrite",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "overwrite",
|
||||
"description": [],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -1789,8 +1861,8 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -1812,11 +1884,10 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.searchText",
|
||||
"id": "def-public.SavedQueryService.findSavedQueries.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "searchText",
|
||||
|
@ -1825,11 +1896,12 @@
|
|||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.perPage",
|
||||
"id": "def-public.SavedQueryService.findSavedQueries.$2",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "perPage",
|
||||
|
@ -1838,11 +1910,12 @@
|
|||
"number | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.activePage",
|
||||
"id": "def-public.SavedQueryService.findSavedQueries.$3",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "activePage",
|
||||
|
@ -1851,9 +1924,11 @@
|
|||
"number | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -1875,19 +1950,23 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.SavedQueryService.getSavedQuery.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -1901,19 +1980,23 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.SavedQueryService.deleteSavedQuery.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -1927,8 +2010,8 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/saved_query/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1948,6 +2031,8 @@
|
|||
],
|
||||
"path": "src/plugins/data/public/query/timefilter/lib/auto_refresh_loop.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -1979,7 +2064,9 @@
|
|||
"label": "QueryStart",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ addToQueryLog: (appName: string, { language, query }: any) => void; filterManager: ",
|
||||
"{ addToQueryLog: (appName: string, { language, query }: ",
|
||||
"Query",
|
||||
") => void; filterManager: ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "public",
|
||||
|
@ -2035,7 +2122,11 @@
|
|||
},
|
||||
" | undefined) => { bool: { must: ",
|
||||
"DslQuery",
|
||||
"[]; filter: any[]; should: never[]; must_not: any[]; }; }; }"
|
||||
"[]; filter: ",
|
||||
"Filter",
|
||||
"[]; should: never[]; must_not: ",
|
||||
"Filter",
|
||||
"[]; }; }; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/query/query_service.ts",
|
||||
"deprecated": false,
|
||||
|
@ -2152,7 +2243,9 @@
|
|||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
" | undefined) => any; getBounds: () => ",
|
||||
" | undefined) => ",
|
||||
"RangeFilter",
|
||||
" | undefined; getBounds: () => ",
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
|
@ -2417,7 +2510,9 @@
|
|||
"section": "def-common.TimeRange",
|
||||
"text": "TimeRange"
|
||||
},
|
||||
", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => any"
|
||||
", options: { forceNow?: Date | undefined; fieldName?: string | undefined; } | undefined) => ",
|
||||
"RangeFilter",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/common/query/timefilter/get_time.ts",
|
||||
"deprecated": false,
|
||||
|
@ -2513,7 +2608,8 @@
|
|||
"label": "isQuery",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(x: unknown) => x is any"
|
||||
"(x: unknown) => x is ",
|
||||
"Query"
|
||||
],
|
||||
"path": "src/plugins/data/common/query/is_query.ts",
|
||||
"deprecated": false,
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -150,12 +150,12 @@
|
|||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.QueryStringInputProps.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"{ query: string | { [key: string]: any; }; language: string; }"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false
|
||||
|
@ -276,7 +276,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -286,10 +288,29 @@
|
|||
"label": "onChange",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"((query: any) => void) | undefined"
|
||||
"((query: ",
|
||||
"Query",
|
||||
") => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.QueryStringInputProps.onChange.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Query"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -302,7 +323,24 @@
|
|||
"((isFocused: boolean) => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.QueryStringInputProps.onChangeQueryInputFocus.$1",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isFocused",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
@ -312,10 +350,29 @@
|
|||
"label": "onSubmit",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"((query: any) => void) | undefined"
|
||||
"((query: ",
|
||||
"Query",
|
||||
") => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
"id": "def-public.QueryStringInputProps.onSubmit.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Query"
|
||||
],
|
||||
"path": "src/plugins/data/public/ui/query_string_input/query_string_input.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "data",
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 3870 | 151 | 3322 | 63 |
|
||||
| 3994 | 85 | 3446 | 63 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -230,6 +230,35 @@
|
|||
],
|
||||
"path": "x-pack/plugins/data_visualizer/public/application/file_data_visualizer/file_data_visualizer.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataVisualizer",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataVisualizer",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -252,6 +281,35 @@
|
|||
],
|
||||
"path": "x-pack/plugins/data_visualizer/public/application/index_data_visualizer/index_data_visualizer.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "dataVisualizer",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "dataVisualizer",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 104 | 3 | 104 | 0 |
|
||||
| 108 | 5 | 108 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -14,17 +14,14 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
| <DocLink id="kibDataPluginApi" section="def-public.castEsToKbnFieldTypeName" text="castEsToKbnFieldTypeName"/> | indexPatternFieldEditor, savedObjectsManagement | 8.0 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.castEsToKbnFieldTypeName" text="castEsToKbnFieldTypeName"/> | indexPatternFieldEditor, savedObjectsManagement | 8.0 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.castEsToKbnFieldTypeName" text="castEsToKbnFieldTypeName"/> | indexPatternFieldEditor, savedObjectsManagement | 8.0 |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyCustomClusterClient" text="ILegacyCustomClusterClient"/> | indexManagement | 7.16 |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.LegacyScopedClusterClient" text="LegacyScopedClusterClient"/> | indexManagement | 7.16 |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | indexManagement, globalSearch | 7.16 |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.LegacyAPICaller" text="LegacyAPICaller"/> | crossClusterReplication, indexLifecycleManagement | 7.16 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | savedObjects, observability, timelines, infra, ml, securitySolution, maps, stackAlerts, transform | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | savedObjects, observability, timelines, infra, ml, securitySolution, maps, stackAlerts, transform | - |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | globalSearch | 7.16 |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | observability, timelines, infra, ml, securitySolution, stackAlerts, transform | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esFilters" text="esFilters"/> | discover, visualizations, dashboard, lens, observability, maps, canvas, dashboardEnhanced, discoverEnhanced, securitySolution | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.ExistsFilter" text="ExistsFilter"/> | observability | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.ExistsFilter" text="ExistsFilter"/> | observability | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | observability, timelines, infra, ml, securitySolution, stackAlerts, transform | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.Filter" text="Filter"/> | canvas, discover, visualizations, dashboard, lens, observability, timelines, maps, infra, dashboardEnhanced, discoverEnhanced, securitySolution, urlDrilldown, lists, ml, visTypeTimeseries | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IFieldSubType" text="IFieldSubType"/> | timelines | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.esKuery" text="esKuery"/> | fleet, lens, timelines, infra, dataVisualizer, ml, apm, securitySolution, stackAlerts, transform, uptime | - |
|
||||
|
|
|
@ -177,16 +177,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
|
||||
|
||||
## crossClusterReplication
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.LegacyAPICaller" text="LegacyAPICaller"/> | [plugin.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#:~:text=LegacyAPICaller), [plugin.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/cross_cluster_replication/server/plugin.ts#:~:text=LegacyAPICaller) | 7.16 |
|
||||
|
||||
|
||||
|
||||
## dashboard
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
@ -572,38 +562,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
|
||||
|
||||
## indexLifecycleManagement
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.LegacyAPICaller" text="LegacyAPICaller"/> | [plugin.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/plugin.ts#:~:text=LegacyAPICaller), [plugin.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_lifecycle_management/server/plugin.ts#:~:text=LegacyAPICaller) | 7.16 |
|
||||
|
||||
|
||||
|
||||
## indexManagement
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyCustomClusterClient" text="ILegacyCustomClusterClient"/> | [plugin.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#:~:text=ILegacyCustomClusterClient), [plugin.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/plugin.ts#:~:text=ILegacyCustomClusterClient) | 7.16 |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.LegacyScopedClusterClient" text="LegacyScopedClusterClient"/> | [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=LegacyScopedClusterClient), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=LegacyScopedClusterClient), [types.d.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=LegacyScopedClusterClient), [types.d.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=LegacyScopedClusterClient) | 7.16 |
|
||||
| <DocLink id="kibCorePluginApi" section="def-server.ILegacyScopedClusterClient" text="ILegacyScopedClusterClient"/> | [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=ILegacyScopedClusterClient), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=ILegacyScopedClusterClient), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/server/types.ts#:~:text=ILegacyScopedClusterClient), [types.d.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=ILegacyScopedClusterClient), [types.d.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=ILegacyScopedClusterClient), [types.d.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/index_management/target/types/server/types.d.ts#:~:text=ILegacyScopedClusterClient) | 7.16 |
|
||||
|
||||
|
||||
|
||||
## indexPatternFieldEditor
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
@ -829,9 +787,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IFieldType" text="IFieldType"/> | [es_doc_field.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_doc_field.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_source.ts
|
||||
|
@ -887,9 +842,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#:~:text=IFieldType), [index_pattern_util.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#:~:text=IFieldType), [index_pattern_util.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/index_pattern_util.ts#:~:text=IFieldType)+ 84 more | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/embeddable/types.ts#:~:text=IIndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-server.IFieldType" text="IFieldType"/> | [es_doc_field.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_doc_field.ts
|
||||
](https://github.com/elastic/kibana/tree/master/x-pack/plugins/maps/public/classes/fields/es_doc_field.ts#:~:text=IFieldType), [es_source.ts
|
||||
|
@ -1078,21 +1030,6 @@ warning: This document is auto-generated and is meant to be viewed inside our ex
|
|||
|
||||
|
||||
|
||||
## savedObjects
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
| ---------------|-----------|-----------|
|
||||
| <DocLink id="kibDataPluginApi" section="def-public.IIndexPattern" text="IIndexPattern"/> | [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern) | - |
|
||||
| <DocLink id="kibDataPluginApi" section="def-common.IIndexPattern" text="IIndexPattern"/> | [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern), [types.ts
|
||||
](https://github.com/elastic/kibana/tree/master/src/plugins/saved_objects/public/types.ts#:~:text=IIndexPattern) | - |
|
||||
|
||||
|
||||
|
||||
## savedObjectsManagement
|
||||
|
||||
| Deprecated API | Reference location(s) | Remove By |
|
||||
|
|
|
@ -178,11 +178,10 @@
|
|||
],
|
||||
"path": "src/plugins/dev_tools/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "devTools",
|
||||
"id": "def-public.devTool",
|
||||
"id": "def-public.DevToolsSetup.register.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "devTool",
|
||||
|
@ -190,14 +189,14 @@
|
|||
"The dev tools descriptor"
|
||||
],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"DevToolApp",
|
||||
", \"title\" | \"id\" | \"order\" | \"mount\" | \"tooltipContent\" | \"enableRouting\"> & { disabled?: boolean | undefined; }"
|
||||
"CreateDevToolArgs"
|
||||
],
|
||||
"path": "src/plugins/dev_tools/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
@ -181,7 +181,8 @@
|
|||
"\nOptionally apply filters."
|
||||
],
|
||||
"signature": [
|
||||
"any[] | undefined"
|
||||
"Filter",
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/locator.ts",
|
||||
"deprecated": false
|
||||
|
@ -189,14 +190,15 @@
|
|||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.DiscoverAppLocatorParams.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
"\nOptionally set a query."
|
||||
],
|
||||
"signature": [
|
||||
"any"
|
||||
"Query",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/locator.ts",
|
||||
"deprecated": false
|
||||
|
@ -396,7 +398,8 @@
|
|||
"\nOptionally apply filters."
|
||||
],
|
||||
"signature": [
|
||||
"any[] | undefined"
|
||||
"Filter",
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/url_generator.ts",
|
||||
"deprecated": false
|
||||
|
@ -404,14 +407,15 @@
|
|||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.DiscoverUrlGeneratorState.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [
|
||||
"\nOptionally set a query. NOTE: if given and used in conjunction with `dashboardId`, and the\nsaved dashboard has a query saved with it, this will _replace_ that query."
|
||||
],
|
||||
"signature": [
|
||||
"any"
|
||||
"Query",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/url_generator.ts",
|
||||
"deprecated": false
|
||||
|
@ -686,8 +690,8 @@
|
|||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
|
@ -709,11 +713,10 @@
|
|||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.saveOptions",
|
||||
"id": "def-public.SavedSearch.save.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "saveOptions",
|
||||
|
@ -728,9 +731,11 @@
|
|||
}
|
||||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
|
@ -804,19 +809,23 @@
|
|||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.SavedSearchLoader.get.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
|
@ -830,19 +839,23 @@
|
|||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.SavedSearchLoader.urlFor.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/discover/public/saved_searches/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -890,12 +903,13 @@
|
|||
{
|
||||
"parentPluginId": "discover",
|
||||
"id": "def-public.SearchInput.query",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"Query",
|
||||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/application/embeddable/types.ts",
|
||||
"deprecated": false
|
||||
|
@ -908,7 +922,8 @@
|
|||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[] | undefined"
|
||||
"Filter",
|
||||
"[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/discover/public/application/embeddable/types.ts",
|
||||
"deprecated": false
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 81 | 3 | 55 | 6 |
|
||||
| 81 | 0 | 55 | 6 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -5797,8 +5797,8 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/lib/embeddables/embeddable_factory.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -7783,11 +7783,10 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.input",
|
||||
"id": "def-public.ReferenceOrValueEmbeddable.inputIsRefType.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "input",
|
||||
|
@ -7796,9 +7795,11 @@
|
|||
"ValTypeInput | RefTypeInput"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -7814,8 +7815,8 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -7831,8 +7832,8 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/lib/reference_or_value_embeddable/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -8139,6 +8140,35 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -8419,52 +8449,46 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.EmbeddableSetup.registerEmbeddableFactory.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.factory",
|
||||
"id": "def-public.EmbeddableSetup.registerEmbeddableFactory.$2",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "factory",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableFactory",
|
||||
"text": "EmbeddableFactory"
|
||||
"section": "def-public.EmbeddableFactoryDefinition",
|
||||
"text": "EmbeddableFactoryDefinition"
|
||||
},
|
||||
"<I, O, E, ",
|
||||
"SavedObjectAttributes",
|
||||
">, \"type\" | \"create\" | \"isEditable\" | \"getDisplayName\"> & Partial<Pick<",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableFactory",
|
||||
"text": "EmbeddableFactory"
|
||||
},
|
||||
"<I, O, E, ",
|
||||
"SavedObjectAttributes",
|
||||
">, \"createFromSavedObject\" | \"isContainerType\" | \"getExplicitInput\" | \"savedObjectMetaData\" | \"canCreateNew\" | \"getDefaultInput\" | \"telemetry\" | \"extract\" | \"inject\" | \"migrations\" | \"grouping\" | \"getIconType\" | \"getDescription\">>"
|
||||
">"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -8494,11 +8518,10 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.enhancement",
|
||||
"id": "def-public.EmbeddableSetup.registerEnhancement.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "enhancement",
|
||||
|
@ -8522,9 +8545,11 @@
|
|||
">"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -8540,90 +8565,23 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.customProvider",
|
||||
"id": "def-public.EmbeddableSetup.setCustomEmbeddableFactoryProvider.$1",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "customProvider",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"<I extends ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableInput",
|
||||
"text": "EmbeddableInput"
|
||||
},
|
||||
" = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "common",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-common.EmbeddableInput",
|
||||
"text": "EmbeddableInput"
|
||||
},
|
||||
", O extends ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableOutput",
|
||||
"text": "EmbeddableOutput"
|
||||
},
|
||||
" = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableOutput",
|
||||
"text": "EmbeddableOutput"
|
||||
},
|
||||
", E extends ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IEmbeddable",
|
||||
"text": "IEmbeddable"
|
||||
},
|
||||
"<I, O> = ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.IEmbeddable",
|
||||
"text": "IEmbeddable"
|
||||
},
|
||||
"<I, O>, T extends ",
|
||||
"SavedObjectAttributes",
|
||||
" = ",
|
||||
"SavedObjectAttributes",
|
||||
">(def: ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableFactoryDefinition",
|
||||
"text": "EmbeddableFactoryDefinition"
|
||||
},
|
||||
"<I, O, E, T>) => ",
|
||||
{
|
||||
"pluginId": "embeddable",
|
||||
"scope": "public",
|
||||
"docId": "kibEmbeddablePluginApi",
|
||||
"section": "def-public.EmbeddableFactory",
|
||||
"text": "EmbeddableFactory"
|
||||
},
|
||||
"<I, O, E, T>"
|
||||
"EmbeddableFactoryProvider"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
@ -8735,19 +8693,23 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.embeddableFactoryId",
|
||||
"id": "def-public.EmbeddableStart.getEmbeddableFactory.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "embeddableFactoryId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -8811,8 +8773,8 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -8907,11 +8869,10 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.storage",
|
||||
"id": "def-public.EmbeddableStart.getStateTransfer.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "storage",
|
||||
|
@ -8927,9 +8888,11 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -8985,21 +8948,24 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.type",
|
||||
"id": "def-public.EmbeddableStart.getAttributeService.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-public.options",
|
||||
"id": "def-public.EmbeddableStart.getAttributeService.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
|
@ -9009,9 +8975,11 @@
|
|||
"<A>"
|
||||
],
|
||||
"path": "src/plugins/embeddable/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
@ -9172,11 +9140,10 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-server.factory",
|
||||
"id": "def-server.EmbeddableSetup.registerEmbeddableFactory.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "factory",
|
||||
|
@ -9200,9 +9167,11 @@
|
|||
">"
|
||||
],
|
||||
"path": "src/plugins/embeddable/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -9232,11 +9201,10 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-server.enhancement",
|
||||
"id": "def-server.EmbeddableSetup.registerEnhancement.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "enhancement",
|
||||
|
@ -9260,9 +9228,11 @@
|
|||
">"
|
||||
],
|
||||
"path": "src/plugins/embeddable/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -9283,8 +9253,8 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
@ -9822,19 +9792,23 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-common.embeddableFactoryId",
|
||||
"id": "def-common.CommonEmbeddableStartContract.getEmbeddableFactory.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "embeddableFactoryId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/embeddable/common/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
|
@ -9848,19 +9822,23 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-common.enhancementId",
|
||||
"id": "def-common.CommonEmbeddableStartContract.getEnhancement.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "enhancementId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/embeddable/common/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -10073,6 +10051,40 @@
|
|||
],
|
||||
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-common.state",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "state",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: ",
|
||||
{
|
||||
"pluginId": "kibanaUtils",
|
||||
"scope": "common",
|
||||
"docId": "kibKibanaUtilsPluginApi",
|
||||
"section": "def-common.Serializable",
|
||||
"text": "Serializable"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "embeddable",
|
||||
"id": "def-common.version",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "version",
|
||||
"description": [],
|
||||
"path": "src/plugins/embeddable/common/lib/migrate.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ import embeddableObj from './embeddable.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 456 | 4 | 384 | 3 |
|
||||
| 460 | 5 | 388 | 3 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -155,31 +155,38 @@
|
|||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.type",
|
||||
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "type",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.id",
|
||||
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.options",
|
||||
"id": "def-server.EncryptedSavedObjectsClient.getDecryptedAsInternalUser.$3",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
|
@ -195,9 +202,11 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -294,6 +303,37 @@
|
|||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.encryptedDoc",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "encryptedDoc",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<InputAttributes> | ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreSavedObjectsPluginApi",
|
||||
"section": "def-server.SavedObjectUnsanitizedDoc",
|
||||
"text": "SavedObjectUnsanitizedDoc"
|
||||
},
|
||||
"<MigratedAttributes>"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/create_migration.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
@ -340,11 +380,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.typeRegistration",
|
||||
"id": "def-server.EncryptedSavedObjectsPluginSetup.registerType.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "typeRegistration",
|
||||
|
@ -359,9 +398,11 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
|
@ -421,11 +462,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
"id": "def-server.error",
|
||||
"id": "def-server.EncryptedSavedObjectsPluginStart.isEncryptionError.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "error",
|
||||
|
@ -434,9 +474,11 @@
|
|||
"Error"
|
||||
],
|
||||
"path": "x-pack/plugins/encrypted_saved_objects/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "encryptedSavedObjects",
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-securit
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 28 | 0 | 26 | 4 |
|
||||
| 29 | 0 | 27 | 4 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
@ -1065,7 +1065,24 @@
|
|||
"((data: any) => any) | undefined"
|
||||
],
|
||||
"path": "src/plugins/es_ui_shared/public/request/use_request.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-public.UseRequestConfig.deserializer.$1",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "data",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "src/plugins/es_ui_shared/public/request/use_request.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1148,8 +1165,8 @@
|
|||
],
|
||||
"path": "src/plugins/es_ui_shared/public/request/use_request.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1191,6 +1208,29 @@
|
|||
],
|
||||
"path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-public.arg",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "arg",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "esUiShared",
|
||||
"scope": "public",
|
||||
"docId": "kibEsUiSharedPluginApi",
|
||||
"section": "def-public.JsonEditorState",
|
||||
"text": "JsonEditorState"
|
||||
},
|
||||
"<T>"
|
||||
],
|
||||
"path": "src/plugins/es_ui_shared/public/components/json_editor/use_json.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
@ -1364,37 +1404,6 @@
|
|||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-server.isEsError",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "isEsError",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(err: RequestError) => boolean"
|
||||
],
|
||||
"path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-server.isEsError.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "err",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"RequestError"
|
||||
],
|
||||
"path": "src/plugins/es_ui_shared/__packages_do_not_import__/errors/is_es_error.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "esUiShared",
|
||||
"id": "def-server.parseEsError",
|
||||
|
|
|
@ -18,7 +18,7 @@ import esUiSharedObj from './es_ui_shared.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 92 | 4 | 90 | 1 |
|
||||
| 92 | 5 | 90 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -355,6 +355,8 @@
|
|||
],
|
||||
"path": "src/plugins/expression_repeat_image/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -596,8 +596,8 @@
|
|||
],
|
||||
"path": "src/plugins/expression_shape/public/components/reusable/types.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -896,6 +896,8 @@
|
|||
],
|
||||
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -1408,6 +1410,8 @@
|
|||
],
|
||||
"path": "src/plugins/expression_shape/common/types/expression_functions.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ import expressionsObj from './expressions.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 2004 | 58 | 1569 | 5 |
|
||||
| 2030 | 65 | 1595 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -2143,7 +2143,23 @@
|
|||
"(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "features",
|
||||
"id": "def-server.licenseType",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "licenseType",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
|
||||
],
|
||||
"path": "x-pack/plugins/features/server/feature_privilege_iterator/sub_feature_privilege_iterator.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
|
@ -18,7 +18,7 @@ import featuresObj from './features.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 215 | 0 | 97 | 2 |
|
||||
| 216 | 0 | 98 | 2 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -102,11 +102,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.geojsonFile",
|
||||
"id": "def-public.FileUploadComponentProps.onFileSelect.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "geojsonFile",
|
||||
|
@ -115,29 +114,39 @@
|
|||
"GeoJSON.FeatureCollection<GeoJSON.Geometry, GeoJSON.GeoJsonProperties>"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.name",
|
||||
"id": "def-public.FileUploadComponentProps.onFileSelect.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.previewCoverage",
|
||||
"id": "def-public.FileUploadComponentProps.onFileSelect.$3",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "previewCoverage",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -151,8 +160,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -166,8 +175,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -181,8 +190,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -204,11 +213,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.results",
|
||||
"id": "def-public.FileUploadComponentProps.onUploadComplete.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "results",
|
||||
|
@ -223,9 +231,11 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -239,8 +249,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/lazy_load_bundle/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -791,21 +801,24 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.name",
|
||||
"id": "def-public.Props.onIndexNameChange.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "name",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
"id": "def-public.error",
|
||||
"id": "def-public.Props.onIndexNameChange.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "error",
|
||||
|
@ -814,9 +827,11 @@
|
|||
"string | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -830,8 +845,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fileUpload",
|
||||
|
@ -845,8 +860,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/file_upload/public/components/geojson_upload_form/index_name_form.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -962,30 +962,54 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.opts",
|
||||
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.opts",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "opts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ isValid: boolean; updatedPolicy: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.NewPackagePolicy",
|
||||
"text": "NewPackagePolicy"
|
||||
},
|
||||
"; }"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.opts.isValid",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isValid",
|
||||
"description": [
|
||||
"is current form state is valid"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyCreateExtensionComponentProps.onChange.$1.opts.updatedPolicy",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "updatedPolicy",
|
||||
"description": [
|
||||
"The updated Integration Policy to be merged back and included in the API call"
|
||||
],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.NewPackagePolicy",
|
||||
"text": "NewPackagePolicy"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1163,30 +1187,131 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.opts",
|
||||
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.opts",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "opts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ isValid: boolean; updatedPolicy: Partial<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.NewPackagePolicy",
|
||||
"text": "NewPackagePolicy"
|
||||
},
|
||||
">; }"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.opts.isValid",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "isValid",
|
||||
"description": [
|
||||
"is current form state is valid"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyEditExtensionComponentProps.onChange.$1.opts.updatedPolicy",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "updatedPolicy",
|
||||
"description": [
|
||||
"The updated Integration Policy to be merged back and included in the API call"
|
||||
],
|
||||
"signature": [
|
||||
"{ name?: string | undefined; description?: string | undefined; namespace?: string | undefined; enabled?: boolean | undefined; policy_id?: string | undefined; output_id?: string | undefined; package?: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.PackagePolicyPackage",
|
||||
"text": "PackagePolicyPackage"
|
||||
},
|
||||
" | undefined; inputs?: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.NewPackagePolicyInput",
|
||||
"text": "NewPackagePolicyInput"
|
||||
},
|
||||
"[] | undefined; vars?: Record<string, ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.PackagePolicyConfigRecordEntry",
|
||||
"text": "PackagePolicyConfigRecordEntry"
|
||||
},
|
||||
"> | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyEditTabsExtension",
|
||||
"type": "Interface",
|
||||
"tags": [],
|
||||
"label": "PackagePolicyEditTabsExtension",
|
||||
"description": [
|
||||
"Extension point registration contract for Integration Policy Edit tabs views"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyEditTabsExtension.package",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "package",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyEditTabsExtension.view",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "view",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"\"package-policy-edit-tabs\""
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.PackagePolicyEditTabsExtension.tabs",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "tabs",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ title: string; Component: React.LazyExoticComponent<React.ComponentType<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackagePolicyEditExtensionComponentProps",
|
||||
"text": "PackagePolicyEditExtensionComponentProps"
|
||||
},
|
||||
">>; }[]"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1390,6 +1515,14 @@
|
|||
"text": "PackagePolicyEditExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackagePolicyEditTabsExtension",
|
||||
"text": "PackagePolicyEditTabsExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
|
@ -1448,6 +1581,68 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-public.extensionPoint",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "extensionPoint",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackagePolicyEditExtension",
|
||||
"text": "PackagePolicyEditExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackagePolicyEditTabsExtension",
|
||||
"text": "PackagePolicyEditTabsExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackageCustomExtension",
|
||||
"text": "PackageCustomExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackagePolicyCreateExtension",
|
||||
"text": "PackagePolicyCreateExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackageAssetsExtension",
|
||||
"text": "PackageAssetsExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.AgentEnrollmentFlyoutFinalStepExtension",
|
||||
"text": "AgentEnrollmentFlyoutFinalStepExtension"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/public/types/ui_extensions.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
@ -2082,6 +2277,14 @@
|
|||
"text": "PackagePolicyEditExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-public.PackagePolicyEditTabsExtension",
|
||||
"text": "PackagePolicyEditTabsExtension"
|
||||
},
|
||||
" | ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "public",
|
||||
|
@ -2131,8 +2334,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
@ -5079,8 +5282,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
|
@ -5195,86 +5398,29 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.args",
|
||||
"id": "def-server.FleetStartContract.registerExternalCallback.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "args",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"[\"packagePolicyCreate\", (newPackagePolicy: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.NewPackagePolicy",
|
||||
"text": "NewPackagePolicy"
|
||||
},
|
||||
", context: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.RequestHandlerContext",
|
||||
"text": "RequestHandlerContext"
|
||||
},
|
||||
", request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => Promise<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.NewPackagePolicy",
|
||||
"text": "NewPackagePolicy"
|
||||
},
|
||||
">] | [\"packagePolicyUpdate\", (newPackagePolicy: ",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.UpdatePackagePolicy",
|
||||
"text": "UpdatePackagePolicy"
|
||||
},
|
||||
", context: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.RequestHandlerContext",
|
||||
"text": "RequestHandlerContext"
|
||||
},
|
||||
", request: ",
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCoreHttpPluginApi",
|
||||
"section": "def-server.KibanaRequest",
|
||||
"text": "KibanaRequest"
|
||||
},
|
||||
"<unknown, unknown, unknown, any>) => Promise<",
|
||||
{
|
||||
"pluginId": "fleet",
|
||||
"scope": "common",
|
||||
"docId": "kibFleetPluginApi",
|
||||
"section": "def-common.UpdatePackagePolicy",
|
||||
"text": "UpdatePackagePolicy"
|
||||
},
|
||||
">]"
|
||||
"section": "def-server.ExternalCallback",
|
||||
"text": "ExternalCallback"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
|
@ -5291,19 +5437,23 @@
|
|||
],
|
||||
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "fleet",
|
||||
"id": "def-server.packageName",
|
||||
"id": "def-server.FleetStartContract.createArtifactsClient.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "packageName",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/fleet/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
@ -18,7 +18,7 @@ import fleetObj from './fleet.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 1140 | 15 | 1045 | 8 |
|
||||
| 1149 | 15 | 1049 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -398,8 +398,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/global_search/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -948,11 +948,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "globalSearch",
|
||||
"id": "def-server.context",
|
||||
"id": "def-server.GlobalSearchResultProvider.getSearchableTypes.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
|
@ -967,9 +966,11 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1066,8 +1067,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/global_search/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -241,7 +241,9 @@
|
|||
"(() => boolean) | undefined"
|
||||
],
|
||||
"path": "src/plugins/home/public/services/feature_catalogue/feature_catalogue_registry.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
|
@ -461,6 +463,35 @@
|
|||
],
|
||||
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -475,6 +506,35 @@
|
|||
],
|
||||
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -489,6 +549,35 @@
|
|||
],
|
||||
"path": "src/plugins/home/public/services/tutorials/tutorial_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -951,6 +1040,8 @@
|
|||
],
|
||||
"path": "src/plugins/home/server/services/sample_data/lib/sample_dataset_registry_types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -967,6 +1058,22 @@
|
|||
],
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "home",
|
||||
"id": "def-server.context",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"TutorialContext"
|
||||
],
|
||||
"path": "src/plugins/home/server/services/tutorials/lib/tutorials_registry_types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ import homeObj from './home.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 94 | 0 | 70 | 5 |
|
||||
| 101 | 3 | 77 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -314,22 +314,34 @@
|
|||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
"id": "def-public.newParams",
|
||||
"id": "def-public.FormatEditorProps.onChange.$1.newParams",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "newParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [key: string]: any; }"
|
||||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
"id": "def-public.FormatEditorProps.onChange.$1.newParams.Unnamed",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "Unnamed",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
|
@ -405,7 +417,24 @@
|
|||
"((fieldNames: string[]) => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
"id": "def-public.OpenFieldDeleteModalOptions.onDelete.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "fieldNames",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string[]"
|
||||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/open_delete_modal.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
|
@ -473,7 +502,30 @@
|
|||
") => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
"id": "def-public.OpenFieldEditorOptions.onSave.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IndexPatternField",
|
||||
"text": "IndexPatternField"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "indexPatternFieldEditor",
|
||||
|
@ -548,6 +600,8 @@
|
|||
],
|
||||
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [App Services](https://github.com/orgs/elastic/teams/kibana-app-services
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 41 | 1 | 36 | 3 |
|
||||
| 44 | 2 | 39 | 3 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -358,21 +358,24 @@
|
|||
],
|
||||
"path": "x-pack/plugins/infra/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-server.sourceId",
|
||||
"id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "sourceId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/infra/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "infra",
|
||||
"id": "def-server.sourceProperties",
|
||||
"id": "def-server.InfraPluginSetup.defineInternalSourceConfiguration.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "sourceProperties",
|
||||
|
@ -381,9 +384,11 @@
|
|||
"InfraStaticSourceConfiguration"
|
||||
],
|
||||
"path": "x-pack/plugins/infra/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
@ -881,7 +881,30 @@
|
|||
") => boolean) | undefined"
|
||||
],
|
||||
"path": "src/plugins/inspector/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.InspectorViewDescription.shouldShow.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "adapters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "inspector",
|
||||
"scope": "common",
|
||||
"docId": "kibInspectorPluginApi",
|
||||
"section": "def-common.Adapters",
|
||||
"text": "Adapters"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/inspector/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
|
@ -1181,13 +1204,10 @@
|
|||
],
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"True, if a call to `open` with the same adapters\nwould have shown the inspector panel, false otherwise."
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.adapters",
|
||||
"id": "def-public.Start.isAvailable.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "adapters",
|
||||
|
@ -1205,8 +1225,12 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"True, if a call to `open` with the same adapters\nwould have shown the inspector panel, false otherwise."
|
||||
]
|
||||
},
|
||||
{
|
||||
|
@ -1249,13 +1273,10 @@
|
|||
],
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [
|
||||
"The session instance for the opened inspector."
|
||||
],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.adapters",
|
||||
"id": "def-public.Start.open.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "adapters",
|
||||
|
@ -1272,11 +1293,12 @@
|
|||
}
|
||||
],
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "inspector",
|
||||
"id": "def-public.options",
|
||||
"id": "def-public.Start.open.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
|
@ -1294,8 +1316,12 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/inspector/public/plugin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": [
|
||||
"The session instance for the opened inspector."
|
||||
]
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ import inspectorObj from './inspector.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 101 | 6 | 78 | 4 |
|
||||
| 102 | 6 | 79 | 4 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -919,7 +919,24 @@
|
|||
"((...args: any[]) => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
"id": "def-public.RouteConfiguration.resolveRedirectTo.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "args",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
],
|
||||
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
|
@ -999,7 +1016,24 @@
|
|||
"[]) | undefined"
|
||||
],
|
||||
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
"id": "def-public.RouteConfiguration.k7Breadcrumbs.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "args",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
],
|
||||
"path": "src/plugins/kibana_legacy/public/angular/angular_config.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
|
@ -1060,6 +1094,38 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
"id": "def-public.provider",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "provider",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(...injectable: any[]) => T"
|
||||
],
|
||||
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaLegacy",
|
||||
"id": "def-public.injectable",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "injectable",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
],
|
||||
"path": "src/plugins/kibana_legacy/public/utils/private.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 66 | 3 | 62 | 1 |
|
||||
| 70 | 3 | 66 | 1 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -892,6 +892,35 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/public/context/context.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.props",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"P & { children?: React.ReactNode; }"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.context",
|
||||
"type": "Any",
|
||||
"tags": [],
|
||||
"label": "context",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
],
|
||||
"path": "node_modules/@types/react/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -1835,8 +1864,8 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/public/exit_full_screen_button/exit_full_screen_button.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1992,7 +2021,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/field_button/field_button.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
|
@ -2381,24 +2412,24 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/public/overlays/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.node",
|
||||
"id": "def-public.KibanaReactOverlays.openFlyout.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "node",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | boolean | {} | 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>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
||||
"React.ReactNode"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/overlays/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.options",
|
||||
"id": "def-public.KibanaReactOverlays.openFlyout.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
|
@ -2414,9 +2445,11 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/overlays/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
|
@ -2445,24 +2478,24 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/public/overlays/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.node",
|
||||
"id": "def-public.KibanaReactOverlays.openModal.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "node",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | boolean | {} | 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>)> | React.ReactNodeArray | React.ReactPortal | null | undefined"
|
||||
"React.ReactNode"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/overlays/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.options",
|
||||
"id": "def-public.KibanaReactOverlays.openModal.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
|
@ -2478,9 +2511,11 @@
|
|||
" | undefined"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/overlays/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -3199,7 +3234,25 @@
|
|||
".IStandaloneCodeEditor) => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-public.UrlTemplateEditorProps.onEditor.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "editor",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"editor",
|
||||
".IStandaloneCodeEditor"
|
||||
],
|
||||
"path": "src/plugins/kibana_react/public/url_template_editor/url_template_editor.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
|
@ -4198,6 +4251,43 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/common/eui_styled_components.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-common.first",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "first",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"CSSObject",
|
||||
" | ",
|
||||
"InterpolationFunction",
|
||||
"<",
|
||||
"ThemedStyledProps",
|
||||
"<P, T>> | TemplateStringsArray"
|
||||
],
|
||||
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-common.interpolations",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "interpolations",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Interpolation",
|
||||
"<",
|
||||
"ThemedStyledProps",
|
||||
"<P, T>>[]"
|
||||
],
|
||||
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -4374,6 +4464,37 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/common/eui_styled_components.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-common.strings",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "strings",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"TemplateStringsArray | ",
|
||||
"CSSKeyframes"
|
||||
],
|
||||
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-common.interpolations",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "interpolations",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SimpleInterpolation",
|
||||
"[]"
|
||||
],
|
||||
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -4404,6 +4525,22 @@
|
|||
],
|
||||
"path": "src/plugins/kibana_react/common/eui_styled_components.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "kibanaReact",
|
||||
"id": "def-common.component",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "component",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"React.ComponentProps<C> extends { theme?: T | undefined; } ? C : never"
|
||||
],
|
||||
"path": "node_modules/@types/styled-components/ts3.7/index.d.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ import kibanaReactObj from './kibana_react.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 258 | 5 | 228 | 4 |
|
||||
| 266 | 6 | 236 | 4 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
File diff suppressed because it is too large
Load diff
|
@ -18,7 +18,7 @@ import kibanaUtilsObj from './kibana_utils.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 551 | 3 | 359 | 8 |
|
||||
| 600 | 3 | 406 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -627,26 +627,30 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.input",
|
||||
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "input",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"LensByValueInput",
|
||||
" | ",
|
||||
"LensByReferenceInput"
|
||||
{
|
||||
"pluginId": "lens",
|
||||
"scope": "public",
|
||||
"docId": "kibLensPluginApi",
|
||||
"section": "def-public.LensEmbeddableInput",
|
||||
"text": "LensEmbeddableInput"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-public.openInNewTab",
|
||||
"id": "def-public.LensPublicStart.navigateToPrefilledEditor.$2",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "openInNewTab",
|
||||
|
@ -655,9 +659,11 @@
|
|||
"boolean | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
|
@ -673,8 +679,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
|
@ -692,8 +698,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lens/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -3459,7 +3465,8 @@
|
|||
"section": "def-common.PersistableFilter",
|
||||
"text": "PersistableFilter"
|
||||
},
|
||||
" extends any"
|
||||
" extends ",
|
||||
"Filter"
|
||||
],
|
||||
"path": "x-pack/plugins/lens/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -3501,7 +3508,8 @@
|
|||
"section": "def-common.PersistableFilterMeta",
|
||||
"text": "PersistableFilterMeta"
|
||||
},
|
||||
" extends any"
|
||||
" extends ",
|
||||
"FilterMeta"
|
||||
],
|
||||
"path": "x-pack/plugins/lens/common/types.ts",
|
||||
"deprecated": false,
|
||||
|
@ -3637,6 +3645,29 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lens/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "lens",
|
||||
"id": "def-common.mapping",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "mapping",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "expressions",
|
||||
"scope": "common",
|
||||
"docId": "kibExpressionsPluginApi",
|
||||
"section": "def-common.SerializedFieldFormat",
|
||||
"text": "SerializedFieldFormat"
|
||||
},
|
||||
"<Record<string, any>> | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/lens/common/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Kibana App](https://github.com/orgs/elastic/teams/kibana-app) for quest
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 207 | 0 | 191 | 23 |
|
||||
| 208 | 0 | 192 | 23 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -143,8 +143,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
@ -175,8 +175,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
@ -764,11 +764,7 @@
|
|||
},
|
||||
{
|
||||
"plugin": "reporting",
|
||||
"path": "x-pack/plugins/reporting/public/share_context_menu/register_csv_reporting.tsx"
|
||||
},
|
||||
{
|
||||
"plugin": "reporting",
|
||||
"path": "x-pack/plugins/reporting/public/share_context_menu/register_pdf_png_reporting.tsx"
|
||||
"path": "x-pack/plugins/reporting/public/share_context_menu/index.ts"
|
||||
},
|
||||
{
|
||||
"plugin": "reporting",
|
||||
|
@ -1849,8 +1845,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
@ -1881,8 +1877,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/licensing/common/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
@ -2409,6 +2405,22 @@
|
|||
],
|
||||
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.license",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "license",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"ILicense"
|
||||
],
|
||||
"path": "x-pack/plugins/licensing/server/wrap_route_with_license_check.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -2739,11 +2751,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.clusterClient",
|
||||
"id": "def-server.LicensingPluginStart.createLicensePoller.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "clusterClient",
|
||||
|
@ -2758,19 +2769,25 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
"id": "def-server.pollingFrequency",
|
||||
"id": "def-server.LicensingPluginStart.createLicensePoller.$2",
|
||||
"type": "number",
|
||||
"tags": [],
|
||||
"label": "pollingFrequency",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"number"
|
||||
],
|
||||
"path": "x-pack/plugins/licensing/server/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "licensing",
|
||||
|
|
|
@ -18,7 +18,7 @@ import licensingObj from './licensing.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 117 | 0 | 42 | 8 |
|
||||
| 118 | 0 | 43 | 8 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -2551,8 +2551,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lists/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "lists",
|
||||
|
@ -2573,8 +2573,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/lists/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -499,11 +499,10 @@
|
|||
],
|
||||
"path": "src/plugins/management/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
"id": "def-public.crumbs",
|
||||
"id": "def-public.ManagementAppMountParams.setBreadcrumbs.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "crumbs",
|
||||
|
@ -513,9 +512,11 @@
|
|||
"[]"
|
||||
],
|
||||
"path": "src/plugins/management/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "management",
|
||||
|
|
|
@ -373,7 +373,9 @@
|
|||
"label": "_getFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => any[]"
|
||||
"() => ",
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
||||
"deprecated": false,
|
||||
|
@ -608,7 +610,9 @@
|
|||
"label": "addFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(filters: any[], actionId?: string) => Promise<void>"
|
||||
"(filters: ",
|
||||
"Filter",
|
||||
"[], actionId?: string) => Promise<void>"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
||||
"deprecated": false,
|
||||
|
@ -621,7 +625,8 @@
|
|||
"label": "filters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any[]"
|
||||
"Filter",
|
||||
"[]"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/embeddable/map_embeddable.tsx",
|
||||
"deprecated": false,
|
||||
|
@ -822,7 +827,9 @@
|
|||
"label": "addFilters",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"((filters: any[], actionId: string) => Promise<void>) | null"
|
||||
"((filters: ",
|
||||
"Filter",
|
||||
"[], actionId: string) => Promise<void>) | null"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
|
@ -839,8 +846,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
@ -875,7 +882,9 @@
|
|||
"<object>) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
@ -896,7 +905,9 @@
|
|||
"<object>[]>) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
@ -910,19 +921,23 @@
|
|||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.layerId",
|
||||
"id": "def-public.RenderTooltipContentParams.getLayerName.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "layerId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
@ -948,22 +963,57 @@
|
|||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.__0",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"label": "{\n layerId,\n featureId,\n mbProperties,\n }",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ layerId: string; featureId?: string | number | undefined; mbProperties: GeoJSON.GeoJsonProperties; }"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties.layerId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "layerId",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties.featureId",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "featureId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureProperties.$1.layerIdfeatureIdmbProperties.mbProperties",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "mbProperties",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [name: string]: any; } | null"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
@ -977,22 +1027,44 @@
|
|||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.__0",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerIdfeatureId",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"label": "{\n layerId,\n featureId,\n }",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ layerId: string; featureId?: string | number | undefined; }"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerIdfeatureId.layerId",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "layerId",
|
||||
"description": [],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.loadFeatureGeometry.$1.layerIdfeatureId.featureId",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "featureId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
|
@ -1013,7 +1085,58 @@
|
|||
") => void) | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "actionId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "key",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-public.RenderTooltipContentParams.onSingleValueTrigger.$3",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "value",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "maps",
|
||||
"scope": "common",
|
||||
"docId": "kibMapsPluginApi",
|
||||
"section": "def-common.RawValue",
|
||||
"text": "RawValue"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/maps/public/classes/tooltips/tooltip_property.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1110,8 +1233,8 @@
|
|||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
"[]; }"
|
||||
],
|
||||
|
@ -2359,6 +2482,22 @@
|
|||
],
|
||||
"path": "x-pack/plugins/maps/common/constants.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "maps",
|
||||
"id": "def-common.value",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "value",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | number | boolean | string[] | null | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/maps/common/constants.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ import mapsObj from './maps.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 204 | 2 | 203 | 11 |
|
||||
| 213 | 2 | 212 | 11 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -783,8 +783,8 @@
|
|||
],
|
||||
"path": "src/plugins/maps_ems/public/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
@ -1247,6 +1247,24 @@
|
|||
],
|
||||
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "ml",
|
||||
"id": "def-public.__0",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ rowIndex: number; columnId: string; setCellProps: (props: ",
|
||||
"CommonProps",
|
||||
" & React.HTMLAttributes<HTMLDivElement>) => void; }"
|
||||
],
|
||||
"path": "x-pack/plugins/ml/public/application/components/data_grid/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Machine Learning UI](https://github.com/orgs/elastic/teams/ml-ui) for q
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 278 | 10 | 274 | 33 |
|
||||
| 279 | 10 | 275 | 33 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -34,8 +34,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
|
@ -49,8 +49,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
|
@ -72,32 +72,29 @@
|
|||
],
|
||||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
"id": "def-server.esClient",
|
||||
"id": "def-server.IBulkUploader.start.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "esClient",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
"KibanaClient",
|
||||
", \"get\" | \"delete\" | \"create\" | \"index\" | \"update\" | \"closePointInTime\" | \"count\" | \"search\" | \"security\" | \"eql\" | \"on\" | \"off\" | \"transform\" | \"helpers\" | \"emit\" | \"once\" | \"asyncSearch\" | \"autoscaling\" | \"bulk\" | \"cat\" | \"ccr\" | \"clearScroll\" | \"cluster\" | \"danglingIndices\" | \"dataFrameTransformDeprecated\" | \"deleteByQuery\" | \"deleteByQueryRethrottle\" | \"deleteScript\" | \"enrich\" | \"exists\" | \"existsSource\" | \"explain\" | \"features\" | \"fieldCaps\" | \"fleet\" | \"getScript\" | \"getScriptContext\" | \"getScriptLanguages\" | \"getSource\" | \"graph\" | \"ilm\" | \"indices\" | \"info\" | \"ingest\" | \"license\" | \"logstash\" | \"mget\" | \"migration\" | \"ml\" | \"monitoring\" | \"msearch\" | \"msearchTemplate\" | \"mtermvectors\" | \"nodes\" | \"openPointInTime\" | \"ping\" | \"putScript\" | \"rankEval\" | \"reindex\" | \"reindexRethrottle\" | \"renderSearchTemplate\" | \"rollup\" | \"scriptsPainlessExecute\" | \"scroll\" | \"searchShards\" | \"searchTemplate\" | \"searchableSnapshots\" | \"shutdown\" | \"slm\" | \"snapshot\" | \"sql\" | \"ssl\" | \"tasks\" | \"termsEnum\" | \"termvectors\" | \"textStructure\" | \"updateByQuery\" | \"updateByQueryRethrottle\" | \"watcher\" | \"xpack\"> & { transport: { request(params: ",
|
||||
"TransportRequestParams",
|
||||
", options?: ",
|
||||
"TransportRequestOptions",
|
||||
" | undefined): ",
|
||||
"TransportRequestPromise",
|
||||
"<",
|
||||
"ApiResponse",
|
||||
"<Record<string, any>, unknown>>; }; }"
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "server",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-server.ElasticsearchClient",
|
||||
"text": "ElasticsearchClient"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "monitoring",
|
||||
|
@ -111,8 +108,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/monitoring/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -1479,29 +1479,37 @@
|
|||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.by",
|
||||
"id": "def-public.MetricsFetchDataResponse.sort.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "by",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.direction",
|
||||
"id": "def-public.MetricsFetchDataResponse.sort.$2",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "direction",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
|
@ -2834,6 +2842,28 @@
|
|||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.fetchDataParams",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "fetchDataParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "observability",
|
||||
"scope": "public",
|
||||
"docId": "kibObservabilityPluginApi",
|
||||
"section": "def-public.FetchDataParams",
|
||||
"text": "FetchDataParams"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -2864,6 +2894,29 @@
|
|||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "observability",
|
||||
"scope": "public",
|
||||
"docId": "kibObservabilityPluginApi",
|
||||
"section": "def-public.HasDataParams",
|
||||
"text": "HasDataParams"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/typings/fetch_overview_data/index.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -2930,6 +2983,24 @@
|
|||
],
|
||||
"path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.options",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ fields: OutputOf<",
|
||||
"Optional",
|
||||
"<{ readonly \"kibana.rac.alert.owner\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.producer\": { readonly type: \"keyword\"; }; readonly \"kibana.space_ids\": { readonly type: \"keyword\"; readonly array: true; }; readonly \"kibana.rac.alert.uuid\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.id\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.start\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.end\": { readonly type: \"date\"; }; readonly \"kibana.rac.alert.duration.us\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.severity.level\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.severity.value\": { readonly type: \"long\"; }; readonly \"kibana.rac.alert.status\": { readonly type: \"keyword\"; }; readonly \"kibana.rac.alert.evaluation.threshold\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.evaluation.value\": { readonly type: \"scaled_float\"; readonly scaling_factor: 100; }; readonly \"kibana.rac.alert.reason\": { readonly type: \"keyword\"; }; readonly tags: { readonly type: \"keyword\"; readonly array: true; readonly required: false; }; readonly '@timestamp': { readonly type: \"date\"; readonly array: false; readonly required: true; }; readonly 'event.kind': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'event.action': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.uuid': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.id': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.name': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; readonly 'rule.category': { readonly type: \"keyword\"; readonly array: false; readonly required: false; }; }, \"tags\" | \"event.kind\" | \"event.action\" | \"rule.uuid\" | \"rule.id\" | \"rule.name\" | \"rule.category\" | \"kibana.rac.alert.producer\" | \"kibana.rac.alert.owner\" | \"kibana.rac.alert.id\" | \"kibana.rac.alert.uuid\" | \"kibana.rac.alert.start\" | \"kibana.rac.alert.end\" | \"kibana.rac.alert.duration.us\" | \"kibana.rac.alert.severity.level\" | \"kibana.rac.alert.severity.value\" | \"kibana.rac.alert.status\" | \"kibana.rac.alert.evaluation.threshold\" | \"kibana.rac.alert.evaluation.value\" | \"kibana.rac.alert.reason\" | \"kibana.space_ids\">> & Record<string, any>; formatters: { asDuration: (value: number | null | undefined, { defaultValue, extended }?: FormatterOptions) => string; asPercent: (numerator: number | null | undefined, denominator: number | undefined, fallbackResult?: string) => string; }; }"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/rules/create_observability_rule_type_registry.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -3051,6 +3122,22 @@
|
|||
],
|
||||
"path": "x-pack/plugins/observability/public/hooks/use_track_metric.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "observability",
|
||||
"id": "def-public.__0",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "__0",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"TrackOptions & { metric: string; }"
|
||||
],
|
||||
"path": "x-pack/plugins/observability/public/hooks/use_track_metric.tsx",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
}
|
||||
],
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact Observability UI for questions regarding this plugin.
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 219 | 0 | 219 | 10 |
|
||||
| 223 | 0 | 223 | 10 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -1454,8 +1454,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1469,8 +1469,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1484,8 +1484,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1499,8 +1499,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/capabilities.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1537,21 +1537,24 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.query",
|
||||
"id": "def-public.PresentationDashboardsService.findDashboards.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "query",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.fields",
|
||||
"id": "def-public.PresentationDashboardsService.findDashboards.$2",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "fields",
|
||||
|
@ -1560,9 +1563,11 @@
|
|||
"string[]"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1586,19 +1591,23 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.title",
|
||||
"id": "def-public.PresentationDashboardsService.findDashboardsByTitle.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "title",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/dashboards.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1625,11 +1634,10 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.PresentationLabsService.isProjectEnabled.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
|
@ -1638,9 +1646,11 @@
|
|||
"\"labs:dashboard:deferBelowFold\""
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1654,8 +1664,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1676,11 +1686,10 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.PresentationLabsService.getProject.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
|
@ -1689,9 +1698,11 @@
|
|||
"\"labs:dashboard:deferBelowFold\""
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1713,11 +1724,10 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.solutions",
|
||||
"id": "def-public.PresentationLabsService.getProjects.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "solutions",
|
||||
|
@ -1726,9 +1736,11 @@
|
|||
"(\"dashboard\" | \"canvas\" | \"presentation\")[] | undefined"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1742,11 +1754,10 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.id",
|
||||
"id": "def-public.PresentationLabsService.setProjectStatus.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
|
@ -1755,11 +1766,12 @@
|
|||
"\"labs:dashboard:deferBelowFold\""
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.env",
|
||||
"id": "def-public.PresentationLabsService.setProjectStatus.$2",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "env",
|
||||
|
@ -1768,19 +1780,25 @@
|
|||
"\"kibana\" | \"browser\" | \"session\""
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.status",
|
||||
"id": "def-public.PresentationLabsService.setProjectStatus.$3",
|
||||
"type": "boolean",
|
||||
"tags": [],
|
||||
"label": "status",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"boolean"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1794,8 +1812,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/labs.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1844,8 +1862,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/components/solution_toolbar/items/quick_group.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1918,8 +1936,8 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/components/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -1941,11 +1959,10 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/components/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.SaveModalDashboardProps.onSave.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -1961,9 +1978,11 @@
|
|||
" & { dashboardId: string | null; addToLibrary: boolean; }"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/components/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
|
@ -2028,6 +2047,29 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.params",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "presentationUtil",
|
||||
"scope": "public",
|
||||
"docId": "kibPresentationUtilPluginApi",
|
||||
"section": "def-public.KibanaPluginServiceParams",
|
||||
"text": "KibanaPluginServiceParams"
|
||||
},
|
||||
"<Start>"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -2044,6 +2086,22 @@
|
|||
],
|
||||
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "presentationUtil",
|
||||
"id": "def-public.params",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "params",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Parameters"
|
||||
],
|
||||
"path": "src/plugins/presentation_util/public/services/create/factory.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ import presentationUtilObj from './presentation_util.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 176 | 3 | 149 | 5 |
|
||||
| 178 | 3 | 151 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -54,6 +54,40 @@
|
|||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.Unnamed.$2",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "uiSettings",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "core",
|
||||
"scope": "public",
|
||||
"docId": "kibCorePluginApi",
|
||||
"section": "def-public.IUiSettingsClient",
|
||||
"text": "IUiSettingsClient"
|
||||
}
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.Unnamed.$3",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "kibanaVersion",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
|
@ -311,7 +345,9 @@
|
|||
"label": "getReportingJobPath",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(exportType: string, jobParams: JobParams) => string"
|
||||
"(exportType: string, jobParams: ",
|
||||
"BaseParams",
|
||||
") => string"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
|
@ -338,7 +374,7 @@
|
|||
"label": "jobParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"JobParams"
|
||||
"BaseParams"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
|
@ -355,7 +391,9 @@
|
|||
"label": "createReportingJob",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(exportType: string, jobParams: any) => Promise<",
|
||||
"(exportType: string, jobParams: ",
|
||||
"BaseParams",
|
||||
") => Promise<",
|
||||
"Job",
|
||||
">"
|
||||
],
|
||||
|
@ -379,12 +417,77 @@
|
|||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.createReportingJob.$2",
|
||||
"type": "Any",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "jobParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"any"
|
||||
"BaseParams"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.createImmediateReport",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "createImmediateReport",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"(baseParams: ",
|
||||
"BaseParams",
|
||||
") => Promise<any>"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.createImmediateReport.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "baseParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"BaseParams"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.getDecoratedJobParams",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getDecoratedJobParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"<T extends Pick<",
|
||||
"BaseParams",
|
||||
", \"title\" | \"objectType\" | \"layout\">>(baseParams: T) => ",
|
||||
"BaseParams"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-public.ReportingAPIClient.getDecoratedJobParams.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "baseParams",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/public/lib/reporting_api_client/reporting_api_client.ts",
|
||||
"deprecated": false,
|
||||
|
@ -871,6 +974,21 @@
|
|||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-server.ReportingCore.getKibanaVersion",
|
||||
"type": "Function",
|
||||
"tags": [],
|
||||
"label": "getKibanaVersion",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"() => string"
|
||||
],
|
||||
"path": "x-pack/plugins/reporting/server/core.ts",
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "reporting",
|
||||
"id": "def-server.ReportingCore.pluginSetup",
|
||||
|
@ -2138,8 +2256,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/reporting/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "start",
|
||||
|
|
|
@ -18,7 +18,7 @@ Contact [Kibana Reporting Services](https://github.com/orgs/elastic/teams/kibana
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 133 | 1 | 132 | 14 |
|
||||
| 140 | 0 | 139 | 15 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -792,8 +792,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -915,6 +915,22 @@
|
|||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "ruleRegistry",
|
||||
"id": "def-server.alert",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "alert",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ id: string; fields: Record<string, unknown>; }"
|
||||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_rule_type_factory.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -939,6 +955,46 @@
|
|||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "ruleRegistry",
|
||||
"id": "def-server.options",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "options",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"Pick<",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "server",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-server.AlertExecutorOptions",
|
||||
"text": "AlertExecutorOptions"
|
||||
},
|
||||
"<Params, State, InstanceState, InstanceContext, ActionGroupIds>, \"name\" | \"params\" | \"tags\" | \"spaceId\" | \"rule\" | \"createdBy\" | \"updatedBy\" | \"previousStartedAt\" | \"state\" | \"alertId\" | \"namespace\" | \"startedAt\"> & { services: ",
|
||||
{
|
||||
"pluginId": "alerting",
|
||||
"scope": "server",
|
||||
"docId": "kibAlertingPluginApi",
|
||||
"section": "def-server.AlertServices",
|
||||
"text": "AlertServices"
|
||||
},
|
||||
"<InstanceState, InstanceContext, ActionGroupIds> & ",
|
||||
{
|
||||
"pluginId": "ruleRegistry",
|
||||
"scope": "server",
|
||||
"docId": "kibRuleRegistryPluginApi",
|
||||
"section": "def-server.LifecycleAlertServices",
|
||||
"text": "LifecycleAlertServices"
|
||||
},
|
||||
"<InstanceState, InstanceContext, ActionGroupIds>; }"
|
||||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/utils/create_lifecycle_executor.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -1029,11 +1085,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "ruleRegistry",
|
||||
"id": "def-server.req",
|
||||
"id": "def-server.RuleRegistryPluginStartContract.getRacClientWithRequest.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "req",
|
||||
|
@ -1049,9 +1104,11 @@
|
|||
"<unknown, unknown, unknown, any>"
|
||||
],
|
||||
"path": "x-pack/plugins/rule_registry/server/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "ruleRegistry",
|
||||
|
|
|
@ -18,7 +18,7 @@ import ruleRegistryObj from './rule_registry.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 60 | 0 | 60 | 9 |
|
||||
| 62 | 0 | 62 | 9 |
|
||||
|
||||
## Server
|
||||
|
||||
|
|
|
@ -200,11 +200,10 @@
|
|||
],
|
||||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
"id": "def-public.field",
|
||||
"id": "def-public.Props.onSave.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "field",
|
||||
|
@ -219,9 +218,11 @@
|
|||
}
|
||||
],
|
||||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
|
@ -237,8 +238,8 @@
|
|||
],
|
||||
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "runtimeFields",
|
||||
|
|
|
@ -1884,8 +1884,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -1934,7 +1934,24 @@
|
|||
"((appId: string) => string | undefined) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.OriginSaveModalProps.getAppNameFromId.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "appId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -1997,8 +2014,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2041,11 +2058,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.props",
|
||||
"id": "def-public.OriginSaveModalProps.onSave.$1",
|
||||
"type": "CompoundType",
|
||||
"tags": [],
|
||||
"label": "props",
|
||||
|
@ -2061,9 +2077,11 @@
|
|||
" & { returnToOrigin: boolean; }"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/save_modal/saved_object_save_modal_origin.tsx",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -2198,8 +2216,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2234,22 +2252,23 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.resp",
|
||||
"id": "def-public.SavedObject.applyESResp.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "resp",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"{ [x: string]: any; }"
|
||||
"Record<string, any>"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2275,11 +2294,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.opts",
|
||||
"id": "def-public.SavedObject.creationOpts.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "opts",
|
||||
|
@ -2288,9 +2306,11 @@
|
|||
"SavedObjectCreationOpts"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2316,7 +2336,9 @@
|
|||
"(() => Promise<{}>) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2330,8 +2352,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2345,8 +2367,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2360,8 +2382,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2375,8 +2397,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2391,13 +2413,30 @@
|
|||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
" | null>) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.SavedObject.hydrateIndexPattern.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "id",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": false
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2431,7 +2470,9 @@
|
|||
">) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2455,8 +2496,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2501,11 +2542,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.saveOptions",
|
||||
"id": "def-public.SavedObject.save.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "saveOptions",
|
||||
|
@ -2520,9 +2560,11 @@
|
|||
}
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2639,7 +2681,30 @@
|
|||
">) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.SavedObjectConfig.afterESResp.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "savedObject",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObject",
|
||||
"text": "SavedObject"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2669,7 +2734,24 @@
|
|||
") | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.SavedObjectConfig.extractReferences.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "opts",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectAttributesAndRefs"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2692,7 +2774,39 @@
|
|||
"[]) => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.SavedObjectConfig.injectReferences.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "object",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"T"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.SavedObjectConfig.injectReferences.$2",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "references",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectReference",
|
||||
"[]"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2718,7 +2832,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2732,8 +2848,8 @@
|
|||
"pluginId": "data",
|
||||
"scope": "common",
|
||||
"docId": "kibDataIndexPatternsPluginApi",
|
||||
"section": "def-common.IIndexPattern",
|
||||
"text": "IIndexPattern"
|
||||
"section": "def-common.IndexPattern",
|
||||
"text": "IndexPattern"
|
||||
},
|
||||
" | undefined"
|
||||
],
|
||||
|
@ -2875,11 +2991,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.config",
|
||||
"id": "def-public.SavedObjectDecorator.decorateConfig.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
|
@ -2894,9 +3009,11 @@
|
|||
}
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -2912,11 +3029,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.object",
|
||||
"id": "def-public.SavedObjectDecorator.decorateObject.$1",
|
||||
"type": "Uncategorized",
|
||||
"tags": [],
|
||||
"label": "object",
|
||||
|
@ -2925,9 +3041,11 @@
|
|||
"T"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -3363,7 +3481,9 @@
|
|||
"(() => void) | undefined"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/types.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
|
@ -3507,6 +3627,22 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.services",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "services",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"SavedObjectKibanaServices"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/saved_object/decorators/types.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
@ -3644,11 +3780,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects/public/plugin.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjects",
|
||||
"id": "def-public.config",
|
||||
"id": "def-public.SavedObjectSetup.registerDecorator.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "config",
|
||||
|
@ -3664,9 +3799,11 @@
|
|||
"<any>"
|
||||
],
|
||||
"path": "src/plugins/saved_objects/public/plugin.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"lifecycle": "setup",
|
||||
|
|
|
@ -18,7 +18,7 @@ import savedObjectsObj from './saved_objects.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 213 | 3 | 199 | 5 |
|
||||
| 220 | 3 | 206 | 5 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
|
@ -710,11 +710,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsManagement",
|
||||
"id": "def-public.action",
|
||||
"id": "def-public.SavedObjectsManagementActionServiceSetup.register.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "action",
|
||||
|
@ -729,9 +728,11 @@
|
|||
}
|
||||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -760,19 +761,23 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsManagement",
|
||||
"id": "def-public.actionId",
|
||||
"id": "def-public.SavedObjectsManagementActionServiceStart.has.$1",
|
||||
"type": "string",
|
||||
"tags": [],
|
||||
"label": "actionId",
|
||||
"description": [],
|
||||
"signature": [
|
||||
"string"
|
||||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
},
|
||||
{
|
||||
"parentPluginId": "savedObjectsManagement",
|
||||
|
@ -796,8 +801,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/action_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -906,11 +911,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsManagement",
|
||||
"id": "def-public.column",
|
||||
"id": "def-public.SavedObjectsManagementColumnServiceSetup.register.$1",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "column",
|
||||
|
@ -926,9 +930,11 @@
|
|||
"<unknown>"
|
||||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -965,8 +971,8 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_management/public/services/column_service.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": []
|
||||
"children": [],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
|
|
@ -253,11 +253,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.ids",
|
||||
"id": "def-public.SavedObjectSaveModalTagSelectorComponentProps.onTagsSelected.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "ids",
|
||||
|
@ -266,9 +265,11 @@
|
|||
"string[]"
|
||||
],
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1037,11 +1038,10 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.ids",
|
||||
"id": "def-public.TagSelectorComponentProps.onTagsSelected.$1",
|
||||
"type": "Array",
|
||||
"tags": [],
|
||||
"label": "ids",
|
||||
|
@ -1050,9 +1050,11 @@
|
|||
"string[]"
|
||||
],
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"deprecated": false
|
||||
"deprecated": false,
|
||||
"isRequired": true
|
||||
}
|
||||
]
|
||||
],
|
||||
"returnComment": []
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
|
@ -1087,6 +1089,28 @@
|
|||
],
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"deprecated": false,
|
||||
"returnComment": [],
|
||||
"children": [
|
||||
{
|
||||
"parentPluginId": "savedObjectsTaggingOss",
|
||||
"id": "def-public.object",
|
||||
"type": "Object",
|
||||
"tags": [],
|
||||
"label": "object",
|
||||
"description": [],
|
||||
"signature": [
|
||||
{
|
||||
"pluginId": "savedObjects",
|
||||
"scope": "public",
|
||||
"docId": "kibSavedObjectsPluginApi",
|
||||
"section": "def-public.SavedObject",
|
||||
"text": "SavedObject"
|
||||
}
|
||||
],
|
||||
"path": "src/plugins/saved_objects_tagging_oss/public/api.ts",
|
||||
"deprecated": false
|
||||
}
|
||||
],
|
||||
"initialIsOpen": false
|
||||
},
|
||||
{
|
||||
|
|
|
@ -18,7 +18,7 @@ import savedObjectsTaggingOssObj from './saved_objects_tagging_oss.json';
|
|||
|
||||
| Public API count | Any count | Items lacking comments | Missing exports |
|
||||
|-------------------|-----------|------------------------|-----------------|
|
||||
| 89 | 3 | 50 | 0 |
|
||||
| 90 | 3 | 51 | 0 |
|
||||
|
||||
## Client
|
||||
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue