Merge pull request #568 from ttomzhou/doc

gailwang · web-flow · commit 0ec27c8b4d5f · 2020-12-10T16:14:52.000+08:00
optimize document
diff --git a/tencentcloud/resource_tc_api_gateway_api.go b/tencentcloud/resource_tc_api_gateway_api.go
@@ -116,7 +116,7 @@ func resourceTencentCloudAPIGatewayAPI() *schema.Resource {
 				Optional:     true,
 				Default:      "GET",
 				ValidateFunc: validateAllowedStringValue([]string{"GET", "POST", "PUT", "DELETE", "HEAD", "ANY"}),
-				Description:  "Request frontend method configuration. Like `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.",
+				Description:  "Request frontend method configuration. Valid values: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.",
 			},
 			"request_parameters": {
 				Type:        schema.TypeSet,
@@ -169,7 +169,7 @@ func resourceTencentCloudAPIGatewayAPI() *schema.Resource {
 				Type:        schema.TypeInt,
 				Optional:    true,
 				Default:     5,
-				Description: "API backend service timeout period in seconds. Default is `5`.",
+				Description: "API backend service timeout period in seconds. Default value: `5`.",
 			},
 			"service_config_product": {
 				Type:        schema.TypeString,
@@ -204,7 +204,7 @@ func resourceTencentCloudAPIGatewayAPI() *schema.Resource {
 			"service_config_scf_function_namespace": {
 				Type:        schema.TypeString,
 				Optional:    true,
-				Description: "SCF function namespace. This parameter takes effect when  `service_config_type` is `SCF`.",
+				Description: "SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`.",
 			},
 			"service_config_scf_function_qualifier": {
 				Type:        schema.TypeString,
diff --git a/tencentcloud/resource_tc_api_gateway_custom_domain.go b/tencentcloud/resource_tc_api_gateway_custom_domain.go
@@ -62,7 +62,7 @@ func resourceTencentCloudAPIGatewayCustomDomain() *schema.Resource {
 				Type:        schema.TypeBool,
 				Default:     true,
 				Optional:    true,
-				Description: "Whether the default path mapping is used. The default value is true. If the value is false, the custom path mapping will be used and PathMappingSet will be required in this case.",
+				Description: "Whether the default path mapping is used. The default value is `true`. When it is `false`, it means custom path mapping. In this case, the `path_mappings` attribute is required.",
 			},
 			"default_domain": {
 				Type:         schema.TypeString,
@@ -74,20 +74,20 @@ func resourceTencentCloudAPIGatewayCustomDomain() *schema.Resource {
 				Type:        schema.TypeString,
 				Optional:    true,
 				Computed:    true,
-				Description: "Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if Protocol is `https` or `http&https`.",
+				Description: "Unique certificate ID of the custom domain name to be bound. You can choose to upload for the `protocol` attribute value `https` or `http&https`.",
 			},
 			"path_mappings": {
 				Type:        schema.TypeSet,
 				Optional:    true,
 				Computed:    true,
 				Elem:        &schema.Schema{Type: schema.TypeString},
-				Description: "Custom domain name path mapping. Valid values: `test`, `prepub`, `release`. Respectively.eg: path#environment.",
+				Description: "Custom domain name path mapping. The data format is: `path#environment`. Optional values for the environment are `test`, `prepub`, and `release`.",
 			},
 			//compute
 			"status": {
 				Type:        schema.TypeInt,
 				Computed:    true,
-				Description: "Domain name resolution status. True: success; False: failure.",
+				Description: "Domain name resolution status. `1` means normal analysis, `0` means parsing failed.",
 			},
 		},
 	}
diff --git a/tencentcloud/resource_tc_api_gateway_service.go b/tencentcloud/resource_tc_api_gateway_service.go
@@ -87,7 +87,7 @@ func resourceTencentCloudAPIGatewayService() *schema.Resource {
 				ForceNew:     true,
 				Default:      "IPv4",
 				ValidateFunc: validateAllowedStringValue(API_GATEWAY_NET_IP_VERSIONS),
-				Description:  "IP version number. Valid values: `IPv4`, `IPv6`. Default value is `IPv4`.",
+				Description:  "IP version number. Valid values: `IPv4`, `IPv6`. Default value: `IPv4`.",
 			},
 			"release_limit": {
 				Type:        schema.TypeInt,
diff --git a/tencentcloud/resource_tc_api_gateway_usage_plan_attachment.go b/tencentcloud/resource_tc_api_gateway_usage_plan_attachment.go
@@ -109,7 +109,7 @@ func resourceTencentCloudAPIGatewayUsagePlanAttachment() *schema.Resource {
 				Required:     true,
 				ForceNew:     true,
 				ValidateFunc: validateAllowedStringValue(API_GATEWAY_SERVICE_ENVS),
-				Description:  "Environment to be bound `test`,`prepub` or `release`.",
+				Description:  "The environment to be bound. Valid values: `test`, `prepub`, `release`.",
 			},
 			"bind_type": {
 				Type:         schema.TypeString,
diff --git a/website/docs/r/api_gateway_api.html.markdown b/website/docs/r/api_gateway_api.html.markdown
@@ -71,7 +71,7 @@ The following arguments are supported:
 * `pre_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
 * `protocol` - (Optional, ForceNew) API frontend request type. Valid values: `HTTP`, `WEBSOCKET`. Default value: `HTTP`.
 * `release_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
-* `request_config_method` - (Optional) Request frontend method configuration. Like `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.
+* `request_config_method` - (Optional) Request frontend method configuration. Valid values: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.
 * `request_parameters` - (Optional) Frontend request parameters.
 * `response_error_codes` - (Optional) Custom error code configuration. Must keep at least one after set.
 * `response_fail_example` - (Optional) Response failure sample of custom response configuration.
@@ -82,9 +82,9 @@ The following arguments are supported:
 * `service_config_path` - (Optional) API backend service path, such as /path. If `service_config_type` is `HTTP`, this parameter will be required. The frontend `request_config_path` and backend path `service_config_path` can be different.
 * `service_config_product` - (Optional) Backend type. This parameter takes effect when VPC is enabled. Currently, only `clb` is supported.
 * `service_config_scf_function_name` - (Optional) SCF function name. This parameter takes effect when `service_config_type` is `SCF`.
-* `service_config_scf_function_namespace` - (Optional) SCF function namespace. This parameter takes effect when  `service_config_type` is `SCF`.
+* `service_config_scf_function_namespace` - (Optional) SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`.
 * `service_config_scf_function_qualifier` - (Optional) SCF function version. This parameter takes effect when `service_config_type` is `SCF`.
-* `service_config_timeout` - (Optional) API backend service timeout period in seconds. Default is `5`.
+* `service_config_timeout` - (Optional) API backend service timeout period in seconds. Default value: `5`.
 * `service_config_type` - (Optional) API backend service type. Valid values: `WEBSOCKET`, `HTTP`, `SCF`, `MOCK`. Default value: `HTTP`.
 * `service_config_url` - (Optional) API backend service url. This parameter is required when `service_config_type` is `HTTP`.
 * `service_config_vpc_id` - (Optional) Unique VPC ID.
diff --git a/website/docs/r/api_gateway_custom_domain.html.markdown b/website/docs/r/api_gateway_custom_domain.html.markdown
@@ -34,15 +34,15 @@ The following arguments are supported:
 * `protocol` - (Required) Protocol supported by service. Valid values: `http`, `https`, `http&https`.
 * `service_id` - (Required, ForceNew) Unique service ID.
 * `sub_domain` - (Required) Custom domain name to be bound.
-* `certificate_id` - (Optional) Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if Protocol is `https` or `http&https`.
-* `is_default_mapping` - (Optional) Whether the default path mapping is used. The default value is true. If the value is false, the custom path mapping will be used and PathMappingSet will be required in this case.
-* `path_mappings` - (Optional) Custom domain name path mapping. Valid values: `test`, `prepub`, `release`. Respectively.eg: path#environment.
+* `certificate_id` - (Optional) Unique certificate ID of the custom domain name to be bound. You can choose to upload for the `protocol` attribute value `https` or `http&https`.
+* `is_default_mapping` - (Optional) Whether the default path mapping is used. The default value is `true`. When it is `false`, it means custom path mapping. In this case, the `path_mappings` attribute is required.
+* `path_mappings` - (Optional) Custom domain name path mapping. The data format is: `path#environment`. Optional values for the environment are `test`, `prepub`, and `release`.
 
 ## Attributes Reference
 
 In addition to all arguments above, the following attributes are exported:
 
 * `id` - ID of the resource.
-* `status` - Domain name resolution status. True: success; False: failure.
+* `status` - Domain name resolution status. `1` means normal analysis, `0` means parsing failed.
 
 
diff --git a/website/docs/r/api_gateway_service.html.markdown b/website/docs/r/api_gateway_service.html.markdown
@@ -34,7 +34,7 @@ The following arguments are supported:
 * `protocol` - (Required) Service frontend request type. Valid values: `http`, `https`, `http&https`.
 * `service_name` - (Required) Custom service name.
 * `exclusive_set_name` - (Optional, ForceNew) Self-deployed cluster name, which is used to specify the self-deployed cluster where the service is to be created.
-* `ip_version` - (Optional, ForceNew) IP version number. Valid values: `IPv4`, `IPv6`. Default value is `IPv4`.
+* `ip_version` - (Optional, ForceNew) IP version number. Valid values: `IPv4`, `IPv6`. Default value: `IPv4`.
 * `pre_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
 * `release_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
 * `service_desc` - (Optional) Custom service description.
diff --git a/website/docs/r/api_gateway_usage_plan_attachment.html.markdown b/website/docs/r/api_gateway_usage_plan_attachment.html.markdown
@@ -76,7 +76,7 @@ resource "tencentcloud_api_gateway_usage_plan_attachment" "attach_service" {
 
 The following arguments are supported:
 
-* `environment` - (Required, ForceNew) Environment to be bound `test`,`prepub` or `release`.
+* `environment` - (Required, ForceNew) The environment to be bound. Valid values: `test`, `prepub`, `release`.
 * `service_id` - (Required, ForceNew) ID of the service.
 * `usage_plan_id` - (Required, ForceNew) ID of the usage plan.
 * `api_id` - (Optional, ForceNew) ID of the API. This parameter will be required when `bind_type` is `API`.
