import { createValidatedOpenApiRouter } from '@backstage/backend-openapi-utils'; export declare const spec: { readonly openapi: "3.0.3"; readonly info: { readonly title: "search"; readonly version: "1"; readonly description: "The Backstage backend plugin that provides search functionality."; readonly license: { readonly name: "Apache-2.0"; readonly url: "http://www.apache.org/licenses/LICENSE-2.0.html"; }; readonly contact: {}; }; readonly servers: readonly [{ readonly url: "/"; }]; readonly components: { readonly examples: {}; readonly headers: {}; readonly parameters: {}; readonly requestBodies: {}; readonly responses: { readonly ErrorResponse: { readonly description: "An error response from the backend."; readonly content: { readonly 'application/json; charset=utf-8': { readonly schema: { readonly $ref: "#/components/schemas/Error"; }; }; }; }; }; readonly schemas: { readonly Error: { readonly type: "object"; readonly properties: { readonly error: { readonly type: "object"; readonly properties: { readonly name: { readonly type: "string"; }; readonly message: { readonly type: "string"; }; }; readonly required: readonly ["name", "message"]; }; readonly request: { readonly type: "object"; readonly properties: { readonly method: { readonly type: "string"; }; readonly url: { readonly type: "string"; }; }; readonly required: readonly ["method", "url"]; }; readonly response: { readonly type: "object"; readonly properties: { readonly statusCode: { readonly type: "number"; }; }; readonly required: readonly ["statusCode"]; }; }; readonly required: readonly ["error", "request", "response"]; }; readonly JsonObject: { readonly type: "object"; readonly properties: {}; readonly additionalProperties: {}; }; }; readonly securitySchemes: { readonly JWT: { readonly type: "http"; readonly scheme: "bearer"; readonly bearerFormat: "JWT"; }; }; }; readonly paths: { readonly '/query': { readonly get: { readonly operationId: "Query"; readonly description: "Query documents with a given filter."; readonly responses: { readonly '200': { readonly description: "Ok"; readonly content: { readonly 'application/json': { readonly schema: { readonly type: "object"; readonly properties: { readonly results: { readonly type: "array"; readonly items: { readonly type: "object"; readonly properties: { readonly type: { readonly type: "string"; readonly description: "The \"type\" of the given document."; }; readonly document: { readonly type: "object"; readonly description: "The raw value of the document, as indexed."; readonly properties: { readonly title: { readonly type: "string"; readonly description: "The primary name of the document (e.g. name, title, identifier, etc)."; }; readonly text: { readonly type: "string"; readonly description: "Free-form text of the document (e.g. description, content, etc)."; }; readonly location: { readonly type: "string"; readonly description: "The relative or absolute URL of the document (target when a search result is clicked)."; }; }; }; readonly highlight: { readonly type: "object"; readonly description: "Optional result highlight. Useful for improving the search result\ndisplay/experience."; }; readonly rank: { readonly type: "integer"; readonly description: "Optional result rank, where 1 is the first/top result returned. \nUseful for understanding search effectiveness in analytics."; }; }; readonly required: readonly ["type", "document"]; readonly additionalProperties: false; }; }; readonly nextPageCursor: { readonly type: "string"; }; readonly previousPageCursor: { readonly type: "string"; }; readonly numberOfResults: { readonly type: "integer"; }; }; readonly required: readonly ["results"]; }; }; }; }; readonly default: { readonly $ref: "#/components/responses/ErrorResponse"; }; }; readonly security: readonly [{}, { readonly JWT: readonly []; }]; readonly parameters: readonly [{ readonly name: "term"; readonly in: "query"; readonly required: false; readonly schema: { readonly type: "string"; readonly default: ""; }; }, { readonly name: "filters"; readonly in: "query"; readonly required: false; readonly style: "deepObject"; readonly explode: true; readonly schema: { readonly $ref: "#/components/schemas/JsonObject"; }; }, { readonly name: "types"; readonly in: "query"; readonly required: false; readonly schema: { readonly type: "array"; readonly items: { readonly type: "string"; }; }; }, { readonly name: "pageCursor"; readonly in: "query"; readonly required: false; readonly schema: { readonly type: "string"; }; }, { readonly name: "pageLimit"; readonly in: "query"; readonly required: false; readonly schema: { readonly type: "integer"; }; }]; }; }; }; }; export declare const createOpenApiRouter: (options?: Parameters['1']) => Promise>;