diff --git a/.changeset/young-seas-report.md b/.changeset/young-seas-report.md new file mode 100644 index 0000000000..388dada7e7 --- /dev/null +++ b/.changeset/young-seas-report.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-bazaar': patch +'@backstage/plugin-bazaar-backend': patch +--- + +Fixed api warnings diff --git a/plugins/bazaar-backend/api-report.md b/plugins/bazaar-backend/api-report.md index b50994b15d..d62453d156 100644 --- a/plugins/bazaar-backend/api-report.md +++ b/plugins/bazaar-backend/api-report.md @@ -8,13 +8,9 @@ import express from 'express'; import { Logger } from 'winston'; import { PluginDatabaseManager } from '@backstage/backend-common'; -// Warning: (ae-missing-release-tag) "createRouter" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export function createRouter(options: RouterOptions): Promise; -// Warning: (ae-missing-release-tag) "RouterOptions" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export interface RouterOptions { // (undocumented) diff --git a/plugins/bazaar-backend/src/service/router.ts b/plugins/bazaar-backend/src/service/router.ts index 3915c8c609..c61309d279 100644 --- a/plugins/bazaar-backend/src/service/router.ts +++ b/plugins/bazaar-backend/src/service/router.ts @@ -21,12 +21,14 @@ import { Logger } from 'winston'; import { Config } from '@backstage/config'; import { DatabaseHandler } from './DatabaseHandler'; +/** @public */ export interface RouterOptions { logger: Logger; database: PluginDatabaseManager; config: Config; } +/** @public */ export async function createRouter( options: RouterOptions, ): Promise { diff --git a/plugins/bazaar/api-report.md b/plugins/bazaar/api-report.md index e7816757b3..d711df7320 100644 --- a/plugins/bazaar/api-report.md +++ b/plugins/bazaar/api-report.md @@ -8,13 +8,9 @@ import { BackstagePlugin } from '@backstage/core-plugin-api'; import { RouteRef } from '@backstage/core-plugin-api'; -// Warning: (ae-missing-release-tag) "BazaarPage" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const BazaarPage: () => JSX.Element; -// Warning: (ae-missing-release-tag) "bazaarPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const bazaarPlugin: BackstagePlugin< { @@ -23,13 +19,9 @@ export const bazaarPlugin: BackstagePlugin< {} >; -// Warning: (ae-missing-release-tag) "EntityBazaarInfoCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const EntityBazaarInfoCard: () => JSX.Element | null; -// Warning: (ae-missing-release-tag) "SortView" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export const SortView: () => JSX.Element; diff --git a/plugins/bazaar/src/components/EntityBazaarInfoCard/EntityBazaarInfoCard.tsx b/plugins/bazaar/src/components/EntityBazaarInfoCard/EntityBazaarInfoCard.tsx index 5007dbdc89..ba38f3189e 100644 --- a/plugins/bazaar/src/components/EntityBazaarInfoCard/EntityBazaarInfoCard.tsx +++ b/plugins/bazaar/src/components/EntityBazaarInfoCard/EntityBazaarInfoCard.tsx @@ -24,6 +24,7 @@ import { EntityBazaarInfoContent } from '../EntityBazaarInfoContent'; import { Card } from '@material-ui/core'; import { parseBazaarResponse } from '../../util/parseMethods'; +/** @public */ export const EntityBazaarInfoCard = () => { const { entity } = useEntity(); const bazaarApi = useApi(bazaarApiRef); diff --git a/plugins/bazaar/src/components/SortView/SortView.tsx b/plugins/bazaar/src/components/SortView/SortView.tsx index f5bb6facd7..75f5bbeb34 100644 --- a/plugins/bazaar/src/components/SortView/SortView.tsx +++ b/plugins/bazaar/src/components/SortView/SortView.tsx @@ -66,6 +66,7 @@ const getUnlinkedCatalogEntities = ( }); }; +/** @public */ export const SortView = () => { const bazaarApi = useApi(bazaarApiRef); const catalogApi = useApi(catalogApiRef); diff --git a/plugins/bazaar/src/plugin.ts b/plugins/bazaar/src/plugin.ts index 438208624e..e863896489 100644 --- a/plugins/bazaar/src/plugin.ts +++ b/plugins/bazaar/src/plugin.ts @@ -25,6 +25,7 @@ import { } from '@backstage/core-plugin-api'; import { bazaarApiRef, BazaarClient } from './api'; +/** @public */ export const bazaarPlugin = createPlugin({ id: 'bazaar', routes: { @@ -44,6 +45,7 @@ export const bazaarPlugin = createPlugin({ ], }); +/** @public */ export const BazaarPage = bazaarPlugin.provide( createRoutableExtension({ name: 'BazaarPage', diff --git a/scripts/api-extractor.ts b/scripts/api-extractor.ts index a7f36136cc..32b27e06ca 100644 --- a/scripts/api-extractor.ts +++ b/scripts/api-extractor.ts @@ -209,8 +209,6 @@ const ALLOW_WARNINGS = [ 'plugins/azure-devops-common', 'plugins/badges', 'plugins/badges-backend', - 'plugins/bazaar', - 'plugins/bazaar-backend', 'plugins/bitrise', 'plugins/catalog', 'plugins/catalog-graphql',