From f981d5edcfe9213674e9450814ad832828399ccc Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 24 Oct 2023 10:50:08 +0200 Subject: [PATCH] catalog-backend-module-backstage-openapi: move over and tweak config schema Signed-off-by: Patrik Oldsberg --- packages/backend-openapi-utils/package.json | 4 +--- .../config.d.ts | 18 +++++++++++++----- .../package.json | 4 +++- .../InternalOpenApiDocumentationProvider.ts | 2 +- 4 files changed, 18 insertions(+), 10 deletions(-) rename {packages/backend-openapi-utils => plugins/catalog-backend-module-backstage-openapi}/config.d.ts (67%) diff --git a/packages/backend-openapi-utils/package.json b/packages/backend-openapi-utils/package.json index b7be1acf3c..15957dd4ac 100644 --- a/packages/backend-openapi-utils/package.json +++ b/packages/backend-openapi-utils/package.json @@ -34,10 +34,8 @@ "supertest": "^6.1.3" }, "files": [ - "dist", - "config.d.ts" + "dist" ], - "configSchema": "config.d.ts", "dependencies": { "@backstage/backend-plugin-api": "workspace:^", "@backstage/config": "workspace:^", diff --git a/packages/backend-openapi-utils/config.d.ts b/plugins/catalog-backend-module-backstage-openapi/config.d.ts similarity index 67% rename from packages/backend-openapi-utils/config.d.ts rename to plugins/catalog-backend-module-backstage-openapi/config.d.ts index 7256dc55e0..ce51640495 100644 --- a/packages/backend-openapi-utils/config.d.ts +++ b/plugins/catalog-backend-module-backstage-openapi/config.d.ts @@ -13,11 +13,19 @@ * See the License for the specific language governing permissions and * limitations under the License. */ + export interface Config { - openapi?: { - /** - * A list of plugins, whose OpenAPI specs you want to collate in `InternalOpenApiDocumentationProvider`. - */ - plugins: string[]; + catalog?: { + providers?: { + /** + * BackstageOpenApiEntityProvider configuration + */ + backstageOpenapi?: { + /** + * A list of plugins, whose OpenAPI specs you want to collate in `InternalOpenApiDocumentationProvider`. + */ + plugins: string[]; + }; + }; }; } diff --git a/plugins/catalog-backend-module-backstage-openapi/package.json b/plugins/catalog-backend-module-backstage-openapi/package.json index d603e22f8a..05152fc99a 100644 --- a/plugins/catalog-backend-module-backstage-openapi/package.json +++ b/plugins/catalog-backend-module-backstage-openapi/package.json @@ -47,7 +47,9 @@ "openapi3-ts": "^3.1.2", "supertest": "^6.2.4" }, + "configSchema": "config.d.ts", "files": [ - "dist" + "dist", + "config.d.ts" ] } diff --git a/plugins/catalog-backend-module-backstage-openapi/src/InternalOpenApiDocumentationProvider.ts b/plugins/catalog-backend-module-backstage-openapi/src/InternalOpenApiDocumentationProvider.ts index 7700d3081b..33c461d95a 100644 --- a/plugins/catalog-backend-module-backstage-openapi/src/InternalOpenApiDocumentationProvider.ts +++ b/plugins/catalog-backend-module-backstage-openapi/src/InternalOpenApiDocumentationProvider.ts @@ -207,7 +207,7 @@ export class InternalOpenApiDocumentationProvider implements EntityProvider { async refresh(logger: LoggerService) { const pluginsToMerge = this.config.getStringArray( - 'catalog.providers.openapi.plugins', + 'catalog.providers.backstageOpenapi.plugins', ); logger.info(`Loading specs from from ${pluginsToMerge}.`); const documentationEntity: ApiEntity = {