From f770f8070c48a5d6d43e22ce063a14f614eaf896 Mon Sep 17 00:00:00 2001 From: Rickard Dybeck Date: Thu, 25 May 2023 14:09:06 -0400 Subject: [PATCH] generate api-report for module Signed-off-by: Rickard Dybeck --- .../api-report.md | 19 +++++++++++++++++++ .../src/index.ts | 1 - .../src/module.ts | 5 +++++ .../src/plugin.ts | 5 +++++ 4 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 plugins/catalog-backend-module-unprocessed/api-report.md diff --git a/plugins/catalog-backend-module-unprocessed/api-report.md b/plugins/catalog-backend-module-unprocessed/api-report.md new file mode 100644 index 0000000000..3fc81c62cc --- /dev/null +++ b/plugins/catalog-backend-module-unprocessed/api-report.md @@ -0,0 +1,19 @@ +## API Report File for "@backstage/plugin-catalog-backend-module-unprocessed" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BackendFeature } from '@backstage/backend-plugin-api'; +import { HttpRouterService } from '@backstage/backend-plugin-api'; +import { Knex } from 'knex'; + +// @public +export const catalogModuleUnprocessedEntities: () => BackendFeature; + +// @public +export class UnprocessedEntitesModule { + constructor(database: Knex, router: HttpRouterService); + // (undocumented) + registerRoutes(): void; +} +``` diff --git a/plugins/catalog-backend-module-unprocessed/src/index.ts b/plugins/catalog-backend-module-unprocessed/src/index.ts index f5b3dcc472..c826e8593d 100644 --- a/plugins/catalog-backend-module-unprocessed/src/index.ts +++ b/plugins/catalog-backend-module-unprocessed/src/index.ts @@ -22,4 +22,3 @@ export * from './module'; export * from './plugin'; -export * from './types'; diff --git a/plugins/catalog-backend-module-unprocessed/src/module.ts b/plugins/catalog-backend-module-unprocessed/src/module.ts index fcfad9c73a..6ea184ce83 100644 --- a/plugins/catalog-backend-module-unprocessed/src/module.ts +++ b/plugins/catalog-backend-module-unprocessed/src/module.ts @@ -25,6 +25,11 @@ import { HttpRouterService } from '@backstage/backend-plugin-api'; import Router from 'express-promise-router'; import { getBearerTokenFromAuthorizationHeader } from '@backstage/plugin-auth-node'; +/** + * Module providing Unprocessed Entities API endpoints + * + * @public + */ export class UnprocessedEntitesModule { private readonly moduleRouter; diff --git a/plugins/catalog-backend-module-unprocessed/src/plugin.ts b/plugins/catalog-backend-module-unprocessed/src/plugin.ts index bf7f35a4ea..4f02f1efa0 100644 --- a/plugins/catalog-backend-module-unprocessed/src/plugin.ts +++ b/plugins/catalog-backend-module-unprocessed/src/plugin.ts @@ -20,6 +20,11 @@ import { } from '@backstage/backend-plugin-api'; import { UnprocessedEntitesModule } from './module'; +/** + * Catalog Module for Unprocessed Entities + * + * @public + */ export const catalogModuleUnprocessedEntities = createBackendModule({ pluginId: 'catalog', moduleId: 'catalogModuleUnprocessedEntities',