kibana/api_docs/security_oss.json
Stacey Gammon 7111bcf5f4
Fix the API docs bug, where optional functions on interfaces were losing their children. (#107236) (#107905)
* Fix the bug and update tests

* update api docs

* Fix tests
# Conflicts:
#	api_docs/charts.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_field_formats.mdx
#	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/es_ui_shared.mdx
#	api_docs/fleet.mdx
#	api_docs/reporting.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-09 12:51:00 -04:00

203 lines
6 KiB
JSON

{
"id": "securityOss",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecurityOssPluginSetup",
"description": [],
"path": "src/plugins/security_oss/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginSetup.insecureCluster",
"type": "Object",
"tags": [],
"label": "insecureCluster",
"description": [],
"signature": [
"InsecureClusterServiceSetup"
],
"path": "src/plugins/security_oss/public/plugin.ts",
"deprecated": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginStart",
"type": "Interface",
"tags": [],
"label": "SecurityOssPluginStart",
"description": [],
"path": "src/plugins/security_oss/public/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginStart.insecureCluster",
"type": "Object",
"tags": [],
"label": "insecureCluster",
"description": [],
"signature": [
"InsecureClusterServiceStart"
],
"path": "src/plugins/security_oss/public/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "securityOss",
"id": "def-public.SecurityOssPluginStart.anonymousAccess",
"type": "Object",
"tags": [],
"label": "anonymousAccess",
"description": [],
"signature": [
"{ getAccessURLParameters: () => Promise<Record<string, string> | null>; getCapabilities: () => Promise<",
"Capabilities",
">; }"
],
"path": "src/plugins/security_oss/public/plugin.ts",
"deprecated": false
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecurityOssPluginSetup",
"description": [],
"path": "src/plugins/security_oss/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup.showInsecureClusterWarning$",
"type": "Object",
"tags": [],
"label": "showInsecureClusterWarning$",
"description": [
"\nAllows consumers to show/hide the insecure cluster warning."
],
"signature": [
"BehaviorSubject",
"<boolean>"
],
"path": "src/plugins/security_oss/server/plugin.ts",
"deprecated": false
},
{
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup.setAnonymousAccessServiceProvider",
"type": "Function",
"tags": [],
"label": "setAnonymousAccessServiceProvider",
"description": [
"\nSet the provider function that returns a service to deal with the anonymous access."
],
"signature": [
"(provider: () => ",
"AnonymousAccessService",
") => void"
],
"path": "src/plugins/security_oss/server/plugin.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-server.SecurityOssPluginSetup.setAnonymousAccessServiceProvider.$1",
"type": "Function",
"tags": [],
"label": "provider",
"description": [],
"signature": [
"() => ",
"AnonymousAccessService"
],
"path": "src/plugins/security_oss/server/plugin.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "securityOss",
"id": "def-common.AppState",
"type": "Interface",
"tags": [],
"label": "AppState",
"description": [
"\nDefines Security OSS application state."
],
"path": "src/plugins/security_oss/common/app_state.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "securityOss",
"id": "def-common.AppState.insecureClusterAlert",
"type": "Object",
"tags": [],
"label": "insecureClusterAlert",
"description": [],
"signature": [
"{ displayAlert: boolean; }"
],
"path": "src/plugins/security_oss/common/app_state.ts",
"deprecated": false
},
{
"parentPluginId": "securityOss",
"id": "def-common.AppState.anonymousAccess",
"type": "Object",
"tags": [],
"label": "anonymousAccess",
"description": [],
"signature": [
"{ isEnabled: boolean; accessURLParameters: Record<string, string> | null; }"
],
"path": "src/plugins/security_oss/common/app_state.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [],
"objects": []
}
}