From 76d04ae17a58204e4ce96a8f39d55ddb392da11a Mon Sep 17 00:00:00 2001
From: TheByronHimes <TheByronHimes@gmail.com>
Date: Mon, 15 Jul 2024 14:20:18 +0000
Subject: [PATCH] Update config and readme docs

---
 README.md           |  4 +++-
 config_schema.json  | 10 +++++++++-
 example_config.yaml |  1 +
 3 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6458e0d..f494fb1 100644
--- a/README.md
+++ b/README.md
@@ -119,6 +119,8 @@ The service requires the following configuration parameters:
   ```
 
 
+- **`log_traceback`** *(boolean)*: Whether to include exception tracebacks in log messages. Default: `true`.
+
 - **`plaintext_email_template`** *(string)*: The plaintext template to use for email notifications.
 
 - **`html_email_template`** *(string)*: The HTML template to use for email notifications.
@@ -177,7 +179,7 @@ The service requires the following configuration parameters:
 
 - **`kafka_ssl_keyfile`** *(string)*: Optional filename containing the client private key. Default: `""`.
 
-- **`kafka_ssl_password`** *(string)*: Optional password to be used for the client private key. Default: `""`.
+- **`kafka_ssl_password`** *(string, format: password)*: Optional password to be used for the client private key. Default: `""`.
 
 - **`generate_correlation_id`** *(boolean)*: A flag, which, if False, will result in an error when trying to publish an event without a valid correlation ID set for the context. If True, the a newly correlation ID will be generated and used in the event header. Default: `true`.
 
diff --git a/config_schema.json b/config_schema.json
index 66b5356..4aeb4f5 100644
--- a/config_schema.json
+++ b/config_schema.json
@@ -64,6 +64,12 @@
       ],
       "title": "Log Format"
     },
+    "log_traceback": {
+      "default": true,
+      "description": "Whether to include exception tracebacks in log messages.",
+      "title": "Log Traceback",
+      "type": "boolean"
+    },
     "plaintext_email_template": {
       "description": "The plaintext template to use for email notifications",
       "title": "Plaintext Email Template",
@@ -168,8 +174,10 @@
     "kafka_ssl_password": {
       "default": "",
       "description": "Optional password to be used for the client private key.",
+      "format": "password",
       "title": "Kafka Ssl Password",
-      "type": "string"
+      "type": "string",
+      "writeOnly": true
     },
     "generate_correlation_id": {
       "default": true,
diff --git a/example_config.yaml b/example_config.yaml
index 966ab5d..4439988 100644
--- a/example_config.yaml
+++ b/example_config.yaml
@@ -14,6 +14,7 @@ kafka_ssl_keyfile: ''
 kafka_ssl_password: ''
 log_format: null
 log_level: INFO
+log_traceback: true
 login_password: '**********'
 login_user: test@test.com
 notification_event_topic: notifications