Update type definition and docs to be clear about experimental status

This commit is contained in:
Jonah Back
2021-01-18 14:12:12 -08:00
parent dfce32b356
commit 147648a2d1
+7 -2
View File
@@ -112,7 +112,12 @@ export interface AuthProviderRouteHandlers {
logout?(req: express.Request, res: express.Response): Promise<void>;
}
export type IdentityResolver = (
/**
* EXPERIMENTAL - this will almost certainly break in a future release.
*
* Used to resolve an identity from auth information in some auth providers.
*/
export type ExperimentalIdentityResolver = (
/**
* An object containing information specific to the auth provider.
*/
@@ -128,7 +133,7 @@ export type AuthProviderFactoryOptions = {
tokenIssuer: TokenIssuer;
discovery: PluginEndpointDiscovery;
catalogApi: CatalogApi;
identityResolver?: IdentityResolver;
identityResolver?: ExperimentalIdentityResolver;
};
export type AuthProviderFactory = (