Skip to content

Commit 167580e

Browse files
committed
fix capitalization of descriptions
Signed-off-by: David Hontecillas <dhontecillas@gmail.com>
1 parent c35dae8 commit 167580e

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

v2.13/messaging/kafka/consumer.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@
66
"type": "object",
77
"properties": {
88
"group_session_timeout": {
9-
"description": "timeout used to detect consumer failures when using Kafka's group management facility. The consumer sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this consumer from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by `group.min.session.timeout.ms` and `group.max.session.timeout.ms`",
9+
"description": "Timeout used to detect consumer failures when using Kafka's group management facility. The consumer sends periodic heartbeats to indicate its liveness to the broker. If no heartbeats are received by the broker before the expiration of this session timeout, then the broker will remove this consumer from the group and initiate a rebalance. Note that the value must be in the allowable range as configured in the broker configuration by `group.min.session.timeout.ms` and `group.max.session.timeout.ms`",
1010
"default": "10s",
1111
"$ref": "../../timeunits.json#/$defs/timeunit",
1212
"type": "string"
1313
},
1414
"group_heartbeat_interval": {
1515
"title": "Grup Heartbeat Interval",
16-
"description": "the expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than Consumer.Group.Session.Timeout, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances",
16+
"description": "Expected time between heartbeats to the consumer coordinator when using Kafka's group management facilities. Heartbeats are used to ensure that the consumer's session stays active and to facilitate rebalancing when new consumers join or leave the group. The value must be set lower than Consumer.Group.Session.Timeout, but typically should be set no higher than 1/3 of that value. It can be adjusted even lower to control the expected time for normal rebalances",
1717
"default": "3s",
1818
"$ref": "../../timeunits.json#/$defs/timeunit",
1919
"type": "string"
2020
},
2121
"group_rebalance_strategies": {
2222
"title": "Group Rebalance Strategies",
23-
"description": "the priority-ordered list of client-side consumer group balancing strategies that will be offered to the coordinator. The first strategy that all group members support will be chosen by the leader. Options are: `range`, `roundrobin`, and `sticky`",
23+
"description": "Priority-ordered list of client-side consumer group balancing strategies that will be offered to the coordinator. The first strategy that all group members support will be chosen by the leader. Options are: `range`, `roundrobin`, and `sticky`",
2424
"default": [ "range" ],
2525
"type": "array",
2626
"items": {
@@ -29,14 +29,14 @@
2929
},
3030
"group_rebalance_timeout": {
3131
"title": "Group Rebalance Timeout",
32-
"description": "the maximum allowed time for each worker to join the group once a rebalance has begun. This is basically a limit on the amount of time needed for all tasks to flush any pending data and commit offsets. If the timeout is exceeded, then the worker will be removed from the group, which will cause offset commit failures.",
32+
"description": "Maximum allowed time for each worker to join the group once a rebalance has begun. This is basically a limit on the amount of time needed for all tasks to flush any pending data and commit offsets. If the timeout is exceeded, then the worker will be removed from the group, which will cause offset commit failures.",
3333
"default": "60s",
3434
"$ref": "../../timeunits.json#/$defs/timeunit",
3535
"type": "string"
3636
},
3737
"group_instance_id": {
3838
"title": "Group Instance ID",
39-
"description": "support KIP-345",
39+
"description": "Support KIP-345",
4040
"type": "string"
4141
},
4242
"fetch_default": {
@@ -46,7 +46,7 @@
4646
},
4747
"isolation_level": {
4848
"title": "Isolation Level",
49-
"description": "supports 2 modes: `read_commited` to consume and return all messages in message channel, and `read_uncommited` to hide messages that are part of an aborted transaction",
49+
"description": "Supports 2 modes: `read_commited` to consume and return all messages in message channel, and `read_uncommited` to hide messages that are part of an aborted transaction",
5050
"type": "string",
5151
"default": "read_commited",
5252
"enum": [ "read_commited", "read_uncommited" ]

v2.13/messaging/kafka/producer.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,32 @@
77
"properties": {
88
"max_message_bytes": {
99
"title": "Max Message Bytes",
10-
"description": "maximum permitted size of a message. Should be set equal to or smaller than the broker's `message.max.bytes`.",
10+
"description": "Maximum permitted size of a message. Should be set equal to or smaller than the broker's `message.max.bytes`.",
1111
"type": "number",
1212
"minimum": 0
1313
},
1414
"required_acks": {
1515
"title": "Required Acks",
16-
"description": "level of acknowledgement reliability needed from the broker. Equivalent to the `request.required.acks` setting of the JVM producer. Can be a positibe number (as a string), or one of hte following values: `no_response` (no required acks), `wait_for_local` (waits for only the local commit to succeed before responding), `wait_for_all` (waits for all in-sync replicas to commit before responding).",
16+
"description": "Level of acknowledgement reliability needed from the broker. Equivalent to the `request.required.acks` setting of the JVM producer. Can be a positibe number (as a string), or one of hte following values: `no_response` (no required acks), `wait_for_local` (waits for only the local commit to succeed before responding), `wait_for_all` (waits for all in-sync replicas to commit before responding).",
1717
"default": "wait_for_local",
1818
"type": "string"
1919
},
2020
"required_acks_timeout": {
2121
"title": "Required Acks Timeout",
22-
"description": "maximum duration the broker will wait the receipt of the number of `required_acks`. This is only relevant when `required_acks` is set to WaitForAll or a number > 1. Only supports millisecond resolution, nanoseconds will be truncated. Equivalent to the JVM producer's `request.timeout.ms` setting.",
22+
"description": "Maximum duration the broker will wait the receipt of the number of `required_acks`. This is only relevant when `required_acks` is set to WaitForAll or a number > 1. Only supports millisecond resolution, nanoseconds will be truncated. Equivalent to the JVM producer's `request.timeout.ms` setting.",
2323
"default": "10s",
2424
"$ref": "../../timeunits.json#/$defs/timeunit",
2525
"type": "string"
2626
},
2727
"compression_codec": {
2828
"title": "Compression Codec",
29-
"description": "type of compression to use on messages (defaults to no compression). Similar to `compression.codec` setting of the JVM producer.",
29+
"description": "Type of compression to use on messages (defaults to no compression). Similar to `compression.codec` setting of the JVM producer.",
3030
"default": "none",
3131
"enum": [ "none", "gzip", "snappy", "lz4", "zstd" ]
3232
},
3333
"compression_level": {
3434
"title": "Compression Level",
35-
"description": "level of compression to use on messages. The meaning depends on the actual compression type used and defaults to default compression level for the codec.",
35+
"description": "Level of compression to use on messages. The meaning depends on the actual compression type used and defaults to default compression level for the codec.",
3636
"type": "string"
3737
},
3838
"partitioner": {
@@ -43,7 +43,7 @@
4343
},
4444
"idempotent": {
4545
"title": "Idempotent",
46-
"description": "if enabled, the producer will ensure that exactly one copy of each message is written",
46+
"description": "If enabled, the producer will ensure that exactly one copy of each message is written",
4747
"default": false,
4848
"type": "boolean"
4949
},

v2.13/messaging/kafka/reader.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,32 +11,32 @@
1111
"properties": {
1212
"connection": {
1313
"title": "Connection details",
14-
"description": "settings to stablish the connection to the kafka services",
14+
"description": "Settings to stablish the connection to the kafka services",
1515
"$ref": "./connection.json",
1616
"type": "object"
1717
},
1818
"consumer": {
1919
"title": "Consumer options",
20-
"description": "details about how to read from the topic",
20+
"description": "Details about how to read from the topic",
2121
"$ref": "./consumer.json",
2222
"type": "object"
2323
},
2424
"topics": {
2525
"title": "Topics",
26-
"description": "the list of topics to read from",
26+
"description": "List of topics to read from",
2727
"type": "array",
2828
"items": {
2929
"type": "string"
3030
}
3131
},
3232
"group_id": {
3333
"title": "Consumer Group ID",
34-
"description": "the name of the consumer group to use",
34+
"description": "Name of the consumer group to use",
3535
"type": "string"
3636
},
3737
"key_meta": {
3838
"title": "Key Meta Name",
39-
"description": "the name of the header where the kafka message key value is written",
39+
"description": "Name of the header where the kafka message key value is written",
4040
"type": "string"
4141
}
4242
},

v2.13/messaging/kafka/sasl.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
"type": "object",
77
"properties": {
88
"mechanism": {
9-
"title": "SASL Mechanism",
10-
"description": "The name of the enabled SASL mechanism",
9+
"title": "SASL Mechanism",
10+
"description": "Name of the enabled SASL mechanism",
1111
"default": "PLAIN",
1212
"type": "string",
1313
"enum": [ "PLAIN", "OAUTHBEARER" ]
@@ -41,7 +41,7 @@
4141
},
4242
"scram_auth_id": {
4343
"title": "SCRAM Auth ID",
44-
"description": "authz id used for SASL/SCRAM authentication",
44+
"description": "Authz id used for SASL/SCRAM authentication",
4545
"type": "string"
4646
}
4747
},

0 commit comments

Comments
 (0)