From e0c63b37db172ed75ddf88ec158e2de8f114758d Mon Sep 17 00:00:00 2001
From: Hasan Ozdemir <21654050+nodify-at@users.noreply.github.com>
Date: Thu, 9 Dec 2021 21:37:57 +0100
Subject: [PATCH] add missing documentation for OidcAuthResult

Signed-off-by: Hasan Ozdemir <21654050+nodify-at@users.noreply.github.com>
---
 plugins/auth-backend/api-report.md                  | 4 +---
 plugins/auth-backend/src/providers/oidc/provider.ts | 4 ++++
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/plugins/auth-backend/api-report.md b/plugins/auth-backend/api-report.md
index c076058a0c..fd8d357a09 100644
--- a/plugins/auth-backend/api-report.md
+++ b/plugins/auth-backend/api-report.md
@@ -543,9 +543,7 @@ export type OAuthState = {
   origin?: string;
 };
 
-// Warning: (ae-missing-release-tag) "OidcAuthResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
-//
-// @public (undocumented)
+// @public
 export type OidcAuthResult = {
   tokenset: TokenSet;
   userinfo: UserinfoResponse;
diff --git a/plugins/auth-backend/src/providers/oidc/provider.ts b/plugins/auth-backend/src/providers/oidc/provider.ts
index 347820d2d6..98988ae6f7 100644
--- a/plugins/auth-backend/src/providers/oidc/provider.ts
+++ b/plugins/auth-backend/src/providers/oidc/provider.ts
@@ -56,6 +56,10 @@ type OidcImpl = {
   client: Client;
 };
 
+/**
+ * authentication result for the OIDC which includes the token set and user information (a profile response sent by OIDC server)
+ * @public
+ */
 export type OidcAuthResult = {
   tokenset: TokenSet;
   userinfo: UserinfoResponse;