6b8ebbfa18
* Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs # Conflicts: # api_docs/actions.json # api_docs/advanced_settings.json # api_docs/alerting.json # api_docs/apm.json # api_docs/apm_oss.json # api_docs/banners.json # api_docs/beats_management.json # api_docs/bfetch.json # api_docs/canvas.json # api_docs/case.json # api_docs/charts.json # api_docs/cloud.json # api_docs/console.json # api_docs/core.json # api_docs/core_application.json # api_docs/core_chrome.json # api_docs/core_http.json # api_docs/core_saved_objects.json # api_docs/dashboard.json # api_docs/dashboard_enhanced.json # api_docs/dashboard_mode.json # api_docs/data.json # api_docs/data_autocomplete.json # api_docs/data_enhanced.json # api_docs/data_field_formats.json # api_docs/data_index_patterns.json # api_docs/data_query.json # api_docs/data_search.json # api_docs/data_ui.json # api_docs/dev_tools.json # api_docs/discover.json # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/embeddable_enhanced.json # api_docs/encrypted_saved_objects.json # api_docs/enterprise_search.json # api_docs/es_ui_shared.json # api_docs/event_log.json # api_docs/expressions.json # api_docs/features.json # api_docs/file_upload.json # api_docs/fleet.json # api_docs/global_search.json # api_docs/home.json # api_docs/index_lifecycle_management.json # api_docs/index_management.json # api_docs/index_pattern_field_editor.json # api_docs/index_pattern_management.json # api_docs/infra.json # api_docs/ingest_pipelines.json # api_docs/inspector.json # api_docs/kibana_legacy.json # api_docs/kibana_react.json # api_docs/kibana_utils.json # api_docs/lens.json # api_docs/license_management.json # api_docs/licensing.json # api_docs/lists.json # api_docs/management.json # api_docs/maps.json # api_docs/maps_legacy.json # api_docs/ml.json # api_docs/monitoring.json # api_docs/navigation.json # api_docs/newsfeed.json # api_docs/observability.json # api_docs/osquery.json # api_docs/presentation_util.json # api_docs/remote_clusters.json # api_docs/reporting.json # api_docs/rollup.json # api_docs/runtime_fields.json # api_docs/saved_objects.json # api_docs/saved_objects_management.json # api_docs/saved_objects_tagging.json # api_docs/saved_objects_tagging_oss.json # api_docs/security.json # api_docs/security_oss.json # api_docs/security_solution.json # api_docs/share.json # api_docs/snapshot_restore.json # api_docs/spaces.json # api_docs/spaces_oss.json # api_docs/stack_alerts.json # api_docs/task_manager.json # api_docs/telemetry.json # api_docs/telemetry_collection_manager.json # api_docs/telemetry_collection_xpack.json # api_docs/telemetry_management_section.json # api_docs/triggers_actions_ui.json # api_docs/ui_actions.json # api_docs/ui_actions_enhanced.json # api_docs/uptime.json # api_docs/url_forwarding.json # api_docs/usage_collection.json # api_docs/vis_type_timeseries.json # api_docs/visualizations.json
419 lines
No EOL
13 KiB
JSON
419 lines
No EOL
13 KiB
JSON
{
|
|
"id": "runtimeFields",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"id": "def-public.RuntimeFieldEditor",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{ defaultValue, onChange, docLinks, ctx }",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.Props",
|
|
"text": "Props"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
|
|
"lineNumber": 22
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"({ defaultValue, onChange, docLinks, ctx }: ",
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.Props",
|
|
"text": "Props"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"label": "RuntimeFieldEditor",
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor/runtime_field_editor.tsx",
|
|
"lineNumber": 22
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.RuntimeFieldEditorFlyoutContent",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "{\n onSave,\n onCancel,\n docLinks,\n defaultValue: field,\n ctx,\n}",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.Props",
|
|
"text": "Props"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 78
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"({ onSave, onCancel, docLinks, defaultValue: field, ctx, }: ",
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.Props",
|
|
"text": "Props"
|
|
},
|
|
") => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"label": "RuntimeFieldEditorFlyoutContent",
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 78
|
|
},
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.FormState",
|
|
"type": "Interface",
|
|
"label": "FormState",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FormState.isValid",
|
|
"type": "CompoundType",
|
|
"label": "isValid",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
|
|
"lineNumber": 40
|
|
},
|
|
"signature": [
|
|
"boolean | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FormState.isSubmitted",
|
|
"type": "boolean",
|
|
"label": "isSubmitted",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
|
|
"lineNumber": 41
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FormState.submit",
|
|
"type": "Function",
|
|
"label": "submit",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
|
|
"lineNumber": 42
|
|
},
|
|
"signature": [
|
|
"(e?: React.FormEvent<HTMLFormElement> | React.MouseEvent<Element, MouseEvent> | undefined) => Promise<{ data: ",
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
"; isValid: boolean; }>"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_form/runtime_field_form.tsx",
|
|
"lineNumber": 39
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.Props",
|
|
"type": "Interface",
|
|
"label": "Props",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Props.onSave",
|
|
"type": "Function",
|
|
"label": "onSave",
|
|
"description": [
|
|
"\nHandler for the \"save\" footer button"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 59
|
|
},
|
|
"signature": [
|
|
"(field: ",
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
") => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Props.onCancel",
|
|
"type": "Function",
|
|
"label": "onCancel",
|
|
"description": [
|
|
"\nHandler for the \"cancel\" footer button"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 63
|
|
},
|
|
"signature": [
|
|
"() => void"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Props.docLinks",
|
|
"type": "Object",
|
|
"label": "docLinks",
|
|
"description": [
|
|
"\nThe docLinks start service from core"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 67
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "public",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-public.DocLinksStart",
|
|
"text": "DocLinksStart"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Props.defaultValue",
|
|
"type": "Object",
|
|
"label": "defaultValue",
|
|
"description": [
|
|
"\nAn optional runtime field to edit"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 71
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.RuntimeField",
|
|
"text": "RuntimeField"
|
|
},
|
|
" | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.Props.ctx",
|
|
"type": "Object",
|
|
"label": "ctx",
|
|
"description": [
|
|
"\nOptional context object"
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 75
|
|
},
|
|
"signature": [
|
|
"{ namesNotAllowed?: string[] | undefined; existingConcreteFields?: Field[] | undefined; } | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/components/runtime_field_editor_flyout_content/runtime_field_editor_flyout_content.tsx",
|
|
"lineNumber": 55
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.RuntimeField",
|
|
"type": "Interface",
|
|
"label": "RuntimeField",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RuntimeField.name",
|
|
"type": "string",
|
|
"label": "name",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 34
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RuntimeField.type",
|
|
"type": "CompoundType",
|
|
"label": "type",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"signature": [
|
|
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RuntimeField.script",
|
|
"type": "Object",
|
|
"label": "script",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 36
|
|
},
|
|
"signature": [
|
|
"{ source: string; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 33
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.RUNTIME_FIELD_OPTIONS",
|
|
"type": "Array",
|
|
"label": "RUNTIME_FIELD_OPTIONS",
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/constants.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"ComboBoxOption",
|
|
"<\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\">[]"
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.RuntimeType",
|
|
"type": "Type",
|
|
"label": "RuntimeType",
|
|
"tags": [],
|
|
"description": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"signature": [
|
|
"\"boolean\" | \"date\" | \"keyword\" | \"ip\" | \"long\" | \"double\""
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.PluginSetup",
|
|
"type": "Interface",
|
|
"label": "PluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.PluginSetup.loadEditor",
|
|
"type": "Function",
|
|
"label": "loadEditor",
|
|
"signature": [
|
|
"() => Promise<",
|
|
{
|
|
"pluginId": "runtimeFields",
|
|
"scope": "public",
|
|
"docId": "kibRuntimeFieldsPluginApi",
|
|
"section": "def-public.LoadEditorResponse",
|
|
"text": "LoadEditorResponse"
|
|
},
|
|
">"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 18
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "x-pack/plugins/runtime_fields/public/types.ts",
|
|
"lineNumber": 17
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |