* 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>
301 lines
12 KiB
JSON
301 lines
12 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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L28"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L30"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L31"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L32"
|
|
},
|
|
"signature": [
|
|
"() => null"
|
|
]
|
|
}
|
|
],
|
|
"description": [],
|
|
"label": "defaultRegistry",
|
|
"source": {
|
|
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
|
"lineNumber": 29,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L29"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L35"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L72"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L73"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L71"
|
|
}
|
|
},
|
|
{
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L77"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L78"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L76"
|
|
}
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/advanced_settings/public/component_registry/component_registry.ts",
|
|
"lineNumber": 27,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/component_registry/component_registry.ts#L27"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/index.ts#L20"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L16"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L15"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L19"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/advanced_settings/public/types.ts#L18"
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |