From 29a4aa8956938d5d13f5912b71f4ebbe0983c986 Mon Sep 17 00:00:00 2001 From: Gabriel Dugny Date: Tue, 24 Dec 2024 12:58:42 +0100 Subject: [PATCH] fix(config): add missing parameters to configuration schema Signed-off-by: Gabriel Dugny --- .changeset/light-wasps-unite.md | 6 ++++ .../config.d.ts | 34 +++++++++++++++++++ plugins/techdocs-backend/config.d.ts | 5 +++ 3 files changed, 45 insertions(+) create mode 100644 .changeset/light-wasps-unite.md diff --git a/.changeset/light-wasps-unite.md b/.changeset/light-wasps-unite.md new file mode 100644 index 0000000000..1075633f04 --- /dev/null +++ b/.changeset/light-wasps-unite.md @@ -0,0 +1,6 @@ +--- +'@backstage/plugin-catalog-backend-module-msgraph': patch +'@backstage/plugin-techdocs-backend': patch +--- + +fix(config): add missing parameters in config schema diff --git a/plugins/catalog-backend-module-msgraph/config.d.ts b/plugins/catalog-backend-module-msgraph/config.d.ts index b93026e1bb..b04c1cd303 100644 --- a/plugins/catalog-backend-module-msgraph/config.d.ts +++ b/plugins/catalog-backend-module-msgraph/config.d.ts @@ -165,6 +165,12 @@ export interface Config { * This can be useful for huge organizations. */ loadPhotos?: boolean; + /** + * The fields to be fetched on query. + * + * E.g. ["id", "displayName", "description"] + */ + select?: string[]; }; group?: { @@ -257,15 +263,38 @@ export interface Config { */ queryMode?: string; user?: { + /** + * The "expand" argument to apply to users. + * + * E.g. "manager". + */ + expand?: string; /** * The filter to apply to extract users. * * E.g. "accountEnabled eq true and userType eq 'member'" */ filter?: string; + /** + * Set to false to not load user photos. + * This can be useful for huge organizations. + */ + loadPhotos?: boolean; + /** + * The fields to be fetched on query. + * + * E.g. ["id", "displayName", "description"] + */ + select?: string[]; }; group?: { + /** + * The "expand" argument to apply to groups. + * + * E.g. "member". + */ + expand?: string; /** * The filter to apply to extract groups. * @@ -284,6 +313,11 @@ export interface Config { * E.g. ["id", "displayName", "description"] */ select?: string[]; + /** + * Whether to ingest groups that are members of the found/filtered/searched groups. + * Default value is `false`. + */ + includeSubGroups?: boolean; }; userGroupMember?: { diff --git a/plugins/techdocs-backend/config.d.ts b/plugins/techdocs-backend/config.d.ts index 4910d8d76e..c220717ddb 100644 --- a/plugins/techdocs-backend/config.d.ts +++ b/plugins/techdocs-backend/config.d.ts @@ -263,6 +263,11 @@ export interface Config { * the credentials belongs to a different project to the bucket. */ projectId?: 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; }; };