kibana/api_docs/unified_doc_viewer.devdocs.json

416 lines
No EOL
14 KiB
JSON

{
"id": "unifiedDocViewer",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.JsonCodeEditor",
"type": "Function",
"tags": [],
"label": "JsonCodeEditor",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"JsonCodeEditorProps",
" & ",
{
"pluginId": "@kbn/shared-ux-utility",
"scope": "common",
"docId": "kibKbnSharedUxUtilityPluginApi",
"section": "def-common.WithSuspenseExtendedDeps",
"text": "WithSuspenseExtendedDeps"
},
" & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/index.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.JsonCodeEditor.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewer",
"type": "Function",
"tags": [],
"label": "UnifiedDocViewer",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"DocViewRenderProps",
" & ",
{
"pluginId": "@kbn/shared-ux-utility",
"scope": "common",
"docId": "kibKbnSharedUxUtilityPluginApi",
"section": "def-common.WithSuspenseExtendedDeps",
"text": "WithSuspenseExtendedDeps"
},
" & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/components/lazy_doc_viewer.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewer.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerFlyout",
"type": "Function",
"tags": [],
"label": "UnifiedDocViewerFlyout",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"UnifiedDocViewerFlyoutProps",
" & ",
{
"pluginId": "@kbn/shared-ux-utility",
"scope": "common",
"docId": "kibKbnSharedUxUtilityPluginApi",
"section": "def-common.WithSuspenseExtendedDeps",
"text": "WithSuspenseExtendedDeps"
},
" & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/components/lazy_doc_viewer_flyout.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerFlyout.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerLogsOverview",
"type": "Function",
"tags": [],
"label": "UnifiedDocViewerLogsOverview",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"DocViewRenderProps",
" & { renderAIAssistant?: ((deps: ",
{
"pluginId": "discoverShared",
"scope": "public",
"docId": "kibDiscoverSharedPluginApi",
"section": "def-public.ObservabilityLogsAIAssistantFeatureRenderDeps",
"text": "ObservabilityLogsAIAssistantFeatureRenderDeps"
},
") => JSX.Element) | undefined; renderStreamsField?: ((deps: ",
"StreamsFeatureRenderDeps",
") => JSX.Element) | undefined; } & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/components/lazy_doc_viewer_logs_overview.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerLogsOverview.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerObservabilityTracesSpanOverview",
"type": "Function",
"tags": [],
"label": "UnifiedDocViewerObservabilityTracesSpanOverview",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"DocViewRenderProps",
" & { transactionIndexPattern: string; } & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/components/observability/traces/doc_viewer_span_overview/lazy_doc_viewer_obs_traces_span_overview.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerObservabilityTracesSpanOverview.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerObservabilityTracesTransactionOverview",
"type": "Function",
"tags": [],
"label": "UnifiedDocViewerObservabilityTracesTransactionOverview",
"description": [],
"signature": [
"React.ForwardRefExoticComponent<",
"DocViewRenderProps",
" & { tracesIndexPattern: string; } & React.RefAttributes<{}>>"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/components/observability/traces/doc_viewer_transaction_overview/lazy_doc_viewer_obs_traces_transaction_overview.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerObservabilityTracesTransactionOverview.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.useEsDocSearch",
"type": "Function",
"tags": [],
"label": "useEsDocSearch",
"description": [
"\nCustom react hook for querying a single doc in ElasticSearch"
],
"signature": [
"({\n id,\n index,\n dataView,\n esqlHit,\n onBeforeFetch,\n onProcessRecord,\n}: ",
"EsDocSearchProps",
") => [",
{
"pluginId": "@kbn/unified-doc-viewer",
"scope": "common",
"docId": "kibKbnUnifiedDocViewerPluginApi",
"section": "def-common.ElasticRequestState",
"text": "ElasticRequestState"
},
", ",
{
"pluginId": "@kbn/discover-utils",
"scope": "common",
"docId": "kibKbnDiscoverUtilsPluginApi",
"section": "def-common.DataTableRecord",
"text": "DataTableRecord"
},
" | null, () => void]"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/hooks/use_es_doc_search.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.useEsDocSearch.$1",
"type": "Object",
"tags": [],
"label": "{\n id,\n index,\n dataView,\n esqlHit,\n onBeforeFetch,\n onProcessRecord,\n}",
"description": [],
"signature": [
"EsDocSearchProps"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/hooks/use_es_doc_search.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.LogsOverviewProps",
"type": "Type",
"tags": [],
"label": "LogsOverviewProps",
"description": [],
"signature": [
"DocViewRenderProps",
" & { renderAIAssistant?: ((deps: ",
{
"pluginId": "discoverShared",
"scope": "public",
"docId": "kibDiscoverSharedPluginApi",
"section": "def-public.ObservabilityLogsAIAssistantFeatureRenderDeps",
"text": "ObservabilityLogsAIAssistantFeatureRenderDeps"
},
") => JSX.Element) | undefined; renderStreamsField?: ((deps: ",
"StreamsFeatureRenderDeps",
") => JSX.Element) | undefined; }"
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/components/doc_viewer_logs_overview/logs_overview.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerSetup",
"type": "Interface",
"tags": [],
"label": "UnifiedDocViewerSetup",
"description": [],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerSetup.registry",
"type": "Object",
"tags": [],
"label": "registry",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-doc-viewer",
"scope": "common",
"docId": "kibKbnUnifiedDocViewerPluginApi",
"section": "def-common.DocViewsRegistry",
"text": "DocViewsRegistry"
}
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerStart",
"type": "Interface",
"tags": [],
"label": "UnifiedDocViewerStart",
"description": [],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "unifiedDocViewer",
"id": "def-public.UnifiedDocViewerStart.registry",
"type": "Object",
"tags": [],
"label": "registry",
"description": [],
"signature": [
{
"pluginId": "@kbn/unified-doc-viewer",
"scope": "common",
"docId": "kibKbnUnifiedDocViewerPluginApi",
"section": "def-common.DocViewsRegistry",
"text": "DocViewsRegistry"
}
],
"path": "src/platform/plugins/shared/unified_doc_viewer/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}