permission-backend: api docs

Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>
This commit is contained in:
Mike Lewis
2021-11-22 15:13:27 +00:00
parent 0ce2bc4129
commit 6de1e719d4
2 changed files with 14 additions and 6 deletions
+2 -6
View File
@@ -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<express.Router>;
// 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;
@@ -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<express.Router> {