Skip to content

Commit 0ec27c8

Browse files
authored
Merge pull request #568 from ttomzhou/doc
optimize document
2 parents c7864d4 + c964513 commit 0ec27c8

8 files changed

+18
-18
lines changed

tencentcloud/resource_tc_api_gateway_api.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ func resourceTencentCloudAPIGatewayAPI() *schema.Resource {
116116
Optional: true,
117117
Default: "GET",
118118
ValidateFunc: validateAllowedStringValue([]string{"GET", "POST", "PUT", "DELETE", "HEAD", "ANY"}),
119-
Description: "Request frontend method configuration. Like `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.",
119+
Description: "Request frontend method configuration. Valid values: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.",
120120
},
121121
"request_parameters": {
122122
Type: schema.TypeSet,
@@ -169,7 +169,7 @@ func resourceTencentCloudAPIGatewayAPI() *schema.Resource {
169169
Type: schema.TypeInt,
170170
Optional: true,
171171
Default: 5,
172-
Description: "API backend service timeout period in seconds. Default is `5`.",
172+
Description: "API backend service timeout period in seconds. Default value: `5`.",
173173
},
174174
"service_config_product": {
175175
Type: schema.TypeString,
@@ -204,7 +204,7 @@ func resourceTencentCloudAPIGatewayAPI() *schema.Resource {
204204
"service_config_scf_function_namespace": {
205205
Type: schema.TypeString,
206206
Optional: true,
207-
Description: "SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`.",
207+
Description: "SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`.",
208208
},
209209
"service_config_scf_function_qualifier": {
210210
Type: schema.TypeString,

tencentcloud/resource_tc_api_gateway_custom_domain.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ func resourceTencentCloudAPIGatewayCustomDomain() *schema.Resource {
6262
Type: schema.TypeBool,
6363
Default: true,
6464
Optional: true,
65-
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.",
65+
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.",
6666
},
6767
"default_domain": {
6868
Type: schema.TypeString,
@@ -74,20 +74,20 @@ func resourceTencentCloudAPIGatewayCustomDomain() *schema.Resource {
7474
Type: schema.TypeString,
7575
Optional: true,
7676
Computed: true,
77-
Description: "Unique certificate ID of the custom domain name to be bound. The certificate can be uploaded if Protocol is `https` or `http&https`.",
77+
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`.",
7878
},
7979
"path_mappings": {
8080
Type: schema.TypeSet,
8181
Optional: true,
8282
Computed: true,
8383
Elem: &schema.Schema{Type: schema.TypeString},
84-
Description: "Custom domain name path mapping. Valid values: `test`, `prepub`, `release`. Respectively.eg: path#environment.",
84+
Description: "Custom domain name path mapping. The data format is: `path#environment`. Optional values for the environment are `test`, `prepub`, and `release`.",
8585
},
8686
//compute
8787
"status": {
8888
Type: schema.TypeInt,
8989
Computed: true,
90-
Description: "Domain name resolution status. True: success; False: failure.",
90+
Description: "Domain name resolution status. `1` means normal analysis, `0` means parsing failed.",
9191
},
9292
},
9393
}

tencentcloud/resource_tc_api_gateway_service.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ func resourceTencentCloudAPIGatewayService() *schema.Resource {
8787
ForceNew: true,
8888
Default: "IPv4",
8989
ValidateFunc: validateAllowedStringValue(API_GATEWAY_NET_IP_VERSIONS),
90-
Description: "IP version number. Valid values: `IPv4`, `IPv6`. Default value is `IPv4`.",
90+
Description: "IP version number. Valid values: `IPv4`, `IPv6`. Default value: `IPv4`.",
9191
},
9292
"release_limit": {
9393
Type: schema.TypeInt,

tencentcloud/resource_tc_api_gateway_usage_plan_attachment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ func resourceTencentCloudAPIGatewayUsagePlanAttachment() *schema.Resource {
109109
Required: true,
110110
ForceNew: true,
111111
ValidateFunc: validateAllowedStringValue(API_GATEWAY_SERVICE_ENVS),
112-
Description: "Environment to be bound `test`,`prepub` or `release`.",
112+
Description: "The environment to be bound. Valid values: `test`, `prepub`, `release`.",
113113
},
114114
"bind_type": {
115115
Type: schema.TypeString,

website/docs/r/api_gateway_api.html.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The following arguments are supported:
7171
* `pre_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
7272
* `protocol` - (Optional, ForceNew) API frontend request type. Valid values: `HTTP`, `WEBSOCKET`. Default value: `HTTP`.
7373
* `release_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
74-
* `request_config_method` - (Optional) Request frontend method configuration. Like `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.
74+
* `request_config_method` - (Optional) Request frontend method configuration. Valid values: `GET`,`POST`,`PUT`,`DELETE`,`HEAD`,`ANY`. Default value: `GET`.
7575
* `request_parameters` - (Optional) Frontend request parameters.
7676
* `response_error_codes` - (Optional) Custom error code configuration. Must keep at least one after set.
7777
* `response_fail_example` - (Optional) Response failure sample of custom response configuration.
@@ -82,9 +82,9 @@ The following arguments are supported:
8282
* `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.
8383
* `service_config_product` - (Optional) Backend type. This parameter takes effect when VPC is enabled. Currently, only `clb` is supported.
8484
* `service_config_scf_function_name` - (Optional) SCF function name. This parameter takes effect when `service_config_type` is `SCF`.
85-
* `service_config_scf_function_namespace` - (Optional) SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`.
85+
* `service_config_scf_function_namespace` - (Optional) SCF function namespace. This parameter takes effect when `service_config_type` is `SCF`.
8686
* `service_config_scf_function_qualifier` - (Optional) SCF function version. This parameter takes effect when `service_config_type` is `SCF`.
87-
* `service_config_timeout` - (Optional) API backend service timeout period in seconds. Default is `5`.
87+
* `service_config_timeout` - (Optional) API backend service timeout period in seconds. Default value: `5`.
8888
* `service_config_type` - (Optional) API backend service type. Valid values: `WEBSOCKET`, `HTTP`, `SCF`, `MOCK`. Default value: `HTTP`.
8989
* `service_config_url` - (Optional) API backend service url. This parameter is required when `service_config_type` is `HTTP`.
9090
* `service_config_vpc_id` - (Optional) Unique VPC ID.

website/docs/r/api_gateway_custom_domain.html.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ The following arguments are supported:
3434
* `protocol` - (Required) Protocol supported by service. Valid values: `http`, `https`, `http&https`.
3535
* `service_id` - (Required, ForceNew) Unique service ID.
3636
* `sub_domain` - (Required) Custom domain name to be bound.
37-
* `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`.
38-
* `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.
39-
* `path_mappings` - (Optional) Custom domain name path mapping. Valid values: `test`, `prepub`, `release`. Respectively.eg: path#environment.
37+
* `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`.
38+
* `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.
39+
* `path_mappings` - (Optional) Custom domain name path mapping. The data format is: `path#environment`. Optional values for the environment are `test`, `prepub`, and `release`.
4040

4141
## Attributes Reference
4242

4343
In addition to all arguments above, the following attributes are exported:
4444

4545
* `id` - ID of the resource.
46-
* `status` - Domain name resolution status. True: success; False: failure.
46+
* `status` - Domain name resolution status. `1` means normal analysis, `0` means parsing failed.
4747

4848

website/docs/r/api_gateway_service.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The following arguments are supported:
3434
* `protocol` - (Required) Service frontend request type. Valid values: `http`, `https`, `http&https`.
3535
* `service_name` - (Required) Custom service name.
3636
* `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.
37-
* `ip_version` - (Optional, ForceNew) IP version number. Valid values: `IPv4`, `IPv6`. Default value is `IPv4`.
37+
* `ip_version` - (Optional, ForceNew) IP version number. Valid values: `IPv4`, `IPv6`. Default value: `IPv4`.
3838
* `pre_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
3939
* `release_limit` - (Optional) API QPS value. Enter a positive number to limit the API query rate per second `QPS`.
4040
* `service_desc` - (Optional) Custom service description.

website/docs/r/api_gateway_usage_plan_attachment.html.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ resource "tencentcloud_api_gateway_usage_plan_attachment" "attach_service" {
7676

7777
The following arguments are supported:
7878

79-
* `environment` - (Required, ForceNew) Environment to be bound `test`,`prepub` or `release`.
79+
* `environment` - (Required, ForceNew) The environment to be bound. Valid values: `test`, `prepub`, `release`.
8080
* `service_id` - (Required, ForceNew) ID of the service.
8181
* `usage_plan_id` - (Required, ForceNew) ID of the usage plan.
8282
* `api_id` - (Optional, ForceNew) ID of the API. This parameter will be required when `bind_type` is `API`.

0 commit comments

Comments
 (0)