mirror of
https://github.com/elastic/kibana.git
synced 2025-04-18 23:21:39 -04:00
1300 lines
No EOL
43 KiB
JSON
1300 lines
No EOL
43 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": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.redirectHttpFromPort",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "redirectHttpFromPort",
|
|
"description": [],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.certificate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "certificate",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.certificateAuthorities",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "certificateAuthorities",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.keyPassphrase",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyPassphrase",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.requestCert",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "requestCert",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.rejectUnauthorized",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "rejectUnauthorized",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.cipherSuites",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "cipherSuites",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.supportedProtocols",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "supportedProtocols",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.isEqualTo",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "isEqualTo",
|
|
"description": [],
|
|
"signature": [
|
|
"(otherConfig: ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.SslConfig",
|
|
"text": "SslConfig"
|
|
},
|
|
") => boolean"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.SslConfig.isEqualTo.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "otherConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.SslConfig",
|
|
"text": "SslConfig"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.createServer",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createServer",
|
|
"description": [],
|
|
"signature": [
|
|
"(serverOptions: ",
|
|
"ServerOptions",
|
|
") => ",
|
|
"Server",
|
|
"<",
|
|
"ServerApplicationState",
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/create_server.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.createServer.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "serverOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"ServerOptions"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/create_server.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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",
|
|
"<",
|
|
"ReqRefDefaults",
|
|
">, h: ",
|
|
"ResponseToolkit",
|
|
", err: Error | undefined) => ",
|
|
"Lifecycle",
|
|
".ReturnValue<",
|
|
"ReqRefDefaults",
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"Request",
|
|
"<",
|
|
"ReqRefDefaults",
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "h",
|
|
"description": [],
|
|
"signature": [
|
|
"ResponseToolkit"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.defaultValidationErrorHandler.$3",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "err",
|
|
"description": [],
|
|
"signature": [
|
|
"Error | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/default_validation_error_handler.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": false
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getRequestId",
|
|
"description": [],
|
|
"signature": [
|
|
"(request: ",
|
|
"Request",
|
|
"<",
|
|
"ReqRefDefaults",
|
|
">, { allowFromAnyIp, ipAllowlist }: { allowFromAnyIp: boolean; ipAllowlist: string[]; }) => string"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "request",
|
|
"description": [],
|
|
"signature": [
|
|
"Request",
|
|
"<",
|
|
"ReqRefDefaults",
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{ allowFromAnyIp, ipAllowlist }",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$2.allowFromAnyIp",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowFromAnyIp",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getRequestId.$2.ipAllowlist",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "ipAllowlist",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_request_id.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerListener",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerListener",
|
|
"description": [],
|
|
"signature": [
|
|
"(config: ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.IHttpConfig",
|
|
"text": "IHttpConfig"
|
|
},
|
|
", options: GetServerListenerOptions) => ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ServerListener",
|
|
"text": "ServerListener"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_listener.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerListener.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "config",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.IHttpConfig",
|
|
"text": "IHttpConfig"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_listener.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerListener.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
"GetServerListenerOptions"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_listener.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"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": "src/platform/packages/shared/kbn-server-http-tools/src/get_server_options.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "src/platform/packages/shared/kbn-server-http-tools/src/get_server_options.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "src/platform/packages/shared/kbn-server-http-tools/src/get_server_options.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerTLSOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getServerTLSOptions",
|
|
"description": [
|
|
"\nConverts Kibana `SslConfig` into `TLSOptions` that are accepted by the Hapi server,\nand by https.Server.setSecureContext()"
|
|
],
|
|
"signature": [
|
|
"(ssl: ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ISslConfig",
|
|
"text": "ISslConfig"
|
|
},
|
|
") => ",
|
|
"ServerOptions",
|
|
"<typeof ",
|
|
"IncomingMessage",
|
|
", typeof ",
|
|
"ServerResponse",
|
|
"> | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_tls_options.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.getServerTLSOptions.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "ssl",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ISslConfig",
|
|
"text": "ISslConfig"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/get_tls_options.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.setTlsConfig",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "setTlsConfig",
|
|
"description": [],
|
|
"signature": [
|
|
"(hapiServer: ",
|
|
"Server",
|
|
"<",
|
|
"ServerApplicationState",
|
|
">, sslConfig: ",
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ISslConfig",
|
|
"text": "ISslConfig"
|
|
},
|
|
") => void"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/set_tls_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.setTlsConfig.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "hapiServer",
|
|
"description": [],
|
|
"signature": [
|
|
"Server",
|
|
"<",
|
|
"ServerApplicationState",
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/set_tls_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.setTlsConfig.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sslConfig",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-http-tools",
|
|
"scope": "server",
|
|
"docId": "kibKbnServerHttpToolsPluginApi",
|
|
"section": "def-server.ISslConfig",
|
|
"text": "ISslConfig"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/set_tls_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ICorsConfig",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig.allowCredentials",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "allowCredentials",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ICorsConfig.allowOrigin",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "allowOrigin",
|
|
"description": [],
|
|
"signature": [
|
|
"string[]"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "IHttpConfig",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.protocol",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "protocol",
|
|
"description": [],
|
|
"signature": [
|
|
"\"http1\" | \"http2\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.host",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "host",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.port",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "port",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.maxPayload",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "maxPayload",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ByteSizeValue",
|
|
"text": "ByteSizeValue"
|
|
}
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.keepaliveTimeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "keepaliveTimeout",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.socketTimeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "socketTimeout",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.payloadTimeout",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "payloadTimeout",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": 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": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.shutdownTimeout",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "shutdownTimeout",
|
|
"description": [],
|
|
"signature": [
|
|
"moment.Duration"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.IHttpConfig.restrictInternalApis",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "restrictInternalApis",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "ISslConfig",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.key",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "key",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.certificate",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "certificate",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.certificateAuthorities",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "certificateAuthorities",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.cipherSuites",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "cipherSuites",
|
|
"description": [],
|
|
"signature": [
|
|
"string[] | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.keyPassphrase",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "keyPassphrase",
|
|
"description": [],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.requestCert",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "requestCert",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.rejectUnauthorized",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "rejectUnauthorized",
|
|
"description": [],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ISslConfig.getSecureOptions",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getSecureOptions",
|
|
"description": [],
|
|
"signature": [
|
|
"(() => number) | undefined"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": []
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ServerListener",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ServerListener",
|
|
"description": [
|
|
"\nComposite type of all possible kind of Listener types.\n\nUnfortunately, there's no real common interface between all those concrete classes,\nas `net.Server` and `tls.Server` don't list all the APIs we're using (such as event binding)"
|
|
],
|
|
"signature": [
|
|
"Http2Server",
|
|
" | ",
|
|
"Http2SecureServer",
|
|
" | ",
|
|
"Server",
|
|
"<typeof ",
|
|
"IncomingMessage",
|
|
", typeof ",
|
|
"ServerResponse",
|
|
"> | ",
|
|
"Server",
|
|
"<typeof ",
|
|
"IncomingMessage",
|
|
", typeof ",
|
|
"ServerResponse",
|
|
">"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.ServerProtocol",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ServerProtocol",
|
|
"description": [],
|
|
"signature": [
|
|
"\"http1\" | \"http2\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/types.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.TLS_V1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "TLS_V1",
|
|
"description": [],
|
|
"signature": [
|
|
"\"TLSv1\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.TLS_V1_1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "TLS_V1_1",
|
|
"description": [],
|
|
"signature": [
|
|
"\"TLSv1.1\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.TLS_V1_2",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "TLS_V1_2",
|
|
"description": [],
|
|
"signature": [
|
|
"\"TLSv1.2\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.TLS_V1_3",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "TLS_V1_3",
|
|
"description": [],
|
|
"signature": [
|
|
"\"TLSv1.3\""
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/constants.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/server-http-tools",
|
|
"id": "def-server.sslSchema",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "sslSchema",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<{ certificate: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; certificateAuthorities: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | string[] | undefined>; cipherSuites: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string[]>; enabled: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<boolean>; key: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; keyPassphrase: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; keystore: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<{ path: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; password: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; }>; truststore: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.ObjectType",
|
|
"text": "ObjectType"
|
|
},
|
|
"<{ path: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; password: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string | undefined>; }>; redirectHttpFromPort: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<number | undefined>; supportedProtocols: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<string[]>; clientAuthentication: ",
|
|
{
|
|
"pluginId": "@kbn/config-schema",
|
|
"scope": "common",
|
|
"docId": "kibKbnConfigSchemaPluginApi",
|
|
"section": "def-common.Type",
|
|
"text": "Type"
|
|
},
|
|
"<\"none\" | \"required\" | \"optional\">; }>"
|
|
],
|
|
"path": "src/platform/packages/shared/kbn-server-http-tools/src/ssl/ssl_config.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |