From bd924fece8b82161dc2e84b079dced5223aa81de Mon Sep 17 00:00:00 2001 From: Dominik Henneke Date: Tue, 12 Oct 2021 11:09:51 +0200 Subject: [PATCH] Add additional docs Signed-off-by: Dominik Henneke --- plugins/catalog-react/api-report.md | 6 +----- .../src/apis/StarredEntitiesApi/StarredEntitiesApi.ts | 8 ++++++++ 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 8670830584..1a37f84df3 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -761,17 +761,13 @@ export interface StarredEntitiesApi { toggleStarred(entityRef: string): Promise; } -// Warning: (ae-missing-release-tag) "StarredEntitiesApiObservable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) export type StarredEntitiesApiObservable = { starredEntities: Set; isStarred: (entityRef: string) => boolean; }; -// Warning: (ae-missing-release-tag) "starredEntitiesApiRef" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) +// @public export const starredEntitiesApiRef: ApiRef; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts diff --git a/plugins/catalog-react/src/apis/StarredEntitiesApi/StarredEntitiesApi.ts b/plugins/catalog-react/src/apis/StarredEntitiesApi/StarredEntitiesApi.ts index 68eae0b0a1..93ff55aa54 100644 --- a/plugins/catalog-react/src/apis/StarredEntitiesApi/StarredEntitiesApi.ts +++ b/plugins/catalog-react/src/apis/StarredEntitiesApi/StarredEntitiesApi.ts @@ -16,10 +16,18 @@ import { ApiRef, createApiRef, Observable } from '@backstage/core-plugin-api'; +/** + * An API to store starred entities + * + * @public + */ export const starredEntitiesApiRef: ApiRef = createApiRef({ id: 'catalog-react.starred-entities', }); +/** + * @public + */ export type StarredEntitiesApiObservable = { /** * A set of entity references that are starred