Specification describe (#534)

update docs

CHANGELOG.md

@@ -2,14 +2,15 @@
 
 ENHANCEMENTS:
 
+* update Resource and Datasource description.
 * Resource: `tencentcloud_kubernetes_cluster` add new argument `kube_config`.
 * Resource: `tencentcloud_kubernetes_cluster` add value `tlinux2.4x86_64` with argument `cluster_os` to support linux OS system.
 * Resource: `tencentcloud_kubernetes_cluster` add new argument `mount_target` to support set disk mount path.
 * Resource: `tencentcloud_kubernetes_cluster` add new argument `docker_graph_path` to support set docker graph path.
 * Resource: `tencentcloud_clb_redirection` add new argument `delete_all_auto_rewirte` to delete all auto-associated redirection when destroying the resource.
+* Resource: `tencentcloud_kubernetes_scale_worker` add new argument `labels` to support scale worker labels.
 * Data Source: `tencentcloud_kubernetes_clusters` add new argument `kube_config`.
 * Data Source: `tencentcloud_availability_regions` support getting local region info by setting argument `name` with value `default`.
-* Resource: `tencentcloud_kubernetes_scale_worker` add new argument `labels` to support scale worker labels.
 
 BUG FIXES:
 

tencentcloud/data_source_tc_cam_policies.go

@@ -53,13 +53,13 @@ func dataSourceTencentCloudCamPolicies() *schema.Resource {
 				Type:         schema.TypeInt,
 				Optional:     true,
 				ValidateFunc: validateAllowedIntValue([]int{1, 2}),
-				Description:  "Type of the policy strategy. 1 means customer strategy and 2 means preset strategy.",
+				Description:  "Type of the policy strategy. Valid values: 1, 2. 1 means customer strategy and 2 means preset strategy.",
 			},
 			"create_mode": {
 				Type:         schema.TypeInt,
 				Optional:     true,
 				ValidateFunc: validateAllowedIntValue([]int{1, 2}),
-				Description:  "Mode of creation of policy strategy. 1 means policy was created with console, and 2 means it was created by strategies.",
+				Description:  "Mode of creation of policy strategy. Valid values: 1, 2. 1 means policy was created with console, and 2 means it was created by strategies.",
 			},
 			"result_output_file": {
 				Type:        schema.TypeString,

tencentcloud/data_source_tc_cam_role_policy_attachments.go

@@ -54,7 +54,7 @@ func dataSourceTencentCloudCamRolePolicyAttachments() *schema.Resource {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validateAllowedStringValue(CAM_POLICY_CREATE_STRATEGY),
-				Description:  "Type of the policy strategy. Valid values are 'User', 'QCS', '', 'User' means customer strategy and 'QCS' means preset strategy.",
+				Description:  "Type of the policy strategy. Valid values are 'User', 'QCS'. 'User' means customer strategy and 'QCS' means preset strategy.",
 			},
 			"result_output_file": {
 				Type:        schema.TypeString,

tencentcloud/data_source_tc_ccn_bandwidth_limits.go

@@ -49,7 +49,6 @@ func dataSourceTencentCloudCcnBandwidthLimits() *schema.Resource {
 				Optional:    true,
 				Description: "Used to save results.",
 			},
-
 			// Computed values
 			"limits": {
 				Type:        schema.TypeList,

tencentcloud/data_source_tc_cdn_domains.go

@@ -48,13 +48,13 @@ func dataSourceTencentCloudCdnDomains() *schema.Resource {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validateAllowedStringValue(CDN_ORIGIN_PULL_PROTOCOL),
-				Description:  "Origin-pull protocol configuration. The available value include `http`, `https` and `follow`.",
+				Description:  "Origin-pull protocol configuration. Valid values: `http`, `https` and `follow`.",
 			},
 			"https_switch": {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validateAllowedStringValue(CDN_HTTPS_SWITCH),
-				Description:  "HTTPS configuration. The available value include `on`, `off` and `processing`.",
+				Description:  "HTTPS configuration. Valid values: `on`, `off` and `processing`.",
 			},
 			"result_output_file": {
 				Type:        schema.TypeString,

tencentcloud/data_source_tc_dc_gateway_instances.go

@@ -88,17 +88,17 @@ func dataSourceTencentCloudDcGatewayInstances() *schema.Resource {
 						"network_instance_id": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Type of associated network, the available value include 'VPC' and 'CCN'.",
+							Description: "Type of associated network. Valid values: 'VPC' and 'CCN'.",
 						},
 						"gateway_type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Type of the gateway, the available value include 'NORMAL' and 'NAT'. Default is 'NORMAL'.",
+							Description: "Type of the gateway. Valid values: 'NORMAL' and 'NAT'. Default is 'NORMAL'.",
 						},
 						"cnn_route_type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Type of CCN route, the available value include 'BGP' and 'STATIC'.",
+							Description: "Type of CCN route. Valid values: 'BGP' and 'STATIC'.",
 						},
 						"enable_bgp": {
 							Type:        schema.TypeBool,

tencentcloud/data_source_tc_dcx_instances.go

@@ -66,7 +66,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
 						"network_type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Type of the network, and available values include VPC, BMVPC and CCN. The default value is VPC.",
+							Description: "Type of the network. Valid values: VPC, BMVPC and CCN. The default value is VPC.",
 						},
 						"dcg_id": {
 							Type:        schema.TypeString,
@@ -91,7 +91,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
 						"route_type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Type of the route, and available values include BGP and STATIC. The default value is BGP.",
+							Description: "Type of the route. Valid values: BGP and STATIC. The default value is BGP.",
 						},
 						"bgp_asn": {
 							Type:        schema.TypeInt,
@@ -114,7 +114,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
 						"vlan": {
 							Type:        schema.TypeInt,
 							Computed:    true,
-							Description: "Vlan of the dedicated tunnels, and the range of values is [0-3000]. '0' means that only one tunnel can be created for the physical connect.",
+							Description: "Vlan of the dedicated tunnels.  Valid value ranges: [0-3000]. '0' means that only one tunnel can be created for the physical connect.",
 						},
 						"tencent_address": {
 							Type:        schema.TypeString,
@@ -134,7 +134,7 @@ func dataSourceTencentCloudDcxInstances() *schema.Resource {
 						"state": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "State of the dedicated tunnels, and available values include PENDING, ALLOCATING, ALLOCATED, ALTERING, DELETING, DELETED, COMFIRMING and REJECTED.",
+							Description: "State of the dedicated tunnels. Valid values: PENDING, ALLOCATING, ALLOCATED, ALTERING, DELETING, DELETED, COMFIRMING and REJECTED.",
 						},
 						"create_time": {
 							Type:        schema.TypeString,

tencentcloud/data_source_tc_dnats.go

@@ -102,7 +102,7 @@ func dataSourceTencentCloudDnats() *schema.Resource {
 						"protocol": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Type of the network protocol, the available values include: `TCP` and `UDP`.",
+							Description: "Type of the network protocol. Valid values: `TCP` and `UDP`.",
 						},
 						"elastic_ip": {
 							Type:        schema.TypeString,

tencentcloud/data_source_tc_gaap_certificates.go

@@ -45,7 +45,7 @@ func dataSourceTencentCloudGaapCertificates() *schema.Resource {
 				Type:         schema.TypeString,
 				Optional:     true,
 				ValidateFunc: validateAllowedStringValue([]string{"BASIC", "CLIENT", "SERVER", "REALSERVER", "PROXY"}),
-				Description:  "Type of the certificate to be queried, the available values include `BASIC`, `CLIENT`, `SERVER`, `REALSERVER` and `PROXY`; `BASIC` means basic certificate; `CLIENT` means client CA certificate; `SERVER` means server SSL certificate; `REALSERVER` means realserver CA certificate; `PROXY` means proxy SSL certificate.",
+				Description:  "Type of the certificate to be queried. Valid values: `BASIC`, `CLIENT`, `SERVER`, `REALSERVER` and `PROXY`. `BASIC` means basic certificate; `CLIENT` means client CA certificate; `SERVER` means server SSL certificate; `REALSERVER` means realserver CA certificate; `PROXY` means proxy SSL certificate.",
 			},
 			"result_output_file": {
 				Type:        schema.TypeString,

tencentcloud/data_source_tc_gaap_layer4_listeners.go

@@ -61,7 +61,7 @@ func dataSourceTencentCloudGaapLayer4Listeners() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ValidateFunc: validateAllowedStringValue([]string{"TCP", "UDP"}),
-				Description:  "Protocol of the layer4 listener to be queried, the available values include `TCP` and `UDP`.",
+				Description:  "Protocol of the layer4 listener to be queried. Valid values: `TCP` and `UDP`.",
 			},
 			"proxy_id": {
 				Type:        schema.TypeString,

tencentcloud/data_source_tc_gaap_layer7_listeners.go

@@ -46,7 +46,7 @@ func dataSourceTencentCloudGaapLayer7Listeners() *schema.Resource {
 				Type:         schema.TypeString,
 				Required:     true,
 				ValidateFunc: validateAllowedStringValue([]string{"HTTP", "HTTPS"}),
-				Description:  "Protocol of the layer7 listener to be queried, the available values include `HTTP` and `HTTPS`.",
+				Description:  "Protocol of the layer7 listener to be queried. Valid values: `HTTP` and `HTTPS`.",
 			},
 			"proxy_id": {
 				Type:        schema.TypeString,

tencentcloud/data_source_tc_ha_vips.go

@@ -98,7 +98,7 @@ func dataSourceTencentCloudHaVips() *schema.Resource {
 						"state": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "State of the HA VIP, values are `AVAILABLE`, `UNBIND`.",
+							Description: "State of the HA VIP. Valid values: `AVAILABLE`, `UNBIND`.",
 						},
 						"instance_id": {
 							Type:        schema.TypeString,

tencentcloud/data_source_tc_images.go

@@ -39,7 +39,7 @@ func dataSourceTencentCloudImages() *schema.Resource {
 				Type:        schema.TypeList,
 				Optional:    true,
 				Elem:        &schema.Schema{Type: schema.TypeString},
-				Description: "A list of the image type to be queried. Available values include: 'PUBLIC_IMAGE', 'PRIVATE_IMAGE', 'SHARED_IMAGE', 'MARKET_IMAGE'.",
+				Description: "A list of the image type to be queried. Valid values: 'PUBLIC_IMAGE', 'PRIVATE_IMAGE', 'SHARED_IMAGE', 'MARKET_IMAGE'.",
 			},
 			"image_name_regex": {
 				Type:          schema.TypeString,

tencentcloud/data_source_tc_instance_types.go

@@ -60,7 +60,7 @@ func dataSourceInstanceTypes() *schema.Resource {
 						"name": {
 							Type:        schema.TypeString,
 							Required:    true,
-							Description: "The filter name, the available values include `zone` and `instance-family`.",
+							Description: "The filter name. Valid values: `zone` and `instance-family`.",
 						},
 						"values": {
 							Type:        schema.TypeList,

tencentcloud/data_source_tc_nats.go

@@ -61,7 +61,7 @@ func dataSourceTencentCloudNats() *schema.Resource {
 			"state": {
 				Type:        schema.TypeInt,
 				Optional:    true,
-				Description: "NAT gateway status, 0: Running, 1: Unavailable, 2: Be in arrears and out of service.",
+				Description: "NAT gateway status. Valid values: 0, 1, 2. 0: Running, 1: Unavailable, 2: Be in arrears and out of service.",
 			},
 			"max_concurrent": {
 				Type:        schema.TypeInt,

tencentcloud/data_source_tc_sqlserver_zone_config.go

@@ -97,7 +97,7 @@ func dataSourceTencentSqlserverZoneConfig() *schema.Resource {
 									"charge_type": {
 										Type:        schema.TypeString,
 										Computed:    true,
-										Description: "Billing mode under this specification. Valid values are `POSTPAID_BY_HOUR`, `PREPAID` and `ALL` which means both POSTPAID_BY_HOUR and PREPAID.",
+										Description: "Billing mode under this specification. Valid values are `POSTPAID_BY_HOUR`, `PREPAID` and `ALL`. `ALL` means both POSTPAID_BY_HOUR and PREPAID.",
 									},
 								},
 							},

tencentcloud/data_source_tc_tcaplus_clusters.go

@@ -94,7 +94,7 @@ func dataSourceTencentCloudTcaplusClusters() *schema.Resource {
 						"password_status": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Password status of the TcaplusDB cluster. Valid values: `unmodifiable`, which means the password can not be changed in this moment; `modifiable`, which means the password can be changed in this moment.",
+							Description: "Password status of the TcaplusDB cluster. Valid values: `unmodifiable`, `modifiable`. `unmodifiable` means the password can not be changed in this moment; `modifiable` means the password can be changed in this moment.",
 						},
 						"api_access_id": {
 							Type:        schema.TypeString,

tencentcloud/data_source_tc_vod_adaptive_dynamic_streaming_templates.go

@@ -76,7 +76,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
 			"type": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+				Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 			},
 			"sub_app_id": {
 				Type:        schema.TypeInt,
@@ -102,7 +102,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
 						"type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+							Description: "Template type filter. Valid values: `Preset`,`Custom`. `Preset`: preset template; `Custom`: custom template.",
 						},
 						"format": {
 							Type:        schema.TypeString,
@@ -149,7 +149,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
 												"codec": {
 													Type:        schema.TypeString,
 													Computed:    true,
-													Description: "Video stream encoder. Valid values: `libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4.",
+													Description: "Video stream encoder. Valid values: `libx264`, `libx265`, `av1`.`libx264`: H.264, `libx265`: H.265, `av1`: AOMedia Video 1. Currently, a resolution within 640x480 must be specified for `H.265`. and the `av1` container only supports mp4.",
 												},
 												"fps": {
 													Type:        schema.TypeInt,
@@ -164,7 +164,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
 												"resolution_adaptive": {
 													Type:        schema.TypeBool,
 													Computed:    true,
-													Description: "Resolution adaption. Valid values: `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Note: this field may return null, indicating that no valid values can be obtained.",
+													Description: "Resolution adaption. Valid values: `true`,`false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height. Note: this field may return null, indicating that no valid values can be obtained.",
 												},
 												"width": {
 													Type:        schema.TypeInt,
@@ -203,7 +203,7 @@ func dataSourceTencentCloudVodAdaptiveDynamicStreamingTemplates() *schema.Resour
 												"sample_rate": {
 													Type:        schema.TypeInt,
 													Computed:    true,
-													Description: "Audio stream sample rate. Valid values: `32000`, `44100`, `48000`, in Hz.",
+													Description: "Audio stream sample rate. Valid values: `32000`, `44100`, `48000`. Unit is HZ.",
 												},
 												"audio_channel": {
 													Type:        schema.TypeString,

tencentcloud/data_source_tc_vod_image_sprite_templates.go

@@ -47,7 +47,7 @@ func dataSourceTencentCloudVodImageSpriteTemplates() *schema.Resource {
 			"type": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+				Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 			},
 			"sub_app_id": {
 				Type:        schema.TypeInt,
@@ -73,12 +73,12 @@ func dataSourceTencentCloudVodImageSpriteTemplates() *schema.Resource {
 						"type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+							Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 						},
 						"sample_type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Sampling type. Valid values: `Percent`: by percent. `Time`: by time interval.",
+							Description: "Sampling type. Valid values: `Percent`, `Time`. `Percent`: by percent. `Time`: by time interval.",
 						},
 						"sample_interval": {
 							Type:        schema.TypeInt,

tencentcloud/data_source_tc_vod_procedure_templates.go

@@ -53,7 +53,7 @@ func dataSourceTencentCloudVodProcedureTemplates() *schema.Resource {
 			"type": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+				Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 			},
 			"sub_app_id": {
 				Type:        schema.TypeInt,
@@ -74,7 +74,7 @@ func dataSourceTencentCloudVodProcedureTemplates() *schema.Resource {
 						"type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+							Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 						},
 						"name": {
 							Type:        schema.TypeString,
@@ -256,7 +256,7 @@ func dataSourceTencentCloudVodProcedureTemplates() *schema.Resource {
 												"position_type": {
 													Type:        schema.TypeString,
 													Computed:    true,
-													Description: "Screen capturing mode. Valid values: `Time`: screen captures by time point, `Percent`: screen captures by percentage.",
+													Description: "Screen capturing mode. Valid values: `Time`, `Percent`. `Time`: screen captures by time point, `Percent`: screen captures by percentage.",
 												},
 												"position_value": {
 													Type:        schema.TypeFloat,

tencentcloud/data_source_tc_vod_snapshot_by_time_offset_templates.go

@@ -44,7 +44,7 @@ func dataSourceTencentCloudVodSnapshotByTimeOffsetTemplates() *schema.Resource {
 			"type": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+				Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 			},
 			"sub_app_id": {
 				Type:        schema.TypeInt,
@@ -70,7 +70,7 @@ func dataSourceTencentCloudVodSnapshotByTimeOffsetTemplates() *schema.Resource {
 						"type": {
 							Type:        schema.TypeString,
 							Computed:    true,
-							Description: "Template type filter. Valid values: `Preset`: preset template; `Custom`: custom template.",
+							Description: "Template type filter. Valid values: `Preset`, `Custom`. `Preset`: preset template; `Custom`: custom template.",
 						},
 						"name": {
 							Type:        schema.TypeString,
@@ -90,7 +90,7 @@ func dataSourceTencentCloudVodSnapshotByTimeOffsetTemplates() *schema.Resource {
 						"resolution_adaptive": {
 							Type:        schema.TypeBool,
 							Computed:    true,
-							Description: "Resolution adaption. Valid values: `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height.",
+							Description: "Resolution adaption. Valid values: `true`, `false`. `true`: enabled. In this case, `width` represents the long side of a video, while `height` the short side; `false`: disabled. In this case, `width` represents the width of a video, while `height` the height.",
 						},
 						"format": {
 							Type:        schema.TypeString,