Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix docs of vpc_v1 #1021

Merged

Conversation

Zhukun-Huawei
Copy link
Contributor

@Zhukun-Huawei Zhukun-Huawei commented Sep 22, 2023

docs: fix docs of vpc_v1

@Zhukun-Huawei Zhukun-Huawei changed the title 修复vpc_v1的文档, 添加timeouts docs: fix docs of vpc_v1, increase timeouts information Sep 22, 2023
@Zhukun-Huawei Zhukun-Huawei changed the title docs: fix docs of vpc_v1, increase timeouts information docs: fix docs of vpc_v1 Sep 22, 2023
@Zhukun-Huawei Zhukun-Huawei force-pushed the personalbranch branch 2 times, most recently from 2391db9 to 29df528 Compare September 25, 2023 12:28
@github-actions github-actions bot added size/S and removed size/XS labels Sep 25, 2023
@Zhukun-Huawei Zhukun-Huawei force-pushed the personalbranch branch 5 times, most recently from 5995b3d to c1468b3 Compare September 28, 2023 07:22
@github-actions github-actions bot added size/M and removed size/S labels Sep 28, 2023
@Zhukun-Huawei Zhukun-Huawei force-pushed the personalbranch branch 6 times, most recently from 36a8a3d to b09ea20 Compare October 7, 2023 09:18
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The attribute all_allowed_ips is missing.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, I have added the attribute all_allowed_ips

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this doc, the field type and ForceNew are missing, please complete them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment on lines 20 to 30
* `admin_state_up` - The administrative state of the port.

* `device_id` - The ID of the device the port belongs to.

* `device_owner` - The device owner of the port.

* `name` - The name of the port.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move them after the region field.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, I have moved region field to the first position

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move the attribute into Attributes Reference

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please move the attribute into Attributes Reference

image
done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The field types in this document are missing, please complete them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

* `region` - (Optional) The region in which to obtain the V1 VPC client. A VPC client is needed to retrieve VPCs.
If omitted, the region argument of the provider is used.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The argument region is usually in the first position.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment on lines 69 to 71
* `region` - The region in which to obtain the VPC endpoint service.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `region` - The region in which to obtain the VPC endpoint service.
* `region` - (Optional, String, ForceNew) The region in which to create the resource.
If omitted, the provider-level region will be used. Changing this creates a new resource.

Please move it to the first position in the parameter

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -104,14 +104,14 @@ The following arguments are supported:

* `tags` - (Optional) The key/value pairs to associate with the VPC endpoint.

* `region` - The region in which to create the VPC endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `region` - The region in which to create the VPC endpoint.
* `region` - (Optional, String, ForceNew) The region in which to create the resource.
If omitted, the provider-level region will be used. Changing this creates a new resource.

Please move it to the first position in the parameter

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this docs, the field type and ForceNew properties are missing, please fill them in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, the field type and ForceNew label are added

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this docs, the field type and ForceNew properties are missing, please fill them in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, the field type and ForceNew label are added

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. In this docs, the field type and ForceNew properties are missing, please fill them in.
  2. The argument region is usually in the first position.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, the field type and ForceNew label are added

@github-actions github-actions bot added the LGTM label Nov 24, 2023
@github-actions github-actions bot removed the LGTM label Nov 24, 2023
@Zhukun-Huawei Zhukun-Huawei force-pushed the personalbranch branch 2 times, most recently from fd0cfde to a73b13d Compare November 24, 2023 09:08
@chengxiangdong
Copy link
Contributor

/lgtm

@github-actions github-actions bot added the LGTM label Nov 24, 2023
This port is provided by the VPC endpoint, allowing you to access the VPC endpoint service.
The value ranges from 1 to 65535.

* `service_type` - (Required, String, ForceNew)The type of the VPC endpoint service. Only **interface** can be configured.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

service_type is optional in schema, please check it carefully.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

revised

Changing this creates a new Route.

* `vpc_id` (Required) - Specifies the VPC for which a route is to be added. Changing this creates a new Route.
* `nexthop` (Required, String) - Specifies the next hop.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `nexthop` (Required, String) - Specifies the next hop.
* `nexthop` (Required, String, ForceNew) - Specifies the next hop.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

If the route type is peering, enter the VPC peering connection ID.
Changing this creates a new Route.

* `type` (Required, String) - Specifies the route type. Currently, the value can only be **peering**.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `type` (Required, String) - Specifies the route type. Currently, the value can only be **peering**.
* `type` (Required, String, ForceNew) - Specifies the route type. Currently, the value can only be **peering**.

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, revised


* `tenant_id` (Optional) - Specifies the tenant ID. Only the administrator can specify the tenant ID of other tenant.
* `tenant_id` (Optional, String) - Specifies the tenant ID. Only the administrator can specify the tenant ID of other tenant.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `tenant_id` (Optional, String) - Specifies the tenant ID. Only the administrator can specify the tenant ID of other tenant.
* `tenant_id` (Optional, String, ForceNew) - Specifies the tenant ID. Only the administrator can specify the tenant ID of other tenant.

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, revised

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

traffic_type does not support updates, please add ForceNew

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls remove status

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image has already added

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

status should be kept

Changing this creates a new VPC endpoint.

* `enable_whitelist` (Optional) - Specifies whether to enable access control. The default value is false.
* `enable_whitelist` (Optional, Bool) - Specifies whether to enable access control. The default value is false.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `enable_whitelist` (Optional, Bool) - Specifies whether to enable access control. The default value is false.
* `enable_whitelist` (Optional, Bool, ForceNew) - Specifies whether to enable access control. The default value is false.

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Changing this creates a new VPC endpoint.

* `whitelist` (Optional) - Specifies the list of IP address or CIDR block which can be accessed to the VPC endpoint.
* `whitelist` (Optional, List) - Specifies the list of IP address or CIDR block which can be accessed to the VPC endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `whitelist` (Optional, List) - Specifies the list of IP address or CIDR block which can be accessed to the VPC endpoint.
* `whitelist` (Optional, List, ForceNew) - Specifies the list of IP address or CIDR block which can be accessed to the VPC endpoint.

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls remove attribute description

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls move nexthop to argument.

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, revised

@@ -57,6 +60,8 @@ the selected subnet.

* `dhcp_enable` - DHCP function for the subnet.

* `description` - The description of the subnet.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pls move description to argument

Copy link
Contributor Author

@Zhukun-Huawei Zhukun-Huawei Nov 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done, revised

@Zhukun-Huawei Zhukun-Huawei force-pushed the personalbranch branch 7 times, most recently from 707509d to 1b83a02 Compare November 28, 2023 10:31
@chengxiangdong
Copy link
Contributor

/lgtm
/approve

@github-actions github-actions bot added the LGTM label Nov 28, 2023
@github-actions github-actions bot removed the LGTM label Dec 1, 2023
@ShiChangkuo ShiChangkuo merged commit 1173ff8 into FlexibleEngineCloud:master Dec 1, 2023
5 checks passed
Zippo-Wang pushed a commit to Zippo-Wang/terraform-provider-flexibleengine that referenced this pull request Dec 25, 2023
@Zhukun-Huawei Zhukun-Huawei deleted the personalbranch branch December 26, 2023 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants