From b77fbf4331338e0142e07c58e7015a3e2db65723 Mon Sep 17 00:00:00 2001 From: Andre Wanlin Date: Wed, 14 Aug 2024 11:40:19 -0500 Subject: [PATCH] Added back `type: 'local'` to TechDocs config schema Signed-off-by: Andre Wanlin --- .changeset/modern-apes-join.md | 5 +++++ plugins/techdocs-backend/config.d.ts | 25 +++++++++++++++---------- 2 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 .changeset/modern-apes-join.md diff --git a/.changeset/modern-apes-join.md b/.changeset/modern-apes-join.md new file mode 100644 index 0000000000..452896b924 --- /dev/null +++ b/.changeset/modern-apes-join.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-techdocs-backend': patch +--- + +Added back `type: 'local'` to TechDocs config schema for `publisher` diff --git a/plugins/techdocs-backend/config.d.ts b/plugins/techdocs-backend/config.d.ts index e22fc549d9..4910d8d76e 100644 --- a/plugins/techdocs-backend/config.d.ts +++ b/plugins/techdocs-backend/config.d.ts @@ -68,14 +68,20 @@ export interface Config { /** * Techdocs publisher information */ - publisher?: { - local?: { - /** - * Directory to store generated static files. - */ - publishDirectory?: string; - }; - } & ( + publisher?: + | { + type: 'local'; + + /** + * Optional when 'type' is set to local + */ + local?: { + /** + * (Optional) Directory to store generated static files. + */ + publishDirectory?: string; + }; + } | { type: 'awsS3'; @@ -258,8 +264,7 @@ export interface Config { */ projectId?: string; }; - } - ); + }; /** * @example http://localhost:7007/api/techdocs