kibana/api_docs/enterprise_search.json
Stacey Gammon fba0dcc79e
Improve security plugin return types (#101492) (#101657)
* Add explicit security types

* Remove sessionTimeout, seems unused

* add comments

* Add comments and fix test since removing the unused APIs

* remove unused import

* wording cleanup

* Export some types that are part of the public API but not exported

* more improvements for api docs

* update security docs

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* remove unneccessary readonly prefix

* Update all api docs

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
# Conflicts:
#	api_docs/data.json
#	api_docs/data_index_patterns.json
#	api_docs/data_search.json
#	api_docs/deprecations.mdx
#	api_docs/licensing.json
#	api_docs/lists.json
#	api_docs/triggers_actions_ui.json
#	api_docs/usage_collection.json
2021-06-08 16:26:37 -04:00

78 lines
2.1 KiB
JSON

{
"id": "enterpriseSearch",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.ConfigType",
"type": "Type",
"tags": [],
"label": "ConfigType",
"description": [],
"signature": [
"{ readonly host?: string | undefined; readonly enabled: boolean; readonly ssl: Readonly<{ certificateAuthorities?: string | string[] | undefined; } & { verificationMode: \"none\" | \"certificate\" | \"full\"; }>; readonly accessCheckTimeout: number; readonly accessCheckTimeoutWarning: number; }"
],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 33
},
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "enterpriseSearch",
"id": "def-server.configSchema",
"type": "Object",
"tags": [],
"label": "configSchema",
"description": [],
"signature": [
"ObjectType",
"<{ host: ",
"Type",
"<string | undefined>; enabled: ",
"Type",
"<boolean>; accessCheckTimeout: ",
"Type",
"<number>; accessCheckTimeoutWarning: ",
"Type",
"<number>; ssl: ",
"ObjectType",
"<{ certificateAuthorities: ",
"Type",
"<string | string[] | undefined>; verificationMode: ",
"Type",
"<\"none\" | \"certificate\" | \"full\">; }>; }>"
],
"source": {
"path": "x-pack/plugins/enterprise_search/server/index.ts",
"lineNumber": 17
},
"deprecated": false,
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}