diff --git a/docs/frontend-system/utility-apis/02-creating.md b/docs/frontend-system/utility-apis/02-creating.md index e56220841c..49fce0b307 100644 --- a/docs/frontend-system/utility-apis/02-creating.md +++ b/docs/frontend-system/utility-apis/02-creating.md @@ -18,15 +18,19 @@ The first step toward exposing a utility API is to define its TypeScript contrac import { createApiRef } from '@backstage/frontend-plugin-api'; /** - * Performs some work. - * @oublic + * The work interface for the Example plugin. + * @public */ export interface WorkApi { + /** + * Performs some work. + * @public + */ doWork(): Promise; } /** - * The work interface for the Example plugin. + * API Reference for {@link WorkApi}. * @public */ export const workApiRef = createApiRef({