Update api reports

Signed-off-by: Nataliya Issayeva <nissayeva@users.noreply.github.com>
This commit is contained in:
Nataliya Issayeva
2021-11-12 16:25:12 -05:00
parent f04f38dbcd
commit 640ba82ca6
3 changed files with 37 additions and 0 deletions
+28
View File
@@ -526,6 +526,22 @@ export type SearchResponseFile = {
content(): Promise<Buffer>;
};
// Warning: (ae-missing-release-tag) "ServerTokenManager" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class ServerTokenManager implements TokenManager {
// (undocumented)
static fromConfig(config: Config): ServerTokenManager;
// (undocumented)
getServerToken(): Promise<{
token: string;
}>;
// (undocumented)
static noop(): ServerTokenManager;
// (undocumented)
validateServerToken(token: string): Promise<boolean>;
}
// @public (undocumented)
export type ServiceBuilder = {
loadConfig(config: Config): ServiceBuilder;
@@ -583,6 +599,18 @@ export interface StatusCheckHandlerOptions {
statusCheck?: StatusCheck;
}
// Warning: (ae-missing-release-tag) "TokenManager" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface TokenManager {
// (undocumented)
getServerToken: () => Promise<{
token: string;
}>;
// (undocumented)
validateServerToken: (token: string) => Promise<boolean>;
}
// @public
export type UrlReader = {
read(url: string): Promise<Buffer>;
+6
View File
@@ -31,6 +31,7 @@ import { ResourceEntityV1alpha1 } from '@backstage/catalog-model';
import { Router } from 'express';
import { ScmIntegrationRegistry } from '@backstage/integration';
import { ScmIntegrations } from '@backstage/integration';
import { TokenManager } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';
import { Validators } from '@backstage/catalog-model';
@@ -736,8 +737,10 @@ export class DefaultCatalogCollator implements DocumentCollator {
locationTemplate,
filter,
catalogClient,
tokenManager,
}: {
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
locationTemplate?: string;
filter?: CatalogEntitiesRequest['filter'];
catalogClient?: CatalogApi;
@@ -760,12 +763,15 @@ export class DefaultCatalogCollator implements DocumentCollator {
_config: Config,
options: {
discovery: PluginEndpointDiscovery;
tokenManager: TokenManager;
filter?: CatalogEntitiesRequest['filter'];
},
): DefaultCatalogCollator;
// (undocumented)
protected locationTemplate: string;
// (undocumented)
protected tokenManager: TokenManager;
// (undocumented)
readonly type: string;
}
+3
View File
@@ -14,6 +14,7 @@ import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { PreparerBuilder } from '@backstage/techdocs-common';
import { PublisherBase } from '@backstage/techdocs-common';
import { TechDocsDocument } from '@backstage/techdocs-common';
import { TokenManager } from '@backstage/backend-common';
// Warning: (ae-forgotten-export) The symbol "RouterOptions" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -31,6 +32,7 @@ export class DefaultTechDocsCollator implements DocumentCollator {
locationTemplate,
logger,
catalogClient,
tokenManager,
parallelismLimit,
legacyPathCasing,
}: TechDocsCollatorOptions);
@@ -60,6 +62,7 @@ export class DefaultTechDocsCollator implements DocumentCollator {
export type TechDocsCollatorOptions = {
discovery: PluginEndpointDiscovery;
logger: Logger_2;
tokenManager: TokenManager;
locationTemplate?: string;
catalogClient?: CatalogApi;
parallelismLimit?: number;