* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> # Conflicts: # api_docs/core.json # api_docs/core_application.json # api_docs/core_http.json # api_docs/core_saved_objects.json
497 lines
19 KiB
JSON
497 lines
19 KiB
JSON
{
|
|
"id": "indexPatternFieldEditor",
|
|
"client": {
|
|
"classes": [
|
|
{
|
|
"id": "def-public.DefaultFormatEditor",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "DefaultFormatEditor",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
"<P, S> extends React.PureComponent<",
|
|
"FormatEditorProps",
|
|
"<P>, ",
|
|
"FormatEditorState",
|
|
" & S, any>"
|
|
],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefaultFormatEditor.formatId",
|
|
"type": "string",
|
|
"label": "formatId",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 75,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L75"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.DefaultFormatEditor.state",
|
|
"type": "CompoundType",
|
|
"label": "state",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 76,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L76"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.FormatEditorState",
|
|
"text": "FormatEditorState"
|
|
},
|
|
" & S"
|
|
]
|
|
},
|
|
{
|
|
"id": "def-public.DefaultFormatEditor.getDerivedStateFromProps",
|
|
"type": "Function",
|
|
"label": "getDerivedStateFromProps",
|
|
"signature": [
|
|
"typeof ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
".getDerivedStateFromProps"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "nextProps",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.FormatEditorProps",
|
|
"text": "FormatEditorProps"
|
|
},
|
|
"<{}>"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 78,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L78"
|
|
}
|
|
},
|
|
{
|
|
"type": "Object",
|
|
"label": "state",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.FormatEditorState",
|
|
"text": "FormatEditorState"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 78,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L78"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 78,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L78"
|
|
}
|
|
},
|
|
{
|
|
"id": "def-public.DefaultFormatEditor.onChange",
|
|
"type": "Function",
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "newParams",
|
|
"isRequired": true,
|
|
"signature": [
|
|
"{}"
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 90,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L90"
|
|
}
|
|
}
|
|
],
|
|
"signature": [
|
|
"(newParams?: {}) => void"
|
|
],
|
|
"description": [],
|
|
"label": "onChange",
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 90,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L90"
|
|
},
|
|
"tags": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"id": "def-public.DefaultFormatEditor.render",
|
|
"type": "Function",
|
|
"label": "render",
|
|
"signature": [
|
|
"() => JSX.Element"
|
|
],
|
|
"description": [],
|
|
"children": [],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 99,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L99"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx",
|
|
"lineNumber": 71,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_format_editor/editors/default/default.tsx#L71"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-public.OpenFieldEditorOptions",
|
|
"type": "Interface",
|
|
"label": "OpenFieldEditorOptions",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OpenFieldEditorOptions.ctx",
|
|
"type": "Object",
|
|
"label": "ctx",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L28"
|
|
},
|
|
"signature": [
|
|
"{ indexPattern: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
},
|
|
"; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OpenFieldEditorOptions.onSave",
|
|
"type": "Function",
|
|
"label": "onSave",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L31"
|
|
},
|
|
"signature": [
|
|
"((field: ",
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPatternField",
|
|
"text": "IndexPatternField"
|
|
},
|
|
") => void) | undefined"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.OpenFieldEditorOptions.fieldName",
|
|
"type": "string",
|
|
"label": "fieldName",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 32,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L32"
|
|
},
|
|
"signature": [
|
|
"string | undefined"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/open_editor.tsx",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/open_editor.tsx#L27"
|
|
},
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"id": "def-public.FieldEditorContext",
|
|
"type": "Interface",
|
|
"label": "FieldEditorContext",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FieldEditorContext.indexPattern",
|
|
"type": "Object",
|
|
"label": "indexPattern",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L28"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "common",
|
|
"docId": "kibDataIndexPatternsPluginApi",
|
|
"section": "def-common.IndexPattern",
|
|
"text": "IndexPattern"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FieldEditorContext.fieldTypeToProcess",
|
|
"type": "CompoundType",
|
|
"label": "fieldTypeToProcess",
|
|
"description": [
|
|
"\nThe Kibana field type of the field to create or edit\nDefault: \"runtime\""
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 33,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L33"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.InternalFieldType",
|
|
"text": "InternalFieldType"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.FieldEditorContext.search",
|
|
"type": "Object",
|
|
"label": "search",
|
|
"description": [
|
|
"The search service from the data plugin"
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 35,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L35"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "data",
|
|
"scope": "public",
|
|
"docId": "kibDataSearchPluginApi",
|
|
"section": "def-public.ISearchStart",
|
|
"text": "ISearchStart"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/components/field_editor_flyout_content_container.tsx#L27"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"start": {
|
|
"id": "def-public.PluginStart",
|
|
"type": "Interface",
|
|
"label": "PluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"id": "def-public.PluginStart.openEditor",
|
|
"type": "Function",
|
|
"label": "openEditor",
|
|
"signature": [
|
|
"(options: ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.OpenFieldEditorOptions",
|
|
"text": "OpenFieldEditorOptions"
|
|
},
|
|
") => () => void"
|
|
],
|
|
"description": [],
|
|
"children": [
|
|
{
|
|
"type": "Object",
|
|
"label": "options",
|
|
"isRequired": true,
|
|
"signature": [
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.OpenFieldEditorOptions",
|
|
"text": "OpenFieldEditorOptions"
|
|
}
|
|
],
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/types.ts#L26"
|
|
}
|
|
}
|
|
],
|
|
"tags": [],
|
|
"returnComment": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 26,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/types.ts#L26"
|
|
}
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStart.fieldFormatEditors",
|
|
"type": "Object",
|
|
"label": "fieldFormatEditors",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/types.ts#L27"
|
|
},
|
|
"signature": [
|
|
"{ getAll: () => typeof ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
"[]; getById: (id: string) => typeof ",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.DefaultFormatEditor",
|
|
"text": "DefaultFormatEditor"
|
|
},
|
|
" | undefined; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStart.userPermissions",
|
|
"type": "Object",
|
|
"label": "userPermissions",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 28,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/types.ts#L28"
|
|
},
|
|
"signature": [
|
|
"{ editIndexPattern: () => boolean; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.PluginStart.DeleteRuntimeFieldProvider",
|
|
"type": "Function",
|
|
"label": "DeleteRuntimeFieldProvider",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 31,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/types.ts#L31"
|
|
},
|
|
"signature": [
|
|
"React.FunctionComponent<",
|
|
{
|
|
"pluginId": "indexPatternFieldEditor",
|
|
"scope": "public",
|
|
"docId": "kibIndexPatternFieldEditorPluginApi",
|
|
"section": "def-public.Props",
|
|
"text": "Props"
|
|
},
|
|
">"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/index_pattern_field_editor/public/types.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/7.xsrc/plugins/index_pattern_field_editor/public/types.ts#L25"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |