From 5a079cd70d6bfdb70d40687089498cfdb95214dc Mon Sep 17 00:00:00 2001 From: Joe Van Alstyne Date: Wed, 3 Apr 2024 16:33:16 +0900 Subject: [PATCH] add new config options to README.md Signed-off-by: Joe Van Alstyne --- .../catalog-backend-module-backstage-openapi/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/plugins/catalog-backend-module-backstage-openapi/README.md b/plugins/catalog-backend-module-backstage-openapi/README.md index a7f4727669..cd1c5f06c6 100644 --- a/plugins/catalog-backend-module-backstage-openapi/README.md +++ b/plugins/catalog-backend-module-backstage-openapi/README.md @@ -2,7 +2,7 @@ ## Summary -This module installs an entity provider that exports a single entity, your Backstage instance documentation, which merges as many backend plugins as you have defined in the config value `catalog.providers.openapi.plugins`. +This module installs an entity provider that exports a single entity, your Backstage instance documentation, which merges as many backend plugins as you have defined in the config value `catalog.providers.backstageOpenapi.plugins`. ## Notes @@ -10,7 +10,7 @@ This module installs an entity provider that exports a single entity, your Backs ## Installation -To your new backend file, add +To your new backend file, add: ```ts title="packages/backend/src/index.ts" backend.add( @@ -18,12 +18,14 @@ backend.add( ); ``` -Add a list of plugins to your config like, +Add a list of plugins (and optionally, a custom name/title) to your config like: ```yaml title="app-config.yaml" catalog: providers: - openapi: + backstageOpenapi: + name: 'internal_backstage_api' # Optional + title: 'Backstage API' # Optional plugins: - catalog - todo