fix(techdocs-backend): update config.d.ts

Signed-off-by: Thomas Cardonne <thomas.cardonne@adevinta.com>
This commit is contained in:
Thomas Cardonne
2024-07-31 00:01:45 +02:00
parent 5083c8024d
commit a16632cf74
2 changed files with 20 additions and 17 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs-backend': patch
---
Update configuration schema to match actual behavior
+15 -17
View File
@@ -68,22 +68,14 @@ export interface Config {
/**
* Techdocs publisher information
*/
publisher?:
| {
type:
| 'local'
| 'googleGcs'
| 'awsS3'
| 'azureBlobStorage'
| 'openStackSwift';
local?: {
/**
* Directory to store generated static files.
*/
publishDirectory?: string;
};
}
publisher?: {
local?: {
/**
* Directory to store generated static files.
*/
publishDirectory?: string;
};
} & (
| {
type: 'awsS3';
@@ -132,6 +124,11 @@ export interface Config {
* (Required) Cloud Storage Bucket Name
*/
bucketName: string;
/**
* (Optional) Location in storage bucket to save files
* If not set, the default location will be the root of the storage bucket
*/
bucketRootPath?: string;
/**
* (Optional) AWS Region.
* If not set, AWS_REGION environment variable or aws config file will be used.
@@ -261,7 +258,8 @@ export interface Config {
*/
projectId?: string;
};
};
}
);
/**
* @example http://localhost:7007/api/techdocs