From 133769ea846331f1ce10b4f59801ce1b3842cbf8 Mon Sep 17 00:00:00 2001 From: Hasan Ozdemir <21654050+nodify-at@users.noreply.github.com> Date: Sat, 11 Dec 2021 01:45:39 +0100 Subject: [PATCH] add links to docs for type BackstageSignInResult Signed-off-by: Hasan Ozdemir <21654050+nodify-at@users.noreply.github.com> --- plugins/auth-backend/api-report.md | 2 -- plugins/auth-backend/src/providers/oidc/provider.ts | 2 +- plugins/auth-backend/src/providers/types.ts | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md index fd8d357a09..9ed523c678 100644 --- a/plugins/auth-backend/api-report.md +++ b/plugins/auth-backend/api-report.md @@ -549,8 +549,6 @@ export type OidcAuthResult = { userinfo: UserinfoResponse; }; -// Warning: (tsdoc-undefined-tag) The TSDoc tag "@BackstageSignInResult" is not defined in this configuration -// // @public export type OidcProviderOptions = { authHandler?: AuthHandler; diff --git a/plugins/auth-backend/src/providers/oidc/provider.ts b/plugins/auth-backend/src/providers/oidc/provider.ts index 98988ae6f7..fe4c042500 100644 --- a/plugins/auth-backend/src/providers/oidc/provider.ts +++ b/plugins/auth-backend/src/providers/oidc/provider.ts @@ -233,7 +233,7 @@ export const oAuth2DefaultSignInResolver: SignInResolver = * can be passed while creating a OIDC provider. * * authHandler : called after sign in was successful, a new object must be returned which includes a profile - * signInResolver: called after sign in was successful, expects to return a new @BackstageSignInResult + * signInResolver: called after sign in was successful, expects to return a new {@link BackstageSignInResult} * * Both options are optional. There is fallback for authHandler where the default handler expect an e-mail explicitly * otherwise it throws an error diff --git a/plugins/auth-backend/src/providers/types.ts b/plugins/auth-backend/src/providers/types.ts index 6e61682f86..ecb466c768 100644 --- a/plugins/auth-backend/src/providers/types.ts +++ b/plugins/auth-backend/src/providers/types.ts @@ -258,7 +258,7 @@ export type SignInInfo = { /** * Sign in resolver type describes the function which handles the result of a successful authentication - * and must return a valid BackStageSignInResult + * and it must return a valid {@link BackstageSignInResult} * @public */ export type SignInResolver = (