import type { IHttpRequestContext, INoContentRequest, IRestRoute, IServerFavIconResponse, IServerInfoResponse, IServerLivezResponse, IServerReadyzResponse, IServerRootResponse, IServerSpecResponse, ITag } from "@twin.org/api-models"; /** * The tag to associate with the routes. */ export declare const tagsInformation: ITag[]; /** * The REST routes for server information. * @param baseRouteName Prefix to prepend to the paths. * @param componentName The name of the component to use in the routes stored in the ComponentFactory. * @returns The generated routes. */ export declare function generateRestRoutesInformation(baseRouteName: string, componentName: string): IRestRoute[]; /** * Get the root for the server. * @param httpRequestContext The request context for the API. * @param componentName The name of the component to use in the routes. * @param request The request. * @returns The response object with additional http response properties. */ export declare function serverRoot(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise; /** * Get the information for the server. * @param httpRequestContext The request context for the API. * @param componentName The name of the component to use in the routes. * @param request The request. * @returns The response object with additional http response properties. */ export declare function serverInfo(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise; /** * Get the livez for the server. * @param httpRequestContext The request context for the API. * @param componentName The name of the component to use in the routes. * @param request The request. * @returns The response object with additional http response properties. */ export declare function serverLivez(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise; /** * Get the readyz for the server. * @param httpRequestContext The request context for the API. * @param componentName The name of the component to use in the routes. * @param request The request. * @returns The response object with additional http response properties. */ export declare function serverReadyz(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise; /** * Get the favicon for the server. * @param httpRequestContext The request context for the API. * @param componentName The name of the component to use in the routes. * @param request The request. * @returns The response object with additional http response properties. */ export declare function serverFavIcon(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise; /** * Get the spec for the server. * @param httpRequestContext The request context for the API. * @param componentName The name of the component to use in the routes. * @param request The request. * @returns The response object with additional http response properties. */ export declare function serverSpec(httpRequestContext: IHttpRequestContext, componentName: string, request: INoContentRequest): Promise;