Skip to content

Commit

Permalink
Update config and readme docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheByronHimes committed Jul 15, 2024
1 parent af96a1e commit 76d04ae
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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`.

Expand Down
10 changes: 9 additions & 1 deletion config_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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,
Expand Down
1 change: 1 addition & 0 deletions example_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ kafka_ssl_keyfile: ''
kafka_ssl_password: ''
log_format: null
log_level: INFO
log_traceback: true
login_password: '**********'
login_user: [email protected]
notification_event_topic: notifications
Expand Down

0 comments on commit 76d04ae

Please sign in to comment.