-
Notifications
You must be signed in to change notification settings - Fork 53
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
docs: fix docs of vpc_v1 #1021
Conversation
c335ffb
to
c02226a
Compare
c02226a
to
44abdb5
Compare
2391db9
to
29df528
Compare
5995b3d
to
c1468b3
Compare
c1468b3
to
15f94ff
Compare
36a8a3d
to
b09ea20
Compare
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/data-sources/networking_port.md
Outdated
* `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. | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. | ||
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/resources/vpcep_approval.md
Outdated
* `region` - The region in which to obtain the VPC endpoint service. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/resources/vpcep_endpoint.md
Outdated
@@ -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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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. - The argument
region
is usually in the first position.
There was a problem hiding this comment.
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
6536034
to
17dfb67
Compare
17dfb67
to
ee667ef
Compare
ee667ef
to
0ff230e
Compare
d107d5a
to
bf2a736
Compare
fd0cfde
to
a73b13d
Compare
/lgtm |
docs/resources/vpcep_service.md
Outdated
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. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
revised
a73b13d
to
2bcee45
Compare
docs/resources/vpc_route_v2.md
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `nexthop` (Required, String) - Specifies the next hop. | |
* `nexthop` (Required, String, ForceNew) - Specifies the next hop. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/resources/vpc_route_v2.md
Outdated
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**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, revised
docs/resources/vpc_route_v2.md
Outdated
|
||
* `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, revised
docs/resources/vpc_flow_log_v1.md
Outdated
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pls remove status
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
status should be kept
docs/resources/vpcep_endpoint.md
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/resources/vpcep_endpoint.md
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* `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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pls remove attribute description
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done
docs/data-sources/vpc_route_v2.md
Outdated
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, revised
docs/data-sources/vpc_subnet_v1.md
Outdated
@@ -57,6 +60,8 @@ the selected subnet. | |||
|
|||
* `dhcp_enable` - DHCP function for the subnet. | |||
|
|||
* `description` - The description of the subnet. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done, revised
707509d
to
1b83a02
Compare
1b83a02
to
f7a0a9b
Compare
/lgtm |
docs: fix docs of vpc_v1