diff --git a/plugins/permission-backend/api-report.md b/plugins/permission-backend/api-report.md index 4fb0928b0b..7f82913e18 100644 --- a/plugins/permission-backend/api-report.md +++ b/plugins/permission-backend/api-report.md @@ -8,14 +8,10 @@ import { Logger as Logger_2 } from 'winston'; import { PermissionPolicy } from '@backstage/plugin-permission-node'; import { PluginEndpointDiscovery } 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) +// @public 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) +// @public export interface RouterOptions { // (undocumented) discovery: PluginEndpointDiscovery; diff --git a/plugins/permission-backend/src/service/router.ts b/plugins/permission-backend/src/service/router.ts index 744982e2e3..9110295f77 100644 --- a/plugins/permission-backend/src/service/router.ts +++ b/plugins/permission-backend/src/service/router.ts @@ -35,6 +35,12 @@ import { import { PermissionPolicy } from '@backstage/plugin-permission-node'; import { PermissionIntegrationClient } from './PermissionIntegrationClient'; +/** + * Options required when constructing a new {@link express#Router} using + * {@link createRouter}. + * + * @public + */ export interface RouterOptions { logger: Logger; discovery: PluginEndpointDiscovery; @@ -79,6 +85,12 @@ const handleRequest = async ( return { id, ...response }; }; +/** + * Creates a new {@link express#Router} which provides the backend API + * for the permission system. + * + * @public + */ export async function createRouter( options: RouterOptions, ): Promise {