Skip to content

Commit

Permalink
Update config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lkuchenb committed Jul 31, 2024
1 parent 049e5d0 commit 9cb1671
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
13 changes: 12 additions & 1 deletion config_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
}
},
"additionalProperties": false,
"description": "Modifies the orginal Settings class provided by the user",
"description": "Modifies the original Settings class provided by the user",
"properties": {
"log_level": {
"default": "INFO",
Expand Down Expand Up @@ -190,6 +190,17 @@
"title": "Generate Correlation Id",
"type": "boolean"
},
"kafka_max_message_size": {
"default": 1048576,
"description": "The largest message size that can be transmitted, in bytes. Only services that have a need to send/receive larger messages should set this.",
"examples": [
1048576,
16777216
],
"exclusiveMinimum": 0,
"title": "Kafka Max Message Size",
"type": "integer"
},
"db_connection_str": {
"description": "MongoDB connection string. Might include credentials. For more information see: https://naiveskill.com/mongodb-connection-string/",
"examples": [
Expand Down
1 change: 1 addition & 0 deletions example_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ db_name: metadata-store
docs_url: /docs
generate_correlation_id: true
host: 127.0.0.1
kafka_max_message_size: 1048576
kafka_security_protocol: PLAINTEXT
kafka_servers:
- kafka:9092
Expand Down

0 comments on commit 9cb1671

Please sign in to comment.