clean up api report for search-backend package

Signed-off-by: Emma Indal <emma.indahl@gmail.com>
This commit is contained in:
Emma Indal
2022-06-02 12:02:58 +02:00
parent 2e6b24d537
commit 52cc4d8525
2 changed files with 6 additions and 4 deletions
-4
View File
@@ -11,13 +11,9 @@ import { PermissionAuthorizer } from '@backstage/plugin-permission-common';
import { PermissionEvaluator } from '@backstage/plugin-permission-common';
import { SearchEngine } from '@backstage/plugin-search-backend-node';
// Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function createRouter(options: RouterOptions): Promise<express.Router>;
// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type RouterOptions = {
engine: SearchEngine;
@@ -51,6 +51,9 @@ const jsonObjectSchema: z.ZodSchema<JsonObject> = z.lazy(() => {
return z.record(jsonValueSchema);
});
/**
* @public
*/
export type RouterOptions = {
engine: SearchEngine;
types: Record<string, DocumentTypeInfo>;
@@ -61,6 +64,9 @@ export type RouterOptions = {
const allowedLocationProtocols = ['http:', 'https:'];
/**
* @public
*/
export async function createRouter(
options: RouterOptions,
): Promise<express.Router> {