kibana/api_docs/index_pattern_editor.json
Stacey Gammon 53fa5ff3fd
API Doc Fixes (#109685) (#110466)
* Fixes

- Fix bad formatting of deprecated apis by plugin
- Collect deprecated apis recursively
- Include unreferenced apis in Deprecated apis by API page.

* Fix unreferenced dep list

* check in updated docs

* Fix the issue with saved objects management plugin docs not being included

* adding the new docs after fixing some docs missing

* update api docs
# Conflicts:
#	api_docs/apm.json
#	api_docs/charts.mdx
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.json
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_index_patterns.json
#	api_docs/data_index_patterns.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.json
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/expression_shape.json
#	api_docs/expression_shape.mdx
#	api_docs/expressions.json
#	api_docs/field_formats.json
#	api_docs/fleet.json
#	api_docs/kibana_react.json
#	api_docs/kibana_react.mdx
#	api_docs/lists.json
#	api_docs/observability.json
#	api_docs/reporting.json
#	api_docs/rule_registry.json
#	api_docs/rule_registry.mdx
#	api_docs/security_solution.json
#	api_docs/security_solution.mdx
#	api_docs/timelines.json
#	api_docs/timelines.mdx
#	api_docs/visualizations.mdx
2021-08-30 11:02:04 -04:00

257 lines
8.1 KiB
JSON

{
"id": "indexPatternEditor",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps",
"type": "Interface",
"tags": [],
"label": "IndexPatternEditorProps",
"description": [],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.onSave",
"type": "Function",
"tags": [],
"label": "onSave",
"description": [
"\nHandler for the \"save\" footer button"
],
"signature": [
"(indexPattern: ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
},
") => void"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.onSave.$1",
"type": "Object",
"tags": [],
"label": "indexPattern",
"description": [
"- newly created index pattern"
],
"signature": [
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataIndexPatternsPluginApi",
"section": "def-common.IndexPattern",
"text": "IndexPattern"
}
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.onCancel",
"type": "Function",
"tags": [],
"label": "onCancel",
"description": [
"\nHandler for the \"cancel\" footer button"
],
"signature": [
"(() => void) | undefined"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.defaultTypeIsRollup",
"type": "CompoundType",
"tags": [],
"label": "defaultTypeIsRollup",
"description": [
"\nSets the default index pattern type to rollup. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.IndexPatternEditorProps.requireTimestampField",
"type": "CompoundType",
"tags": [],
"label": "requireTimestampField",
"description": [
"\nSets whether a timestamp field is required to create an index pattern. Defaults to false."
],
"signature": [
"boolean | undefined"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": [],
"start": {
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart",
"type": "Interface",
"tags": [],
"label": "PluginStart",
"description": [],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.openEditor",
"type": "Function",
"tags": [],
"label": "openEditor",
"description": [],
"signature": [
"(options: ",
{
"pluginId": "indexPatternEditor",
"scope": "public",
"docId": "kibIndexPatternEditorPluginApi",
"section": "def-public.IndexPatternEditorProps",
"text": "IndexPatternEditorProps"
},
") => () => void"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.openEditor.$1",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "indexPatternEditor",
"scope": "public",
"docId": "kibIndexPatternEditorPluginApi",
"section": "def-public.IndexPatternEditorProps",
"text": "IndexPatternEditorProps"
}
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.IndexPatternEditorComponent",
"type": "Function",
"tags": [],
"label": "IndexPatternEditorComponent",
"description": [],
"signature": [
"React.FunctionComponent<",
{
"pluginId": "indexPatternEditor",
"scope": "public",
"docId": "kibIndexPatternEditorPluginApi",
"section": "def-public.IndexPatternEditorProps",
"text": "IndexPatternEditorProps"
},
">"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "indexPatternEditor",
"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": "indexPatternEditor",
"id": "def-public.context",
"type": "Any",
"tags": [],
"label": "context",
"description": [],
"signature": [
"any"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "indexPatternEditor",
"id": "def-public.PluginStart.userPermissions",
"type": "Object",
"tags": [],
"label": "userPermissions",
"description": [],
"signature": [
"{ editIndexPattern: () => boolean; }"
],
"path": "src/plugins/index_pattern_editor/public/types.ts",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}