mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
856 lines
No EOL
30 KiB
JSON
856 lines
No EOL
30 KiB
JSON
{
|
|
"id": "@kbn/server-route-repository",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.createServerRouteFactory",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "createServerRouteFactory",
|
|
"description": [],
|
|
"signature": [
|
|
"() => <TEndpoint extends string, TReturnType, TRouteParamsRT extends ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" | undefined = undefined>(route: ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRoute",
|
|
"text": "ServerRoute"
|
|
},
|
|
"<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>) => Record<TEndpoint, ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRoute",
|
|
"text": "ServerRoute"
|
|
},
|
|
"<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/create_server_route_factory.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.decodeRequestParams",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "decodeRequestParams",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: Partial<{ path: any; query: any; body: any; }>, paramsRt: T) => ",
|
|
"OutputOf",
|
|
"<T>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/decode_request_params.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.decodeRequestParams.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Partial<{ path: any; query: any; body: any; }>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/decode_request_params.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.decodeRequestParams.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "paramsRt",
|
|
"description": [],
|
|
"signature": [
|
|
"T"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/decode_request_params.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.formatRequest",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "formatRequest",
|
|
"description": [],
|
|
"signature": [
|
|
"(endpoint: string, pathParams: Record<string, any>) => { method: Method; pathname: string; version: string; }"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/format_request.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.formatRequest.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "endpoint",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/format_request.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.formatRequest.$2",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "pathParams",
|
|
"description": [],
|
|
"signature": [
|
|
"Record<string, any>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/format_request.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.parseEndpoint",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "parseEndpoint",
|
|
"description": [],
|
|
"signature": [
|
|
"(endpoint: string) => { method: Method; pathname: string; version: string; }"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/parse_endpoint.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.parseEndpoint.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "endpoint",
|
|
"description": [],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/parse_endpoint.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.registerRoutes",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "registerRoutes",
|
|
"description": [],
|
|
"signature": [
|
|
"({\n core,\n repository,\n logger,\n dependencies,\n}: { core: ",
|
|
{
|
|
"pluginId": "@kbn/core-lifecycle-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreLifecycleServerPluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>; repository: Record<string, { endpoint: string; params?: any; handler: ({}: any) => Promise<any>; } & ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRouteCreateOptions",
|
|
"text": "ServerRouteCreateOptions"
|
|
},
|
|
">; logger: ",
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "common",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-common.Logger",
|
|
"text": "Logger"
|
|
},
|
|
"; dependencies: TDependencies; }) => void"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/register_routes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.registerRoutes.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n core,\n repository,\n logger,\n dependencies,\n}",
|
|
"description": [],
|
|
"path": "packages/kbn-server-route-repository/src/register_routes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.registerRoutes.$1.core",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "core",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-lifecycle-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreLifecycleServerPluginApi",
|
|
"section": "def-server.CoreSetup",
|
|
"text": "CoreSetup"
|
|
},
|
|
"<object, unknown>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/register_routes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.registerRoutes.$1.repository",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "repository",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: { endpoint: string; params?: any; handler: ({}: any) => Promise<any>; } & ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRouteCreateOptions",
|
|
"text": "ServerRouteCreateOptions"
|
|
},
|
|
"; }"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/register_routes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.registerRoutes.$1.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "common",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-common.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/register_routes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.registerRoutes.$1.dependencies",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "dependencies",
|
|
"description": [],
|
|
"signature": [
|
|
"TDependencies"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/register_routes.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.stripNullishRequestParameters",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "stripNullishRequestParameters",
|
|
"description": [],
|
|
"signature": [
|
|
"(params: KibanaRequestParams) => Partial<{ path: any; body: any; query: any; }>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/strip_nullish_request_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.stripNullishRequestParameters.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"KibanaRequestParams"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/strip_nullish_request_parameters.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.DefaultRouteCreateOptions",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DefaultRouteCreateOptions",
|
|
"description": [],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.DefaultRouteCreateOptions.options",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.RouteConfigOptions",
|
|
"text": "RouteConfigOptions"
|
|
},
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.RouteMethod",
|
|
"text": "RouteMethod"
|
|
},
|
|
"> | undefined"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.DefaultRouteHandlerResources",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "DefaultRouteHandlerResources",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.DefaultRouteHandlerResources",
|
|
"text": "DefaultRouteHandlerResources"
|
|
},
|
|
" extends CoreRouteHandlerResources"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.DefaultRouteHandlerResources.logger",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "logger",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/logging",
|
|
"scope": "common",
|
|
"docId": "kibKbnLoggingPluginApi",
|
|
"section": "def-common.Logger",
|
|
"text": "Logger"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.RouteState",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "RouteState",
|
|
"description": [],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.RouteState.Unnamed",
|
|
"type": "IndexSignature",
|
|
"tags": [],
|
|
"label": "[endpoint: string]: any",
|
|
"description": [],
|
|
"signature": [
|
|
"[endpoint: string]: any"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.ClientRequestParamsOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ClientRequestParamsOf",
|
|
"description": [],
|
|
"signature": [
|
|
"TServerRouteRepository[TEndpoint] extends { endpoint: any; params?: infer TRouteParamsRT extends ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" | undefined | undefined; handler: ({}: any) => Promise<any>; } & ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRouteCreateOptions",
|
|
"text": "ServerRouteCreateOptions"
|
|
},
|
|
" ? TRouteParamsRT extends ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" ? ClientRequestParamsOfType<TRouteParamsRT> : {} : never"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.DecodedRequestParamsOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "DecodedRequestParamsOf",
|
|
"description": [],
|
|
"signature": [
|
|
"TServerRouteRepository[TEndpoint] extends { endpoint: any; params?: infer TRouteParamsRT extends ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" | undefined | undefined; handler: ({}: any) => Promise<any>; } & ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRouteCreateOptions",
|
|
"text": "ServerRouteCreateOptions"
|
|
},
|
|
" ? TRouteParamsRT extends ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" ? DecodedRequestParamsOfType<TRouteParamsRT> : {} : never"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.EndpointOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "EndpointOf",
|
|
"description": [],
|
|
"signature": [
|
|
"keyof TServerRouteRepository"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.IoTsParamsObject",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "IoTsParamsObject",
|
|
"description": [],
|
|
"signature": [
|
|
"Omit<",
|
|
"Type",
|
|
"<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>, \"encode\" | \"asEncoder\"> & { encode: ",
|
|
"Encode",
|
|
"<any, any>; asEncoder: () => ",
|
|
"Encoder",
|
|
"<any, any>; }"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.ReturnOf",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ReturnOf",
|
|
"description": [],
|
|
"signature": [
|
|
"TServerRouteRepository[TEndpoint] extends { endpoint: any; params?: any; handler: ({}: any) => Promise<infer TReturnType>; } & ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ServerRouteCreateOptions",
|
|
"text": "ServerRouteCreateOptions"
|
|
},
|
|
" ? TReturnType extends ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.IKibanaResponse",
|
|
"text": "IKibanaResponse"
|
|
},
|
|
"<infer TWrappedResponseType extends string | Record<string, any> | Error | Buffer | ",
|
|
"Stream",
|
|
" | { message: string | Error; attributes?: ",
|
|
{
|
|
"pluginId": "@kbn/core-http-server",
|
|
"scope": "server",
|
|
"docId": "kibKbnCoreHttpServerPluginApi",
|
|
"section": "def-server.ResponseErrorAttributes",
|
|
"text": "ResponseErrorAttributes"
|
|
},
|
|
" | undefined; } | undefined> ? TWrappedResponseType : TReturnType : never"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.RouteParamsRT",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteParamsRT",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.IoTsParamsObject",
|
|
"text": "IoTsParamsObject"
|
|
},
|
|
" | ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ZodParamsObject",
|
|
"text": "ZodParamsObject"
|
|
}
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.RouteRepositoryClient",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "RouteRepositoryClient",
|
|
"description": [],
|
|
"signature": [
|
|
"<TEndpoint extends Extract<keyof TServerRouteRepository, string>>(endpoint: TEndpoint, ...args: MaybeOptionalArgs<",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ClientRequestParamsOf",
|
|
"text": "ClientRequestParamsOf"
|
|
},
|
|
"<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions>) => Promise<",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ReturnOf",
|
|
"text": "ReturnOf"
|
|
},
|
|
"<TServerRouteRepository, TEndpoint>>"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"returnComment": [],
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.RouteRepositoryClient.$1",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "endpoint",
|
|
"description": [],
|
|
"signature": [
|
|
"TEndpoint"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.RouteRepositoryClient.$2",
|
|
"type": "Uncategorized",
|
|
"tags": [],
|
|
"label": "args",
|
|
"description": [],
|
|
"signature": [
|
|
"RequiredKeys",
|
|
"<",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ClientRequestParamsOf",
|
|
"text": "ClientRequestParamsOf"
|
|
},
|
|
"<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions> extends never ? [] | [",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ClientRequestParamsOf",
|
|
"text": "ClientRequestParamsOf"
|
|
},
|
|
"<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions] : [",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.ClientRequestParamsOf",
|
|
"text": "ClientRequestParamsOf"
|
|
},
|
|
"<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions]"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.ServerRoute",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ServerRoute",
|
|
"description": [],
|
|
"signature": [
|
|
"ValidateEndpoint<TEndpoint> extends true ? { endpoint: TEndpoint; params?: TRouteParamsRT | undefined; handler: ({}: TRouteHandlerResources & (TRouteParamsRT extends ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" ? DecodedRequestParamsOfType<TRouteParamsRT> : {})) => Promise<TReturnType>; } & TRouteCreateOptions : never"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.ServerRouteRepository",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "ServerRouteRepository",
|
|
"description": [],
|
|
"signature": [
|
|
"{ [x: string]: { endpoint: string; params?: ",
|
|
{
|
|
"pluginId": "@kbn/server-route-repository-utils",
|
|
"scope": "common",
|
|
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
|
|
"section": "def-common.RouteParamsRT",
|
|
"text": "RouteParamsRT"
|
|
},
|
|
" | undefined; handler: ({}: any) => Promise<any>; } & Record<string, any>; }"
|
|
],
|
|
"path": "packages/kbn-server-route-repository-utils/src/typings.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.passThroughValidationObject",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "passThroughValidationObject",
|
|
"description": [],
|
|
"path": "packages/kbn-server-route-repository/src/validation_objects.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.passThroughValidationObject.body",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "body",
|
|
"description": [],
|
|
"signature": [
|
|
"Zod.ZodAny"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/validation_objects.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.passThroughValidationObject.params",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [],
|
|
"signature": [
|
|
"Zod.ZodAny"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/validation_objects.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/server-route-repository",
|
|
"id": "def-server.passThroughValidationObject.query",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "query",
|
|
"description": [],
|
|
"signature": [
|
|
"Zod.ZodAny"
|
|
],
|
|
"path": "packages/kbn-server-route-repository/src/validation_objects.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
]
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |