chore: updating the api-docs as some PR's were merged after the api-docs PR merge that were not rebuilt

Signed-off-by: blam <ben@blam.sh>
This commit is contained in:
blam
2021-06-17 19:19:42 +02:00
parent ae501c04df
commit 90bd5ab9e7
3 changed files with 54 additions and 3 deletions
+21
View File
@@ -6,12 +6,14 @@
import { CatalogApi } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { JSONWebKey } from 'jose';
import { Logger } from 'winston';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { Profile } from 'passport';
import { UserEntity } from '@backstage/catalog-model';
// @public (undocumented)
export type AuthProviderFactory = (options: AuthProviderFactoryOptions) => AuthProviderRouteHandlers;
@@ -47,8 +49,13 @@ export type AuthResponse<ProviderInfo> = {
export type BackstageIdentity = {
id: string;
idToken?: string;
token?: string;
entity?: Entity;
};
// @public (undocumented)
export const createGoogleProvider: (options?: GoogleProviderOptions | undefined) => AuthProviderFactory;
// @public (undocumented)
export function createRouter({ logger, config, discovery, database, providerFactories, }: RouterOptions): Promise<express.Router>;
@@ -63,6 +70,20 @@ export const encodeState: (state: OAuthState) => string;
// @public (undocumented)
export const ensuresXRequestedWith: (req: express.Request) => boolean;
// @public (undocumented)
export const googleDefaultSignInResolver: SignInResolver<OAuthResult>;
// @public (undocumented)
export const googleEmailSignInResolver: SignInResolver<OAuthResult>;
// @public (undocumented)
export type GoogleProviderOptions = {
authHandler?: AuthHandler<OAuthResult>;
signIn?: {
resolver?: SignInResolver<OAuthResult>;
};
};
// @public
export class IdentityClient {
constructor(options: {
+28 -1
View File
@@ -5,8 +5,10 @@
```ts
import { BackstagePlugin } from '@backstage/core';
import { default } from 'react';
import { ExternalRouteRef } from '@backstage/core';
import { RouteRef } from '@backstage/core';
import { TabProps } from '@material-ui/core';
// @public (undocumented)
export const catalogEntityRouteRef: ExternalRouteRef<{
@@ -15,11 +17,22 @@ export const catalogEntityRouteRef: ExternalRouteRef<{
namespace: string;
}, false>;
// @public (undocumented)
export const DomainExplorerContent: ({ title, }: {
title?: string | undefined;
}) => JSX.Element;
// @public
export const ExploreLayout: {
({ title, subtitle, children, }: ExploreLayoutProps): JSX.Element;
Route: (props: SubRoute) => null;
};
// @public (undocumented)
export const ExplorePage: () => JSX.Element;
// @public (undocumented)
export const explorePlugin: BackstagePlugin<{
const explorePlugin: BackstagePlugin<{
explore: RouteRef<undefined>;
}, {
catalogEntity: ExternalRouteRef<{
@@ -29,9 +42,23 @@ export const explorePlugin: BackstagePlugin<{
}, false>;
}>;
export { explorePlugin }
export { explorePlugin as plugin }
// @public (undocumented)
export const exploreRouteRef: RouteRef<undefined>;
// @public (undocumented)
export const GroupsExplorerContent: ({ title, }: {
title?: string | undefined;
}) => JSX.Element;
// @public (undocumented)
export const ToolExplorerContent: ({ title }: {
title?: string | undefined;
}) => JSX.Element;
// (No @packageDocumentation comment for this package)
+5 -2
View File
@@ -43,6 +43,9 @@ export const Reader: ({ entityId, onReady }: Props_2) => JSX.Element;
// @public (undocumented)
export const Router: () => JSX.Element;
// @public (undocumented)
export type SyncResult = 'cached' | 'updated' | 'timeout';
// @public (undocumented)
export interface TechDocsApi {
// (undocumented)
@@ -109,7 +112,7 @@ export interface TechDocsStorageApi {
// (undocumented)
getStorageUrl(): Promise<string>;
// (undocumented)
syncEntityDocs(entityId: EntityName): Promise<boolean>;
syncEntityDocs(entityId: EntityName): Promise<SyncResult>;
}
// @public (undocumented)
@@ -137,7 +140,7 @@ export class TechDocsStorageClient implements TechDocsStorageApi {
getStorageUrl(): Promise<string>;
// (undocumented)
identityApi: IdentityApi;
syncEntityDocs(entityId: EntityName): Promise<boolean>;
syncEntityDocs(entityId: EntityName): Promise<SyncResult>;
}