docs(kafkatopic): return dot instead of underscore (#1504)

aiven · Jan 3, 2024 · 8047a3d · 8047a3d
1 parent 8d7badf
commit 8047a3d
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 52 deletions.
diff --git a/docs/resources/kafka_topic.md b/docs/resources/kafka_topic.md
@@ -61,33 +61,33 @@ resource "aiven_kafka_topic" "mytesttopic" {
 
 Optional:
 
-- `cleanup_policy` (String) cleanup_policy value
-- `compression_type` (String) compression_type value
-- `delete_retention_ms` (String) delete_retention_ms value
-- `file_delete_delay_ms` (String) file_delete_delay_ms value
-- `flush_messages` (String) flush_messages value
-- `flush_ms` (String) flush_ms value
-- `index_interval_bytes` (String) index_interval_bytes value
-- `local_retention_bytes` (String) local_retention_bytes value
-- `local_retention_ms` (String) local_retention_ms value
-- `max_compaction_lag_ms` (String) max_compaction_lag_ms value
-- `max_message_bytes` (String) max_message_bytes value
-- `message_downconversion_enable` (Boolean) message_downconversion_enable value
-- `message_format_version` (String) message_format_version value
-- `message_timestamp_difference_max_ms` (String) message_timestamp_difference_max_ms value
-- `message_timestamp_type` (String) message_timestamp_type value
-- `min_cleanable_dirty_ratio` (Number) min_cleanable_dirty_ratio value
-- `min_compaction_lag_ms` (String) min_compaction_lag_ms value
-- `min_insync_replicas` (String) min_insync_replicas value
+- `cleanup_policy` (String) cleanup.policy value
+- `compression_type` (String) compression.type value
+- `delete_retention_ms` (String) delete.retention.ms value
+- `file_delete_delay_ms` (String) file.delete.delay.ms value
+- `flush_messages` (String) flush.messages value
+- `flush_ms` (String) flush.ms value
+- `index_interval_bytes` (String) index.interval.bytes value
+- `local_retention_bytes` (String) local.retention.bytes value
+- `local_retention_ms` (String) local.retention.ms value
+- `max_compaction_lag_ms` (String) max.compaction.lag.ms value
+- `max_message_bytes` (String) max.message.bytes value
+- `message_downconversion_enable` (Boolean) message.downconversion.enable value
+- `message_format_version` (String) message.format.version value
+- `message_timestamp_difference_max_ms` (String) message.timestamp.difference.max.ms value
+- `message_timestamp_type` (String) message.timestamp.type value
+- `min_cleanable_dirty_ratio` (Number) min.cleanable.dirty.ratio value
+- `min_compaction_lag_ms` (String) min.compaction.lag.ms value
+- `min_insync_replicas` (String) min.insync.replicas value
 - `preallocate` (Boolean) preallocate value
-- `remote_storage_enable` (Boolean) remote_storage_enable value
-- `retention_bytes` (String) retention_bytes value
-- `retention_ms` (String) retention_ms value
-- `segment_bytes` (String) segment_bytes value
-- `segment_index_bytes` (String) segment_index_bytes value
-- `segment_jitter_ms` (String) segment_jitter_ms value
-- `segment_ms` (String) segment_ms value
-- `unclean_leader_election_enable` (Boolean, Deprecated) unclean_leader_election_enable value; This field is deprecated and no longer functional.
+- `remote_storage_enable` (Boolean) remote.storage.enable value
+- `retention_bytes` (String) retention.bytes value
+- `retention_ms` (String) retention.ms value
+- `segment_bytes` (String) segment.bytes value
+- `segment_index_bytes` (String) segment.index.bytes value
+- `segment_jitter_ms` (String) segment.jitter.ms value
+- `segment_ms` (String) segment.ms value
+- `unclean_leader_election_enable` (Boolean, Deprecated) unclean.leader.election.enable value; This field is deprecated and no longer functional.
 
 
 <a id="nestedblock--tag"></a>

diff --git a/internal/sdkprovider/service/kafkatopic/kafka_topic.go b/internal/sdkprovider/service/kafkatopic/kafka_topic.go
@@ -73,97 +73,97 @@ var aivenKafkaTopicSchema = map[string]*schema.Schema{
 			Schema: map[string]*schema.Schema{
 				"cleanup_policy": {
 					Type:             schema.TypeString,
-					Description:      "cleanup_policy value",
+					Description:      "cleanup.policy value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"compression_type": {
 					Type:             schema.TypeString,
-					Description:      "compression_type value",
+					Description:      "compression.type value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"delete_retention_ms": {
 					Type:             schema.TypeString,
-					Description:      "delete_retention_ms value",
+					Description:      "delete.retention.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"file_delete_delay_ms": {
 					Type:             schema.TypeString,
-					Description:      "file_delete_delay_ms value",
+					Description:      "file.delete.delay.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"flush_messages": {
 					Type:             schema.TypeString,
-					Description:      "flush_messages value",
+					Description:      "flush.messages value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"flush_ms": {
 					Type:             schema.TypeString,
-					Description:      "flush_ms value",
+					Description:      "flush.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"index_interval_bytes": {
 					Type:             schema.TypeString,
-					Description:      "index_interval_bytes value",
+					Description:      "index.interval.bytes value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"max_compaction_lag_ms": {
 					Type:             schema.TypeString,
-					Description:      "max_compaction_lag_ms value",
+					Description:      "max.compaction.lag.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"max_message_bytes": {
 					Type:             schema.TypeString,
-					Description:      "max_message_bytes value",
+					Description:      "max.message.bytes value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"message_downconversion_enable": {
 					Type:             schema.TypeBool,
-					Description:      "message_downconversion_enable value",
+					Description:      "message.downconversion.enable value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"message_format_version": {
 					Type:             schema.TypeString,
-					Description:      "message_format_version value",
+					Description:      "message.format.version value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"message_timestamp_difference_max_ms": {
 					Type:             schema.TypeString,
-					Description:      "message_timestamp_difference_max_ms value",
+					Description:      "message.timestamp.difference.max.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"message_timestamp_type": {
 					Type:             schema.TypeString,
-					Description:      "message_timestamp_type value",
+					Description:      "message.timestamp.type value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"min_cleanable_dirty_ratio": {
 					Type:             schema.TypeFloat,
-					Description:      "min_cleanable_dirty_ratio value",
+					Description:      "min.cleanable.dirty.ratio value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"min_compaction_lag_ms": {
 					Type:             schema.TypeString,
-					Description:      "min_compaction_lag_ms value",
+					Description:      "min.compaction.lag.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"min_insync_replicas": {
 					Type:             schema.TypeString,
-					Description:      "min_insync_replicas value",
+					Description:      "min.insync.replicas value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
@@ -175,62 +175,62 @@ var aivenKafkaTopicSchema = map[string]*schema.Schema{
 				},
 				"retention_bytes": {
 					Type:             schema.TypeString,
-					Description:      "retention_bytes value",
+					Description:      "retention.bytes value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"retention_ms": {
 					Type:             schema.TypeString,
-					Description:      "retention_ms value",
+					Description:      "retention.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"segment_bytes": {
 					Type:             schema.TypeString,
-					Description:      "segment_bytes value",
+					Description:      "segment.bytes value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"segment_index_bytes": {
 					Type:             schema.TypeString,
-					Description:      "segment_index_bytes value",
+					Description:      "segment.index.bytes value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"segment_jitter_ms": {
 					Type:             schema.TypeString,
-					Description:      "segment_jitter_ms value",
+					Description:      "segment.jitter.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"segment_ms": {
 					Type:             schema.TypeString,
-					Description:      "segment_ms value",
+					Description:      "segment.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"unclean_leader_election_enable": {
 					Type:             schema.TypeBool,
-					Description:      "unclean_leader_election_enable value; This field is deprecated and no longer functional.",
+					Description:      "unclean.leader.election.enable value; This field is deprecated and no longer functional.",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 					Deprecated:       "This field is deprecated and no longer functional.",
 				},
 				"remote_storage_enable": {
 					Type:             schema.TypeBool,
-					Description:      "remote_storage_enable value",
+					Description:      "remote.storage.enable value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"local_retention_bytes": {
 					Type:             schema.TypeString,
-					Description:      "local_retention_bytes value",
+					Description:      "local.retention.bytes value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},
 				"local_retention_ms": {
 					Type:             schema.TypeString,
-					Description:      "local_retention_ms value",
+					Description:      "local.retention.ms value",
 					Optional:         true,
 					DiffSuppressFunc: schemautil.EmptyObjectDiffSuppressFunc,
 				},