search-backend-module-elasticsearch: update API reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-08-09 11:49:44 +02:00
parent 783d4c1939
commit b0ca08a269
2 changed files with 6 additions and 14 deletions
@@ -4,19 +4,9 @@
```ts
import { BackendFeature } from '@backstage/backend-plugin-api';
import { ElasticSearchCustomIndexTemplate } from '@backstage/plugin-search-backend-module-elasticsearch';
import { ElasticSearchQueryTranslator } from '@backstage/plugin-search-backend-module-elasticsearch';
// @alpha
export const searchModuleElasticsearchEngine: (
options?: SearchModuleElasticsearchEngineOptions | undefined,
) => BackendFeature;
// @alpha
export type SearchModuleElasticsearchEngineOptions = {
translator?: ElasticSearchQueryTranslator;
indexTemplate?: ElasticSearchCustomIndexTemplate;
};
export const searchModuleElasticsearchEngine: () => BackendFeature;
// (No @packageDocumentation comment for this package)
```
@@ -15,6 +15,7 @@ import type { ConnectionOptions } from 'tls';
import { IndexableDocument } from '@backstage/plugin-search-common';
import { IndexableResultSet } from '@backstage/plugin-search-common';
import { Logger } from 'winston';
import { LoggerService } from '@backstage/backend-plugin-api';
import { Readable } from 'stream';
import { SearchEngine } from '@backstage/plugin-search-common';
import { SearchQuery } from '@backstage/plugin-search-common';
@@ -299,10 +300,11 @@ export interface ElasticSearchNodeOptions {
// @public
export type ElasticSearchOptions = {
logger: Logger;
logger: Logger | LoggerService;
config: Config;
aliasPostfix?: string;
indexPrefix?: string;
translator?: ElasticSearchQueryTranslator;
};
// @public
@@ -322,7 +324,7 @@ export class ElasticSearchSearchEngine implements SearchEngine {
elasticSearchClientOptions: ElasticSearchClientOptions,
aliasPostfix: string,
indexPrefix: string,
logger: Logger,
logger: Logger | LoggerService,
batchSize: number,
highlightOptions?: ElasticSearchHighlightOptions,
);
@@ -365,7 +367,7 @@ export type ElasticSearchSearchEngineIndexerOptions = {
indexPrefix: string;
indexSeparator: string;
alias: string;
logger: Logger;
logger: Logger | LoggerService;
elasticSearchClientWrapper: ElasticSearchClientWrapper;
batchSize: number;
};