From b8515ae3b6e4bba87d8ee2cac399d53a2d764bab Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Fri, 11 Aug 2023 16:22:37 +0200 Subject: [PATCH] auth-node: fix OAuthState doc Signed-off-by: Patrik Oldsberg --- plugins/auth-node/api-report.md | 2 +- plugins/auth-node/src/oauth/state.ts | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/plugins/auth-node/api-report.md b/plugins/auth-node/api-report.md index 4a384834d6..a7fc9b1612 100644 --- a/plugins/auth-node/api-report.md +++ b/plugins/auth-node/api-report.md @@ -388,7 +388,7 @@ export interface OAuthSession { tokenType: string; } -// @public (undocumented) +// @public export type OAuthState = { nonce: string; env: string; diff --git a/plugins/auth-node/src/oauth/state.ts b/plugins/auth-node/src/oauth/state.ts index c5b96414fa..fc747d08a5 100644 --- a/plugins/auth-node/src/oauth/state.ts +++ b/plugins/auth-node/src/oauth/state.ts @@ -18,10 +18,11 @@ import pickBy from 'lodash/pickBy'; import { Request } from 'express'; import { NotAllowedError } from '@backstage/errors'; -/** @public */ +/** + * A type for the serialized value in the `state` parameter of the OAuth authorization flow + * @public + */ export type OAuthState = { - /* A type for the serialized value in the `state` parameter of the OAuth authorization flow - */ nonce: string; env: string; origin?: string;