Feat/make doc fix (#2425)

* solve the problem that Deprecated of security_group_ids cannot be generated

* make doc adds processing of the same sub object

Author: bruceybian

gendoc/main.go

@@ -214,7 +214,7 @@ func genDoc(product, dtype, fpath, name string, resource *schema.Resource) {
 		}
 		if v.Required {
 			opt := "Required"
-			sub := getSubStruct(0, k, v)
+			sub := getSubStruct(0, "", k, v)
 			subStruct = append(subStruct, sub...)
 			// get type
 			res := parseSubtract(v, sub)
@@ -234,7 +234,7 @@ func genDoc(product, dtype, fpath, name string, resource *schema.Resource) {
 			requiredArgs = append(requiredArgs, fmt.Sprintf("* `%s` - (%s) %s", k, opt, v.Description))
 		} else if v.Optional {
 			opt := "Optional"
-			sub := getSubStruct(0, k, v)
+			sub := getSubStruct(0, "", k, v)
 			subStruct = append(subStruct, sub...)
 			// get type
 			res := parseSubtract(v, sub)
@@ -346,7 +346,7 @@ func getAttributes(step int, k string, v *schema.Schema) []string {
 }
 
 // getSubStruct get sub structure from go file
-func getSubStruct(step int, k string, v *schema.Schema) []string {
+func getSubStruct(step int, parentK, k string, v *schema.Schema) []string {
 	var subStructs []string
 
 	if v.Description == "" {
@@ -358,7 +358,11 @@ func getSubStruct(step int, k string, v *schema.Schema) []string {
 	var subStruct []string
 	if v.Type == schema.TypeMap || v.Type == schema.TypeList || v.Type == schema.TypeSet {
 		if _, ok := v.Elem.(*schema.Resource); ok {
-			subStruct = append(subStruct, fmt.Sprintf("\nThe `%s` object supports the following:\n", k))
+			if step == 0 {
+				subStruct = append(subStruct, fmt.Sprintf("\nThe `%s` object supports the following:\n", k))
+			} else {
+				subStruct = append(subStruct, fmt.Sprintf("\nThe `%s` object of `%s` supports the following:\n", k, parentK))
+			}
 			var (
 				requiredArgs []string
 				optionalArgs []string
@@ -371,6 +375,10 @@ func getSubStruct(step int, k string, v *schema.Schema) []string {
 					if vv.ForceNew {
 						opt += ", ForceNew"
 					}
+					if vv.Deprecated != "" {
+						opt += ", **Deprecated**"
+						vv.Description = fmt.Sprintf("%s %s", vv.Deprecated, vv.Description)
+					}
 					requiredArgs = append(requiredArgs, fmt.Sprintf("* `%s` - (%s) %s", kk, opt, vv.Description))
 				} else if vv.Optional {
 					opt := "Optional"
@@ -379,6 +387,10 @@ func getSubStruct(step int, k string, v *schema.Schema) []string {
 					if vv.ForceNew {
 						opt += ", ForceNew"
 					}
+					if vv.Deprecated != "" {
+						opt += ", **Deprecated**"
+						vv.Description = fmt.Sprintf("%s %s", vv.Deprecated, vv.Description)
+					}
 					optionalArgs = append(optionalArgs, fmt.Sprintf("* `%s` - (%s) %s", kk, opt, vv.Description))
 				}
 			}
@@ -389,7 +401,7 @@ func getSubStruct(step int, k string, v *schema.Schema) []string {
 			subStructs = append(subStructs, strings.Join(subStruct, "\n"))
 
 			for kk, vv := range v.Elem.(*schema.Resource).Schema {
-				subStructs = append(subStructs, getSubStruct(step+1, kk, vv)...)
+				subStructs = append(subStructs, getSubStruct(step+1, k, kk, vv)...)
 			}
 		}
 	}

tencentcloud/resource_tc_kubernetes_node_pool.go

@@ -193,7 +193,7 @@ func composedKubernetesAsScalingConfigPara() map[string]*schema.Schema {
 			Elem:          &schema.Schema{Type: schema.TypeString},
 			ConflictsWith: []string{"auto_scaling_config.0.orderly_security_group_ids"},
 			Deprecated:    "The order of elements in this field cannot be guaranteed. Use `orderly_security_group_ids` instead.",
-			Description:   "(**Deprecated**) The order of elements in this field cannot be guaranteed. Use `orderly_security_group_ids` instead. Security groups to which a CVM instance belongs.",
+			Description:   "Security groups to which a CVM instance belongs.",
 		},
 		"orderly_security_group_ids": {
 			Type:          schema.TypeList,

website/docs/d/mps_media_meta_data.html.markdown

@@ -40,7 +40,7 @@ The following arguments are supported:
 * `input_info` - (Required, List) Input information of file for metadata getting.
 * `result_output_file` - (Optional, String) Used to save results.
 
-The `cos_input_info` object supports the following:
+The `cos_input_info` object of `input_info` supports the following:
 
 * `bucket` - (Required, String) The COS bucket of the object to process, such as `TopRankVideo-125xxx88`.
 * `object` - (Required, String) The path of the object to process, such as `/movie/201907/WildAnimal.mov`.
@@ -53,15 +53,15 @@ The `input_info` object supports the following:
 * `s3_input_info` - (Optional, List) The information of the AWS S3 object processed. This parameter is required if `Type` is `AWS-S3`.Note: This field may return null, indicating that no valid value can be obtained.
 * `url_input_info` - (Optional, List) The URL of the object to process. This parameter is valid and required when `Type` is `URL`.Note: This field may return null, indicating that no valid value can be obtained.
 
-The `s3_input_info` object supports the following:
+The `s3_input_info` object of `input_info` supports the following:
 
 * `s3_bucket` - (Required, String) The AWS S3 bucket.
 * `s3_object` - (Required, String) The path of the AWS S3 object.
 * `s3_region` - (Required, String) The region of the AWS S3 bucket.
 * `s3_secret_id` - (Optional, String) The key ID required to access the AWS S3 object.
 * `s3_secret_key` - (Optional, String) The key required to access the AWS S3 object.
 
-The `url_input_info` object supports the following:
+The `url_input_info` object of `input_info` supports the following:
 
 * `url` - (Required, String) URL of a video.
 

website/docs/r/antiddos_ddos_speed_limit_config.html.markdown

@@ -47,12 +47,12 @@ The `ddos_speed_limit_config` object supports the following:
 * `dst_port_scopes` - (Optional, List) This field has been deprecated. Please fill in the new field DstPortList.
 * `protocol_list` - (Optional, String) IP protocol numbers, values [ALL (all protocols) TCP (tcp protocol) UDP (udp protocol) SMP (smp protocol) 1; 2-100 (custom protocol number range, up to 8)] Note: When customizing the protocol number range, only the protocol number can be filled in, multiple ranges; Separation; When filling in ALL, no other agreements or agreements can be filled inNumber.
 
-The `dst_port_scopes` object supports the following:
+The `dst_port_scopes` object of `ddos_speed_limit_config` supports the following:
 
 * `begin_port` - (Required, Int) Starting port, ranging from 1 to 65535.
 * `end_port` - (Required, Int) end  port, ranging from 1 to 65535.
 
-The `speed_values` object supports the following:
+The `speed_values` object of `ddos_speed_limit_config` supports the following:
 
 * `type` - (Required, Int) Speed limit value type, value [1 (packet rate pps) 2 (bandwidth bps)].
 * `value` - (Required, Int) value.

website/docs/r/api_gateway_upstream.html.markdown

@@ -151,7 +151,7 @@ The following arguments are supported:
 * `upstream_name` - (Optional, String) Backend channel name.
 * `upstream_type` - (Optional, String) Backend access type, value range: IP_PORT, K8S.
 
-The `extra_labels` object supports the following:
+The `extra_labels` object of `k8s_service` supports the following:
 
 * `key` - (Required, String) Key of Label.
 * `value` - (Required, String) Value of Label.

website/docs/r/as_scaling_group.html.markdown

@@ -146,7 +146,7 @@ The `forward_balancer_ids` object supports the following:
 * `target_attribute` - (Required, List) Attribute list of target rules.
 * `rule_id` - (Optional, String) ID of forwarding rules.
 
-The `target_attribute` object supports the following:
+The `target_attribute` object of `forward_balancer_ids` supports the following:
 
 * `port` - (Required, Int) Port number.
 * `weight` - (Required, Int) Weight.

website/docs/r/cdn_domain.html.markdown

@@ -220,22 +220,22 @@ The `cache_key` object supports the following:
 * `key_rules` - (Optional, List) Path-specific cache key configuration.
 * `query_string` - (Optional, List) Request parameter contained in CacheKey.
 
-The `cache_rules` object supports the following:
+The `cache_rules` object of `status_code_cache` supports the following:
 
 * `cache_time` - (Required, Int) Status code cache expiration time (in seconds).
 * `status_code` - (Required, String) Code of status cache. available values: `403`, `404`.
 
-The `capping_rules` object supports the following:
+The `capping_rules` object of `downstream_capping` supports the following:
 
 * `kbps_threshold` - (Required, Int) Capping rule kbps threshold.
 * `rule_paths` - (Required, List) List of capping rule path.
 * `rule_type` - (Required, String) Capping rule type.
 
-The `client_certificate_config` object supports the following:
+The `client_certificate_config` object of `https_config` supports the following:
 
 * `certificate_content` - (Required, String) Client Certificate PEM format, requires Base64 encoding.
 
-The `compression_rules` object supports the following:
+The `compression_rules` object of `compression` supports the following:
 
 * `algorithms` - (Required, List) List of algorithms, available: `gzip` and `brotli`.
 * `compress` - (Required, Bool) Must be set as true, enables compression.
@@ -260,29 +260,29 @@ The `error_page` object supports the following:
 * `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default).
 * `page_rules` - (Optional, List) List of error page rule.
 
-The `filter_rules` object supports the following:
+The `filter_rules` object of `ip_filter` supports the following:
 
 * `filter_type` - (Required, String) Ip filter `blacklist`/`whitelist` type of filter rules.
 * `filters` - (Required, List) Ip filter rule list, supports IPs in X.X.X.X format, or /8, /16, /24 format IP ranges. Up to 50 allowlists or blocklists can be entered.
 * `rule_paths` - (Required, List) Content list for each `rule_type`: `*` for `all`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`.
 * `rule_type` - (Required, String) Ip filter rule type of filter rules, available: `all`, `file`, `directory`, `path`.
 
-The `force_redirect` object supports the following:
+The `force_redirect` object of `https_config` supports the following:
 
 * `carry_headers` - (Optional, String) Whether to return the newly added header during force redirection. Values: `on`, `off`.
 * `redirect_status_code` - (Optional, Int) Forced redirect status code. Valid values are `301` and `302`. When `switch` setting `off`, this property does not need to be set or set to `302`. Default value is `302`.
 * `redirect_type` - (Optional, String) Forced redirect type. Valid values are `http` and `https`. `http` means a forced redirect from HTTPS to HTTP, `https` means a forced redirect from HTTP to HTTPS. When `switch` setting `off`, this property does not need to be set or set to `http`. Default value is `http`.
 * `switch` - (Optional, String) Forced redirect configuration switch. Valid values are `on` and `off`. Default value is `off`.
 
-The `header_rules` object supports the following:
+The `header_rules` object of `request_header` supports the following:
 
 * `header_mode` - (Required, String) Http header setting method. The following types are supported: `add`: add a head, if a head already exists, there will be a duplicate head, `del`: delete the head.
 * `header_name` - (Required, String) Http header name.
 * `header_value` - (Required, String) Http header value, optional when Mode is `del`, Required when Mode is `add`/`set`.
 * `rule_paths` - (Required, List) Matching content under the corresponding type of CacheType: `all`: fill *, `file`: fill in the suffix name, such as jpg, txt, `directory`: fill in the path, such as /xxx/test, `path`: fill in the absolute path, such as /xxx/test.html.
 * `rule_type` - (Required, String) Rule type. The following types are supported: `all`: all documents take effect, `file`: the specified file suffix takes effect, `directory`: the specified path takes effect, `path`: specify the absolute path to take effect.
 
-The `header_rules` object supports the following:
+The `header_rules` object of `response_header` supports the following:
 
 * `header_mode` - (Required, String) Response header mode.
 * `header_name` - (Required, String) response header name of rule.
@@ -322,7 +322,7 @@ The `ip_freq_limit` object supports the following:
 * `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default).
 * `qps` - (Optional, Int) Sets the limited number of requests per second, 514 will be returned for requests that exceed the limit.
 
-The `key_rules` object supports the following:
+The `key_rules` object of `cache_key` supports the following:
 
 * `query_string` - (Required, List) Request parameter contained in CacheKey.
 * `rule_paths` - (Required, List) List of rule paths for each `key_rules`: `/` for `index`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`.
@@ -331,7 +331,7 @@ The `key_rules` object supports the following:
 * `ignore_case` - (Optional, String) Whether caches are case insensitive.
 * `rule_tag` - (Optional, String) Specify rule tag, default value is `user`.
 
-The `max_age_rules` object supports the following:
+The `max_age_rules` object of `max_age` supports the following:
 
 * `max_age_contents` - (Required, List) List of rule paths for each `max_age_type`: `*` for `all`, file ext like `jpg` for `file`, `/dir/like/` for `directory` and `/path/index.html` for `path`.
 * `max_age_time` - (Required, Int) Max Age time in seconds, this can set to `0` that stands for no cache.
@@ -372,7 +372,7 @@ The `oss_private_access` object supports the following:
 * `region` - (Optional, String) Region.
 * `secret_key` - (Optional, String) Key.
 
-The `page_rules` object supports the following:
+The `page_rules` object of `error_page` supports the following:
 
 * `redirect_code` - (Required, Int) Redirect code of error page rules.
 * `redirect_url` - (Required, String) Redirect url of error page rules.
@@ -389,20 +389,20 @@ The `qn_private_access` object supports the following:
 * `access_key` - (Optional, String) Access ID.
 * `secret_key` - (Optional, String) Key.
 
-The `query_string` object supports the following:
+The `query_string` object of `cache_key` supports the following:
 
 * `action` - (Optional, String) Include/exclude query parameters. Values: `includeAll` (Default), `excludeAll`, `includeCustom`, `excludeCustom`.
 * `reorder` - (Optional, String) Whether to sort again, values `on`, `off` (Default).
 * `switch` - (Optional, String) Whether to use QueryString as part of CacheKey, values `on`, `off` (Default).
 * `value` - (Optional, String) Array of included/excluded query strings (separated by `;`).
 
-The `query_string` object supports the following:
+The `query_string` object of `key_rules` supports the following:
 
 * `action` - (Optional, String) Specify key rule QS action, values: `includeCustom`, `excludeCustom`.
 * `switch` - (Optional, String) Whether to use QueryString as part of CacheKey, values `on`, `off` (Default).
 * `value` - (Optional, String) Array of included/excluded query strings (separated by `;`).
 
-The `referer_rules` object supports the following:
+The `referer_rules` object of `referer` supports the following:
 
 * `allow_empty` - (Required, Bool) Whether to allow emptpy.
 * `referer_type` - (Required, String) Referer type.
@@ -440,14 +440,14 @@ The `rule_cache` object supports the following:
 * `rule_type` - (Optional, String) Rule type. The following types are supported: `all`: all documents take effect, `file`: the specified file suffix takes effect, `directory`: the specified path takes effect, `path`: specify the absolute path to take effect, `index`: home page.
 * `switch` - (Optional, String) Cache configuration switch. Valid values are `on` and `off`.
 
-The `server_certificate_config` object supports the following:
+The `server_certificate_config` object of `https_config` supports the following:
 
 * `certificate_content` - (Optional, String) Server certificate information. This is required when uploading an external certificate, which should contain the complete certificate chain.
 * `certificate_id` - (Optional, String) Server certificate ID.
 * `message` - (Optional, String) Certificate remarks.
 * `private_key` - (Optional, String) Server key information. This is required when uploading an external certificate.
 
-The `statistic_item` object supports the following:
+The `statistic_item` object of `band_width_alert` supports the following:
 
 * `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default).
 * `alert_percentage` - (Optional, Int) Alert percentage.
@@ -464,7 +464,7 @@ The `status_code_cache` object supports the following:
 * `switch` - (Required, String) Configuration switch, available values: `on`, `off` (default).
 * `cache_rules` - (Optional, List) List of cache rule.
 
-The `type_a` object supports the following:
+The `type_a` object of `authentication` supports the following:
 
 * `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000.
 * `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files.
@@ -473,15 +473,15 @@ The `type_a` object supports the following:
 * `sign_param` - (Required, String) Signature parameter name. Only upper and lower-case letters, digits, and underscores (_) are allowed. It cannot start with a digit. Length limit: 1-100 characters.
 * `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed.
 
-The `type_b` object supports the following:
+The `type_b` object of `authentication` supports the following:
 
 * `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000.
 * `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files.
 * `filter_type` - (Required, String) Available values: `whitelist` - all types apart from `file_extensions` are authenticated, `blacklist`: - only the types in the `file_extensions` are authenticated.
 * `secret_key` - (Required, String) The key for signature calculation. Only digits, upper and lower-case letters are allowed. Length limit: 6-32 characters.
 * `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed.
 
-The `type_c` object supports the following:
+The `type_c` object of `authentication` supports the following:
 
 * `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000.
 * `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files.
@@ -490,7 +490,7 @@ The `type_c` object supports the following:
 * `backup_secret_key` - (Optional, String) Used for calculate a signature. 6-32 characters. Only digits and letters are allowed.
 * `time_format` - (Optional, String) Timestamp formation, available values: `dec`, `hex`.
 
-The `type_d` object supports the following:
+The `type_d` object of `authentication` supports the following:
 
 * `expire_time` - (Required, Int) Signature expiration time in second. The maximum value is 630720000.
 * `file_extensions` - (Required, List) File extension list settings determining if authentication should be performed. NOTE: If it contains an asterisk (*), this indicates all files.

website/docs/r/cdwpg_instance.html.markdown

@@ -75,7 +75,7 @@ The `charge_properties` object supports the following:
 * `time_unit` - (Required, String) Time Unit,Generally h and mNote: This field may return null, indicating that a valid value cannot be obtained.
 * `charge_type` - (Optional, String) Charge type, vaild values: PREPAID, POSTPAID_BY_HOUR.
 
-The `disk_spec` object supports the following:
+The `disk_spec` object of `resources` supports the following:
 
 * `disk_count` - (Required, Int) disk count.
 * `disk_size` - (Required, Int) disk size.

website/docs/r/cfw_vpc_instance.html.markdown

@@ -78,7 +78,7 @@ The following arguments are supported:
 * `ccn_id` - (Optional, String) Cloud networking id, suitable for cloud networking mode.
 * `fw_vpc_cidr` - (Optional, String) auto Automatically select the firewall network segment; 10.10.10.0/24 The firewall network segment entered by the user.
 
-The `fw_deploy` object supports the following:
+The `fw_deploy` object of `vpc_fw_instances` supports the following:
 
 * `deploy_region` - (Required, String) Firewall Deployment Region.
 * `width` - (Required, Int) Bandwidth, unit: Mbps.