From 3d0d57228966a99c9806361d0b6b5126c74963cd Mon Sep 17 00:00:00 2001 From: Karl Haworth Date: Tue, 5 Mar 2024 15:45:28 -0500 Subject: [PATCH] add required release tag for exporting of type Signed-off-by: Karl Haworth --- plugins/apollo-explorer/api-report.md | 4 +--- .../src/components/ApolloExplorerPage/ApolloExplorerPage.tsx | 5 +++++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/plugins/apollo-explorer/api-report.md b/plugins/apollo-explorer/api-report.md index 978d90d062..b5bed224bc 100644 --- a/plugins/apollo-explorer/api-report.md +++ b/plugins/apollo-explorer/api-report.md @@ -28,9 +28,7 @@ export const apolloExplorerPlugin: BackstagePlugin< {} >; -// Warning: (ae-missing-release-tag) "EndpointProps" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export type EndpointProps = { title: string; graphRef: string; diff --git a/plugins/apollo-explorer/src/components/ApolloExplorerPage/ApolloExplorerPage.tsx b/plugins/apollo-explorer/src/components/ApolloExplorerPage/ApolloExplorerPage.tsx index a3ca428803..c0e4180909 100644 --- a/plugins/apollo-explorer/src/components/ApolloExplorerPage/ApolloExplorerPage.tsx +++ b/plugins/apollo-explorer/src/components/ApolloExplorerPage/ApolloExplorerPage.tsx @@ -23,6 +23,11 @@ import useAsync from 'react-use/lib/useAsync'; import { CircularProgress } from '@material-ui/core'; import { Alert } from '@material-ui/lab'; +/** + * Exports types to be used with {@link @backstage/apollo-explorer#ApolloExplorerPage}. + * + * @public + */ export type EndpointProps = { title: string; graphRef: string;