* Add packages * Update docs * Fix test and types * debug heap size * remove debug heap line * updated docs
914 lines
No EOL
30 KiB
JSON
914 lines
No EOL
30 KiB
JSON
{
|
|
"id": "@kbn/server-http-tools",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig",
|
|
"type": "Class",
|
|
"tags": [],
|
|
"label": "SslConfig",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.redirectHttpFromPort",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "redirectHttpFromPort",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.certificate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "certificate",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.certificateAuthorities",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "certificateAuthorities",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.keyPassphrase",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyPassphrase",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.requestCert",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "requestCert",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.rejectUnauthorized",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "rejectUnauthorized",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.cipherSuites",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "cipherSuites",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.supportedProtocols",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "supportedProtocols",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.getSecureOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSecureOptions",
|
|
"description": [
|
|
"\nOptions that affect the OpenSSL protocol behavior via numeric bitmask of the SSL_OP_* options from OpenSSL Options."
|
|
],
|
|
"signature": [
|
|
"() => number"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.createServer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createServer",
|
|
"description": [],
|
|
"signature": [
|
|
"(serverOptions: ",
|
|
"ServerOptions",
|
|
", listenerOptions: ",
|
|
"ListenerOptions",
|
|
") => ",
|
|
"Server"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/create_server.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.createServer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serverOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"ServerOptions"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/create_server.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.createServer.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "listenerOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"ListenerOptions"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/create_server.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "defaultValidationErrorHandler",
|
|
"description": [
|
|
"\nUsed to replicate Hapi v16 and below's validation responses. Should be used in the routes.validate.failAction key."
|
|
],
|
|
"signature": [
|
|
"(request: ",
|
|
"Request",
|
|
", h: ",
|
|
"ResponseToolkit",
|
|
", err: Error | undefined) => ",
|
|
"Lifecycle",
|
|
".ReturnValue"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"Request"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "h",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseToolkit"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "err",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getListenerOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getListenerOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.IHttpConfig",
|
|
"text": "IHttpConfig"
|
|
},
|
|
") => ",
|
|
"ListenerOptions"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_listener_options.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getListenerOptions.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.IHttpConfig",
|
|
"text": "IHttpConfig"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_listener_options.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRequestId",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
"Request",
|
|
", { allowFromAnyIp, ipAllowlist }: { allowFromAnyIp: boolean; ipAllowlist: string[]; }) => string"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"Request"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ allowFromAnyIp, ipAllowlist }",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$2.allowFromAnyIp",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowFromAnyIp",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$2.ipAllowlist",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ipAllowlist",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerOptions",
|
|
"description": [
|
|
"\nConverts Kibana `HttpConfig` into `ServerOptions` that are accepted by the Hapi server."
|
|
],
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.IHttpConfig",
|
|
"text": "IHttpConfig"
|
|
},
|
|
", { configureTLS = true }: { configureTLS?: boolean | undefined; }) => ",
|
|
"ServerOptions"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_server_options.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerOptions.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.IHttpConfig",
|
|
"text": "IHttpConfig"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_server_options.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerOptions.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ configureTLS = true }",
|
|
"description": [],
|
|
"signature": [
|
|
"{ configureTLS?: boolean | undefined; }"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/get_server_options.ts",
|
|
"deprecated": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ICorsConfig",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig.allowCredentials",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowCredentials",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig.allowOrigin",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "allowOrigin",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IHttpConfig",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.host",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "host",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.port",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "port",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.maxPayload",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "maxPayload",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ByteSizeValue",
|
|
"text": "ByteSizeValue"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.keepaliveTimeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "keepaliveTimeout",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.socketTimeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "socketTimeout",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.cors",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "cors",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ICorsConfig",
|
|
"text": "ICorsConfig"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.ssl",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ssl",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ISslConfig",
|
|
"text": "ISslConfig"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.shutdownTimeout",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "shutdownTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"moment.Duration"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISslConfig",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.certificate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "certificate",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.certificateAuthorities",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "certificateAuthorities",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.cipherSuites",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "cipherSuites",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.keyPassphrase",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyPassphrase",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.requestCert",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requestCert",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.rejectUnauthorized",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rejectUnauthorized",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.getSecureOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSecureOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => number) | undefined"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.sslSchema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sslSchema",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<{ certificate: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; certificateAuthorities: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | string[] | undefined>; cipherSuites: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string[]>; enabled: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<boolean>; key: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; keyPassphrase: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; keystore: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<{ path: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; password: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; }>; truststore: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<{ path: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; password: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; }>; redirectHttpFromPort: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<number | undefined>; supportedProtocols: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string[]>; clientAuthentication: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "server",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-server.Type",
|
|
"text": "Type"
|
|
},
|
|
"<\"none\" | \"required\" | \"optional\">; }>"
|
|
],
|
|
"path": "packages/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |