From 66d852407e16bab4cdf3fff171e9f50171d02acc Mon Sep 17 00:00:00 2001
From: Jente Sondervorst <jentesondervorst@gmail.com>
Date: Sun, 16 Jun 2024 14:08:57 +0200
Subject: [PATCH] Added api-reports

Closes: #25256
Signed-off-by: Jente Sondervorst <jentesondervorst@gmail.com>
---
 plugins/catalog-backend-module-ldap/api-report.md  | 14 ++++++++++----
 .../catalog-backend-module-ldap/src/ldap/config.ts | 10 ++++++++++
 .../catalog-backend-module-ldap/src/ldap/index.ts  |  2 ++
 3 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/plugins/catalog-backend-module-ldap/api-report.md b/plugins/catalog-backend-module-ldap/api-report.md
index 5fcbbc3091..7bc53eb7b2 100644
--- a/plugins/catalog-backend-module-ldap/api-report.md
+++ b/plugins/catalog-backend-module-ldap/api-report.md
@@ -68,6 +68,9 @@ export type GroupConfig = {
   };
 };
 
+// @public
+export type GroupConfigList = GroupConfig | GroupConfig[] | undefined;
+
 // @public
 export type GroupTransformer = (
   vendor: LdapVendor,
@@ -197,8 +200,8 @@ export type LdapProviderConfig = {
   target: string;
   tls?: TLSConfig;
   bind?: BindConfig;
-  users: UserConfig;
-  groups: GroupConfig;
+  users: UserConfigList;
+  groups: GroupConfigList;
   schedule?: TaskScheduleDefinition;
 };
 
@@ -223,8 +226,8 @@ export function readLdapLegacyConfig(config: Config): LdapProviderConfig[];
 // @public
 export function readLdapOrg(
   client: LdapClient,
-  userConfig: UserConfig,
-  groupConfig: GroupConfig,
+  userConfig: UserConfigList,
+  groupConfig: GroupConfigList,
   options: {
     groupTransformer?: GroupTransformer;
     userTransformer?: UserTransformer;
@@ -263,6 +266,9 @@ export type UserConfig = {
   };
 };
 
+// @public
+export type UserConfigList = UserConfig | UserConfig[] | undefined;
+
 // @public
 export type UserTransformer = (
   vendor: LdapVendor,
diff --git a/plugins/catalog-backend-module-ldap/src/ldap/config.ts b/plugins/catalog-backend-module-ldap/src/ldap/config.ts
index 7a5b2828e2..d31de61605 100644
--- a/plugins/catalog-backend-module-ldap/src/ldap/config.ts
+++ b/plugins/catalog-backend-module-ldap/src/ldap/config.ts
@@ -83,6 +83,11 @@ export type BindConfig = {
  */
 export type UserConfigList = UserConfig | UserConfig[] | undefined;
 
+/**
+ * The settings that govern the reading and interpretation of users.
+ *
+ * @public
+ */
 export type UserConfig = {
   // The DN under which users are stored.
   dn: string;
@@ -125,6 +130,11 @@ export type UserConfig = {
  */
 export type GroupConfigList = GroupConfig | GroupConfig[] | undefined;
 
+/**
+ * The settings that govern the reading and interpretation of groups.
+ *
+ * @public
+ */
 export type GroupConfig = {
   // The DN under which groups are stored.
   dn: string;
diff --git a/plugins/catalog-backend-module-ldap/src/ldap/index.ts b/plugins/catalog-backend-module-ldap/src/ldap/index.ts
index cfab5a4444..81cab40b75 100644
--- a/plugins/catalog-backend-module-ldap/src/ldap/index.ts
+++ b/plugins/catalog-backend-module-ldap/src/ldap/index.ts
@@ -20,7 +20,9 @@ export { readProviderConfigs, readLdapLegacyConfig } from './config';
 export type {
   LdapProviderConfig,
   GroupConfig,
+  GroupConfigList,
   UserConfig,
+  UserConfigList,
   BindConfig,
   TLSConfig,
 } from './config';