diff --git a/plugins/example-todo-list-backend/api-report.md b/plugins/example-todo-list-backend/api-report.md new file mode 100644 index 0000000000..fa62ada8e7 --- /dev/null +++ b/plugins/example-todo-list-backend/api-report.md @@ -0,0 +1,22 @@ +## API Report File for "@internal/plugin-todo-list-backend" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import express from 'express'; +import { IdentityClient } from '@backstage/plugin-auth-node'; +import { Logger } from 'winston'; + +// @public +export function createRouter(options: RouterOptions): Promise; + +// @public +export interface RouterOptions { + // (undocumented) + identity: IdentityClient; + // (undocumented) + logger: Logger; +} + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/example-todo-list-backend/src/service/router.ts b/plugins/example-todo-list-backend/src/service/router.ts index d5584eacc6..cdaf1f82b4 100644 --- a/plugins/example-todo-list-backend/src/service/router.ts +++ b/plugins/example-todo-list-backend/src/service/router.ts @@ -25,11 +25,25 @@ import { import { add, getAll, update } from './todos'; import { InputError } from '@backstage/errors'; +/** + * Dependencies of the todo-list router + * + * @public + */ export interface RouterOptions { logger: Logger; identity: IdentityClient; } +/** + * Creates an express.Router with some endpoints + * for creating, editing and deleting todo items. + * + * @public + * @param options - the dependencies of the router + * @returns an express.Router + * + */ export async function createRouter( options: RouterOptions, ): Promise { diff --git a/plugins/example-todo-list-common/api-report.md b/plugins/example-todo-list-common/api-report.md new file mode 100644 index 0000000000..15ffb7b139 --- /dev/null +++ b/plugins/example-todo-list-common/api-report.md @@ -0,0 +1,12 @@ +## API Report File for "@internal/plugin-todo-list-common" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BasicPermission } from '@backstage/plugin-permission-common'; + +// @public +export const tempExamplePermission: BasicPermission; + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/example-todo-list-common/src/permissions.ts b/plugins/example-todo-list-common/src/permissions.ts index a91cafad0e..439bf5e8b9 100644 --- a/plugins/example-todo-list-common/src/permissions.ts +++ b/plugins/example-todo-list-common/src/permissions.ts @@ -16,6 +16,11 @@ import { createPermission } from '@backstage/plugin-permission-common'; +/** + * An example of a permission. + * + * @public + */ export const tempExamplePermission = createPermission({ name: 'temp.example.noop', attributes: {}, diff --git a/plugins/example-todo-list/api-report.md b/plugins/example-todo-list/api-report.md new file mode 100644 index 0000000000..534c33200e --- /dev/null +++ b/plugins/example-todo-list/api-report.md @@ -0,0 +1,23 @@ +## API Report File for "@internal/plugin-todo-list" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +/// + +import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { RouteRef } from '@backstage/core-plugin-api'; + +// @public +export const TodoListPage: () => JSX.Element; + +// @public +export const todoListPlugin: BackstagePlugin< + { + root: RouteRef; + }, + {} +>; + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/example-todo-list/src/plugin.ts b/plugins/example-todo-list/src/plugin.ts index 046c00d98c..0a6cf70476 100644 --- a/plugins/example-todo-list/src/plugin.ts +++ b/plugins/example-todo-list/src/plugin.ts @@ -20,6 +20,11 @@ import { import { rootRouteRef } from './routes'; +/** + * The todo-list plugin instance + * + * @public + */ export const todoListPlugin = createPlugin({ id: 'todolist', routes: { @@ -27,6 +32,11 @@ export const todoListPlugin = createPlugin({ }, }); +/** + * The Router and main entrypoint to the todo-list plugin. + * + * @public + */ export const TodoListPage = todoListPlugin.provide( createRoutableExtension({ name: 'TodoListPage',