kibana/api_docs/kbn_server_route_repository_utils.devdocs.json

{
  "id": "@kbn/server-route-repository-utils",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/server-route-repository-utils",
        "id": "def-common.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-utils",
            "id": "def-common.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-utils",
            "id": "def-common.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-utils",
        "id": "def-common.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-utils",
            "id": "def-common.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
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/server-route-repository-utils",
        "id": "def-common.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-utils",
            "id": "def-common.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-utils",
        "id": "def-common.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-utils",
            "id": "def-common.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-utils",
        "id": "def-common.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-utils",
            "id": "def-common.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-utils",
        "id": "def-common.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-utils",
        "id": "def-common.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-utils",
        "id": "def-common.DefaultClientOptions",
        "type": "Type",
        "tags": [],
        "label": "DefaultClientOptions",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/core-http-browser",
            "scope": "public",
            "docId": "kibKbnCoreHttpBrowserPluginApi",
            "section": "def-public.HttpFetchOptions",
            "text": "HttpFetchOptions"
          }
        ],
        "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-utils",
        "id": "def-common.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-utils",
        "id": "def-common.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-utils",
        "id": "def-common.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-utils",
        "id": "def-common.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-utils",
        "id": "def-common.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-utils",
            "id": "def-common.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-utils",
            "id": "def-common.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-utils",
        "id": "def-common.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-utils",
        "id": "def-common.ServerRouteCreateOptions",
        "type": "Type",
        "tags": [],
        "label": "ServerRouteCreateOptions",
        "description": [],
        "signature": [
          "{ [x: string]: any; }"
        ],
        "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-utils",
        "id": "def-common.ServerRouteHandlerResources",
        "type": "Type",
        "tags": [],
        "label": "ServerRouteHandlerResources",
        "description": [],
        "signature": [
          "{ [x: string]: any; }"
        ],
        "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository-utils",
        "id": "def-common.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
      },
      {
        "parentPluginId": "@kbn/server-route-repository-utils",
        "id": "def-common.ZodParamsObject",
        "type": "Type",
        "tags": [],
        "label": "ZodParamsObject",
        "description": [],
        "signature": [
          "Zod.ZodObject<{ path?: any; query?: any; body?: any; }, Zod.UnknownKeysParam, Zod.ZodTypeAny, { query?: any; body?: any; path?: any; }, { query?: any; body?: any; path?: any; }>"
        ],
        "path": "packages/kbn-server-route-repository-utils/src/typings.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}