kibana/api_docs/advanced_settings.json
Stacey Gammon 6b8ebbfa18
API docs clean up (#93508) (#93881)
* 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
2021-03-06 10:05:27 -05:00

283 lines
No EOL
9.1 KiB
JSON

{
"id": "advancedSettings",
"client": {
"classes": [
{
"id": "def-public.ComponentRegistry",
"type": "Class",
"tags": [],
"label": "ComponentRegistry",
"description": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.componentType",
"type": "Object",
"label": "componentType",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 28
},
"signature": [
"{ [key: string]: Id; }"
]
},
{
"id": "def-public.ComponentRegistry.defaultRegistry",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_title",
"type": "Function",
"label": "advanced_settings_page_title",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 30
},
"signature": [
"() => JSX.Element"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_subtitle",
"type": "Function",
"label": "advanced_settings_page_subtitle",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 31
},
"signature": [
"() => null"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.defaultRegistry.advanced_settings_page_footer",
"type": "Function",
"label": "advanced_settings_page_footer",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 32
},
"signature": [
"() => null"
]
}
],
"description": [],
"label": "defaultRegistry",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 29
}
},
{
"id": "def-public.ComponentRegistry.registry",
"type": "Object",
"tags": [],
"children": [],
"description": [],
"label": "registry",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 35
}
},
{
"id": "def-public.ComponentRegistry.setup",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.setup.componentType",
"type": "Object",
"label": "componentType",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 72
},
"signature": [
"{ [key: string]: Id; }"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.setup.register",
"type": "Function",
"label": "register",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 73
},
"signature": [
"(id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void"
]
}
],
"description": [],
"label": "setup",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 71
}
},
{
"id": "def-public.ComponentRegistry.start",
"type": "Object",
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.ComponentRegistry.start.componentType",
"type": "Object",
"label": "componentType",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 77
},
"signature": [
"{ [key: string]: Id; }"
]
},
{
"tags": [],
"id": "def-public.ComponentRegistry.start.get",
"type": "Function",
"label": "get",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 78
},
"signature": [
"(id: Id) => React.ComponentType<Record<string, any> | undefined>"
]
}
],
"description": [],
"label": "start",
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 76
}
}
],
"source": {
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
"lineNumber": 27
},
"initialIsOpen": false
}
],
"functions": [
{
"tags": [],
"id": "def-public.LazyField",
"type": "Function",
"label": "LazyField",
"description": [
"\nExports the field component as a React.lazy component. We're explicitly naming it lazy here\nso any plugin that would import that can clearly see it's lazy loaded and can only be used\ninside a suspense context."
],
"source": {
"path": "src/plugins/advanced_settings/public/index.ts",
"lineNumber": 20
},
"signature": [
"React.LazyExoticComponent<typeof ",
"Field",
">"
],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"id": "def-public.AdvancedSettingsSetup",
"type": "Interface",
"label": "AdvancedSettingsSetup",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AdvancedSettingsSetup.component",
"type": "Object",
"label": "component",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 16
},
"signature": [
"{ componentType: { [key: string]: Id; }; register: (id: Id, component: React.ComponentType<Record<string, any> | undefined>, allowOverride?: boolean) => void; }"
]
}
],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 15
},
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"id": "def-public.AdvancedSettingsStart",
"type": "Interface",
"label": "AdvancedSettingsStart",
"description": [],
"tags": [],
"children": [
{
"tags": [],
"id": "def-public.AdvancedSettingsStart.component",
"type": "Object",
"label": "component",
"description": [],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 19
},
"signature": [
"{ componentType: { [key: string]: Id; }; get: (id: Id) => React.ComponentType<Record<string, any> | undefined>; }"
]
}
],
"source": {
"path": "src/plugins/advanced_settings/public/types.ts",
"lineNumber": 18
},
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}