docfix: webui_props glossary item

simonredfern · simonredfern · commit 3770c03b82d5 · 2025-11-06T16:36:35.000+01:00
diff --git a/obp-api/src/main/resources/props/sample.props.template b/obp-api/src/main/resources/props/sample.props.template
@@ -1355,10 +1355,10 @@ default_auth_context_update_request_key=CUSTOMER_NUMBER
 
 # User (Developer) Invitation
 webui_post_user_invitation_submit_button_value=Register as a Developer
-webui_privacy_policy=
+webui_privacy_policy=Undefined
 
 #Note: if you provide the Markdown format, please use '\n\' at the end. This will preserve the line breaks.
-webui_terms_and_conditions=
+webui_terms_and_conditions=Undefined
 webui_post_user_invitation_terms_and_conditions_checkbox_value=I agree to the above Developer Terms and Conditions
 
 webui_developer_user_invitation_email_html_text=<!DOCTYPE html>\
diff --git a/obp-api/src/main/scala/code/api/util/ExampleValue.scala b/obp-api/src/main/scala/code/api/util/ExampleValue.scala
@@ -1495,7 +1495,28 @@ object ExampleValue {
   lazy val dateActivatedExample = ConnectorField(NoExampleProvided,NoDescriptionProvided)
   glossaryItems += makeGlossaryItem("date_activated", dateActivatedExample)
 
-  lazy val webuiPropsExample = ConnectorField(NoExampleProvided,NoDescriptionProvided)
+  lazy val webuiPropsExample = ConnectorField(
+    "webui_api_explorer_url",
+    """WebUI Props are properties that configure the Web UI behavior and appearance. Properties with names starting with 'webui_' can be stored in the database and managed via API.
+      |
+      |Data Sources:
+      |1. Explicit WebUiProps (Database): Custom values created/updated via the POST /management/webui_props API endpoint and stored in the database. These take highest precedence.
+      |2. Implicit WebUiProps (Configuration File): Default values defined in the sample.props.template configuration file located at obp-api/src/main/resources/props/sample.props.template.
+      |
+      |To set config file defaults, edit sample.props.template and add or modify properties starting with 'webui_'. Both commented (#webui_) and uncommented (webui_) properties are parsed, with the # automatically stripped.
+      |
+      |When calling GET /management/webui_props:
+      |- Without 'active' parameter or active=false: Returns only explicit props from the database
+      |- With active=true: Returns explicit props + implicit (default) props from configuration file. When both sources have the same property name, the database value takes precedence. Implicit props are marked with webUiPropsId = 'default'.
+      |
+      |Precedence order (highest to lowest):
+      |1. Database WebUI Props (set via POST /management/webui_props)
+      |2. Props files (default.props, etc.) - standard application config
+      |3. sample.props.template - returned as defaults when active=true
+      |4. Environment variables can also override props
+      |
+      |Examples of webui props include: webui_header_logo_left_url, webui_api_explorer_url, webui_api_manager_url, webui_sandbox_introduction, etc.""".stripMargin
+  )
   glossaryItems += makeGlossaryItem("webui_props", webuiPropsExample)
 
   lazy val userCustomerLinksExample = ConnectorField(NoExampleProvided,NoDescriptionProvided)
diff --git a/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala b/obp-api/src/main/scala/code/api/v3_1_0/APIMethods310.scala
@@ -10,6 +10,7 @@ import code.api.util.ApiRole._
 import code.api.util.ApiTag._
 import code.api.util.ErrorMessages.{BankAccountNotFound, _}
 import code.api.util.ExampleValue._
+import code.api.util.Glossary
 import code.api.util.FutureUtil.EndpointContext
 import code.api.util.NewStyle.HttpCode
 import code.api.util._
@@ -5776,6 +5777,8 @@ trait APIMethods310 {
       |Get database props combined with defaults:
       |${getObpApiRoot}/v3.1.0/management/webui_props?active=true
       |
+      |For more details about WebUI Props, including how to set config file defaults and precedence order, see ${Glossary.getGlossaryItemLink("webui_props")}.
+      |
       |""",
       EmptyBody,
       ListResult(
