github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 18:51:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_server_route_repository.devdocs.json

906 lines
No EOL
33 KiB
JSON
Raw Blame History

{
"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": [
"() => ",
"CreateServerRouteFactory",
"<TRouteHandlerResources, TRouteCreateOptions>"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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: \"get\" | ",
"DestructiveRouteMethod",
"; pathname: string; version: string; }"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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: \"get\" | ",
"DestructiveRouteMethod",
"; pathname: string; version: string; }"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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: ",
"CoreSetup",
"<{}, unknown>; repository: Record<string, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<string, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" | undefined, any, any, any>>; logger: ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.Logger",
"text": "Logger"
},
"; dependencies: TDependencies; }) => void"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": [
"CoreSetup",
"<{}, unknown>"
],
"path": "src/platform/packages/shared/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]: ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<string, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" | undefined, any, any, any>; }"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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.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": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient",
"type": "Interface",
"tags": [],
"label": "RouteRepositoryClient",
"description": [],
"signature": [
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteRepositoryClient",
"text": "RouteRepositoryClient"
},
"<TServerRouteRepository, TAdditionalClientOptions>"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient.fetch",
"type": "Function",
"tags": [],
"label": "fetch",
"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 & ",
"HttpFetchOptions",
">) => Promise<",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ReturnOf",
"text": "ReturnOf"
},
"<TServerRouteRepository, TEndpoint>>"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient.fetch.$1",
"type": "Uncategorized",
"tags": [],
"label": "endpoint",
"description": [],
"signature": [
"TEndpoint"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient.fetch.$2",
"type": "Uncategorized",
"tags": [],
"label": "args",
"description": [],
"signature": [
"MaybeOptionalArgs<",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ClientRequestParamsOf",
"text": "ClientRequestParamsOf"
},
"<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions & ",
"HttpFetchOptions",
">"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient.stream",
"type": "Function",
"tags": [],
"label": "stream",
"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 & ",
"HttpFetchOptions",
">) => ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ReturnOf",
"text": "ReturnOf"
},
"<TServerRouteRepository, TEndpoint> extends ",
"Observable",
"<infer TReturnType> ? TReturnType extends Record<string, unknown> & { type: string; } ? ",
"Observable",
"<TReturnType> : never : never"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient.stream.$1",
"type": "Uncategorized",
"tags": [],
"label": "endpoint",
"description": [],
"signature": [
"TEndpoint"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.RouteRepositoryClient.stream.$2",
"type": "Uncategorized",
"tags": [],
"label": "args",
"description": [],
"signature": [
"MaybeOptionalArgs<",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ClientRequestParamsOf",
"text": "ClientRequestParamsOf"
},
"<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions & ",
"HttpFetchOptions",
">"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.ClientRequestParamsOf",
"type": "Type",
"tags": [],
"label": "ClientRequestParamsOf",
"description": [],
"signature": [
"TServerRouteRepository[TEndpoint] extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<any, infer TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" | undefined, any, any, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRouteCreateOptions",
"text": "ServerRouteCreateOptions"
},
" | undefined> ? TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" ? ClientRequestParamsOfType<TRouteParamsRT> : TRouteParamsRT extends undefined ? {} : never : never"
],
"path": "src/platform/packages/shared/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 ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<any, infer TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" | undefined, any, any, any> ? TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" ? DecodedRequestParamsOfType<TRouteParamsRT> : {} : never"
],
"path": "src/platform/packages/shared/kbn-server-route-repository-utils/src/typings.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/server-route-repository",
"id": "def-server.DefaultRouteCreateOptions",
"type": "Type",
"tags": [],
"label": "DefaultRouteCreateOptions",
"description": [],
"signature": [
"RouteConfigOptions",
"<\"get\" | ",
"DestructiveRouteMethod",
">"
],
"path": "src/platform/packages/shared/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 & string"
],
"path": "src/platform/packages/shared/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",
"<",
"RouteParams",
", ",
"RouteParams",
", unknown>, \"encode\" | \"asEncoder\"> & { encode: ",
"Encode",
"<any, any>; asEncoder: () => ",
"Encoder",
"<any, any>; }"
],
"path": "src/platform/packages/shared/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 ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<any, any, any, infer TReturnType extends ServerRouteHandlerReturnType, any> ? TReturnType extends ",
"IKibanaResponse",
"<infer TWrappedResponseType extends string | Record<string, any> | Error | Buffer | ",
"Stream",
" | { message: string | Error; attributes?: ",
"ResponseErrorAttributes",
" | undefined; } | undefined> ? TWrappedResponseType : TReturnType : never"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": [
"{ endpoint: TEndpoint; handler: ServerRouteHandler<TRouteHandlerResources, TRouteParamsRT, TReturnType>; security?: ",
"RouteSecurity",
" | undefined; } & (TRouteParamsRT extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" ? { params: TRouteParamsRT; } : {}) & (TRouteCreateOptions extends ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.DefaultRouteCreateOptions",
"text": "DefaultRouteCreateOptions"
},
" ? { options: TRouteCreateOptions; } : {})"
],
"path": "src/platform/packages/shared/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]: ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRoute",
"text": "ServerRoute"
},
"<string, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.RouteParamsRT",
"text": "RouteParamsRT"
},
" | undefined, any, any, ",
{
"pluginId": "@kbn/server-route-repository-utils",
"scope": "common",
"docId": "kibKbnServerRouteRepositoryUtilsPluginApi",
"section": "def-common.ServerRouteCreateOptions",
"text": "ServerRouteCreateOptions"
},
" | undefined>; }"
],
"path": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/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": "src/platform/packages/shared/kbn-server-route-repository/src/validation_objects.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
]
},
"common": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink