From cfbf5d436857173bdb6844f8aa384d2884c6f2c2 Mon Sep 17 00:00:00 2001
From: Chi Bong Ho <cbho@pih.org>
Date: Thu, 10 Oct 2024 15:52:48 -0400
Subject: [PATCH] add documenation of 'wards' config param

---
 packages/esm-ward-app/src/config-schema.ts | 24 ++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/packages/esm-ward-app/src/config-schema.ts b/packages/esm-ward-app/src/config-schema.ts
index f9504bab0..17de2a111 100644
--- a/packages/esm-ward-app/src/config-schema.ts
+++ b/packages/esm-ward-app/src/config-schema.ts
@@ -238,6 +238,30 @@ export const configSchema: ConfigSchema = {
       },
     },
   },
+  wards: {
+    _description: 'Configuration of what type of ward to use at different ward locations.',
+    _type: Type.Array,
+    _default: [{ id: 'default-ward' }],
+    _elements: {
+      id: {
+        _type: Type.String,
+        _description:
+          'The ward type to use. Currently, "default-ward" and "maternal-ward" are supported. This string also serves as the extension slot name for the ward view.',
+      },
+      appliedTo: {
+        _type: Type.Array,
+        _description:
+          'Optional. Conditions under which this card definition should be used. If not provided, the configuration is applied to all wards.',
+        _elements: {
+          location: {
+            _type: Type.UUID,
+            _description: 'The UUID of the location. If not provided, applies to all wards.',
+            _default: null,
+          },
+        },
+      },
+    },
+  },
 };
 
 export interface WardConfigObject {