kibana/api_docs/kbn_server_route_repository.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 WithoutIncompatibleMethods<",
          "Type",
          "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> | undefined = undefined>(route: ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRoute",
            "text": "ServerRoute"
          },
          "<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>) => ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRoute",
            "text": "ServerRoute"
          },
          "<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>"
        ],
        "path": "packages/kbn-server-route-repository/src/create_server_route_factory.ts",
        "deprecated": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.createServerRouteRepository",
        "type": "Function",
        "tags": [],
        "label": "createServerRouteRepository",
        "description": [],
        "signature": [
          "() => ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRouteRepository",
            "text": "ServerRouteRepository"
          },
          "<TRouteHandlerResources, TRouteCreateOptions, {}>"
        ],
        "path": "packages/kbn-server-route-repository/src/create_server_route_repository.ts",
        "deprecated": false,
        "children": [],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.decodeRequestParams",
        "type": "Function",
        "tags": [],
        "label": "decodeRequestParams",
        "description": [],
        "signature": [
          "(params: KibanaRequestParams, paramsRt: T) => ",
          "OutputOf",
          "<T>"
        ],
        "path": "packages/kbn-server-route-repository/src/decode_request_params.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.decodeRequestParams.$1",
            "type": "Object",
            "tags": [],
            "label": "params",
            "description": [],
            "signature": [
              "KibanaRequestParams"
            ],
            "path": "packages/kbn-server-route-repository/src/decode_request_params.ts",
            "deprecated": 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,
            "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; }"
        ],
        "path": "packages/kbn-server-route-repository/src/format_request.ts",
        "deprecated": 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/src/format_request.ts",
            "deprecated": 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/src/format_request.ts",
            "deprecated": 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; }"
        ],
        "path": "packages/kbn-server-route-repository/src/parse_endpoint.ts",
        "deprecated": 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/src/parse_endpoint.ts",
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.ServerRouteRepository",
        "type": "Interface",
        "tags": [],
        "label": "ServerRouteRepository",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRouteRepository",
            "text": "ServerRouteRepository"
          },
          "<TRouteHandlerResources, TRouteCreateOptions, TRouteState>"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.ServerRouteRepository.add",
            "type": "Function",
            "tags": [],
            "label": "add",
            "description": [],
            "signature": [
              "<TEndpoint extends string, TReturnType, TRouteParamsRT extends WithoutIncompatibleMethods<",
              "Type",
              "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> | undefined = undefined>(route: ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRoute",
                "text": "ServerRoute"
              },
              "<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>) => ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRouteRepository",
                "text": "ServerRouteRepository"
              },
              "<TRouteHandlerResources, TRouteCreateOptions, TRouteState & { [key in TEndpoint]: ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRoute",
                "text": "ServerRoute"
              },
              "<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>; }>"
            ],
            "path": "packages/kbn-server-route-repository/src/typings.ts",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "@kbn/server-route-repository",
                "id": "def-server.ServerRouteRepository.add.$1",
                "type": "CompoundType",
                "tags": [],
                "label": "route",
                "description": [],
                "signature": [
                  {
                    "pluginId": "@kbn/server-route-repository",
                    "scope": "server",
                    "docId": "kibKbnServerRouteRepositoryPluginApi",
                    "section": "def-server.ServerRoute",
                    "text": "ServerRoute"
                  },
                  "<TEndpoint, TRouteParamsRT, TRouteHandlerResources, TReturnType, TRouteCreateOptions>"
                ],
                "path": "packages/kbn-server-route-repository/src/typings.ts",
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.ServerRouteRepository.merge",
            "type": "Function",
            "tags": [],
            "label": "merge",
            "description": [],
            "signature": [
              "<TServerRouteRepository extends ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRouteRepository",
                "text": "ServerRouteRepository"
              },
              "<TRouteHandlerResources, TRouteCreateOptions, ",
              "RouteState",
              ">>(repository: TServerRouteRepository) => TServerRouteRepository extends ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRouteRepository",
                "text": "ServerRouteRepository"
              },
              "<TRouteHandlerResources, TRouteCreateOptions, infer TRouteStateToMerge> ? ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRouteRepository",
                "text": "ServerRouteRepository"
              },
              "<TRouteHandlerResources, TRouteCreateOptions, TRouteState & TRouteStateToMerge> : never"
            ],
            "path": "packages/kbn-server-route-repository/src/typings.ts",
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "@kbn/server-route-repository",
                "id": "def-server.ServerRouteRepository.merge.$1",
                "type": "Uncategorized",
                "tags": [],
                "label": "repository",
                "description": [],
                "signature": [
                  "TServerRouteRepository"
                ],
                "path": "packages/kbn-server-route-repository/src/typings.ts",
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.ServerRouteRepository.getRoutes",
            "type": "Function",
            "tags": [],
            "label": "getRoutes",
            "description": [],
            "signature": [
              "() => ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ServerRoute",
                "text": "ServerRoute"
              },
              "<string, WithoutIncompatibleMethods<",
              "Type",
              "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>>, TRouteHandlerResources, unknown, TRouteCreateOptions>[]"
            ],
            "path": "packages/kbn-server-route-repository/src/typings.ts",
            "deprecated": false,
            "children": [],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.ClientRequestParamsOf",
        "type": "Type",
        "tags": [],
        "label": "ClientRequestParamsOf",
        "description": [],
        "signature": [
          "TServerRouteRepository extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRouteRepository",
            "text": "ServerRouteRepository"
          },
          "<any, any, infer TRouteState> ? TEndpoint extends keyof TRouteState ? TRouteState[TEndpoint] extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRoute",
            "text": "ServerRoute"
          },
          "<any, infer TRouteParamsRT, any, any, Record<string, any>> ? TRouteParamsRT extends WithoutIncompatibleMethods<",
          "Type",
          "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> ? ClientRequestParamsOfType<TRouteParamsRT> : {} : never : never : never"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.DecodedRequestParamsOf",
        "type": "Type",
        "tags": [],
        "label": "DecodedRequestParamsOf",
        "description": [],
        "signature": [
          "TServerRouteRepository extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRouteRepository",
            "text": "ServerRouteRepository"
          },
          "<any, any, infer TRouteState> ? TEndpoint extends keyof TRouteState ? TRouteState[TEndpoint] extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRoute",
            "text": "ServerRoute"
          },
          "<any, infer TRouteParamsRT, any, any, Record<string, any>> ? TRouteParamsRT extends WithoutIncompatibleMethods<",
          "Type",
          "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> ? DecodedRequestParamsOfType<TRouteParamsRT> : {} : never : never : never"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.EndpointOf",
        "type": "Type",
        "tags": [],
        "label": "EndpointOf",
        "description": [],
        "signature": [
          "TServerRouteRepository extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRouteRepository",
            "text": "ServerRouteRepository"
          },
          "<any, any, infer TRouteState> ? keyof TRouteState : never"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.ReturnOf",
        "type": "Type",
        "tags": [],
        "label": "ReturnOf",
        "description": [],
        "signature": [
          "TServerRouteRepository extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRouteRepository",
            "text": "ServerRouteRepository"
          },
          "<any, any, infer TRouteState> ? TEndpoint extends keyof TRouteState ? TRouteState[TEndpoint] extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ServerRoute",
            "text": "ServerRoute"
          },
          "<any, any, any, infer TReturnType, Record<string, any>> ? TReturnType : never : never : never"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.RouteParamsRT",
        "type": "Type",
        "tags": [],
        "label": "RouteParamsRT",
        "description": [],
        "signature": [
          "Pick<",
          "Type",
          "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>, \"pipe\" | \"name\" | \"is\" | \"_A\" | \"_O\" | \"validate\" | \"_I\" | \"asDecoder\" | \"decode\"> & { encode: ",
          "Encode",
          "<any, any>; asEncoder: () => ",
          "Encoder",
          "<any, any>; }"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.RouteRepositoryClient",
        "type": "Type",
        "tags": [],
        "label": "RouteRepositoryClient",
        "description": [],
        "signature": [
          "<TEndpoint extends ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.EndpointOf",
            "text": "EndpointOf"
          },
          "<TServerRouteRepository>>(options: { endpoint: TEndpoint; } & ",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ClientRequestParamsOf",
            "text": "ClientRequestParamsOf"
          },
          "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions) => Promise<",
          {
            "pluginId": "@kbn/server-route-repository",
            "scope": "server",
            "docId": "kibKbnServerRouteRepositoryPluginApi",
            "section": "def-server.ReturnOf",
            "text": "ReturnOf"
          },
          "<TServerRouteRepository, TEndpoint>>"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "returnComment": [],
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.RouteRepositoryClient.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "options",
            "description": [],
            "signature": [
              "{ endpoint: TEndpoint; } & ",
              {
                "pluginId": "@kbn/server-route-repository",
                "scope": "server",
                "docId": "kibKbnServerRouteRepositoryPluginApi",
                "section": "def-server.ClientRequestParamsOf",
                "text": "ClientRequestParamsOf"
              },
              "<TServerRouteRepository, TEndpoint> & TAdditionalClientOptions"
            ],
            "path": "packages/kbn-server-route-repository/src/typings.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.ServerRoute",
        "type": "Type",
        "tags": [],
        "label": "ServerRoute",
        "description": [],
        "signature": [
          "{ endpoint: TEndpoint; params?: TRouteParamsRT | undefined; handler: ({}: TRouteHandlerResources & (TRouteParamsRT extends WithoutIncompatibleMethods<",
          "Type",
          "<{ path?: any; query?: any; body?: any; }, { path?: any; query?: any; body?: any; }, unknown>> ? DecodedRequestParamsOfType<TRouteParamsRT> : {})) => Promise<TReturnType>; } & TRouteCreateOptions"
        ],
        "path": "packages/kbn-server-route-repository/src/typings.ts",
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [
      {
        "parentPluginId": "@kbn/server-route-repository",
        "id": "def-server.routeValidationObject",
        "type": "Object",
        "tags": [],
        "label": "routeValidationObject",
        "description": [],
        "path": "packages/kbn-server-route-repository/src/route_validation_object.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.routeValidationObject.body",
            "type": "Object",
            "tags": [],
            "label": "body",
            "description": [
              "// `body` can be null, but `validate` expects non-nullable types\n// if any validation is defined. Not having validation currently\n// means we don't get the payload. See\n// https://github.com/elastic/kibana/issues/50179"
            ],
            "signature": [
              {
                "pluginId": "@kbn/config-schema",
                "scope": "server",
                "docId": "kibKbnConfigSchemaPluginApi",
                "section": "def-server.Type",
                "text": "Type"
              },
              "<Readonly<{} & {}> | null>"
            ],
            "path": "packages/kbn-server-route-repository/src/route_validation_object.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.routeValidationObject.params",
            "type": "Object",
            "tags": [],
            "label": "params",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/config-schema",
                "scope": "server",
                "docId": "kibKbnConfigSchemaPluginApi",
                "section": "def-server.ObjectType",
                "text": "ObjectType"
              },
              "<{}>"
            ],
            "path": "packages/kbn-server-route-repository/src/route_validation_object.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "@kbn/server-route-repository",
            "id": "def-server.routeValidationObject.query",
            "type": "Object",
            "tags": [],
            "label": "query",
            "description": [],
            "signature": [
              {
                "pluginId": "@kbn/config-schema",
                "scope": "server",
                "docId": "kibKbnConfigSchemaPluginApi",
                "section": "def-server.ObjectType",
                "text": "ObjectType"
              },
              "<{}>"
            ],
            "path": "packages/kbn-server-route-repository/src/route_validation_object.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ]
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}